NiFi Rest API-1.28.0

Status Code	Type	Description
200	AccessStatusEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Unable to determine access status because the client could not be authenticated.
403	string	Unable to determine access status because the client is not authorized to make this request.
409	string	Unable to determine access status because NiFi is not in the appropriate state.
500	string	Unable to determine access status because an unexpected error occurred.

Status Code	Type	Description
200	AccessConfigurationEntity	successful operation

Status Code	Type	Description
200		successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	NiFi was unable to complete the request because it did not contain a valid Kerberos ticket in the Authorization header. Retry this request after initializing a ticket with kinit and ensuring your browser is configured to support SPNEGO.
409	string	Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support Kerberos login.
500	string	Unable to create access token because an unexpected error occurred.

Status Code	Type	Description
default	string	successful operation

Status Code	Type	Description
default	string	successful operation

Status Code	Type	Description
default	string	successful operation

Status Code	Type	Description
200	string	User was logged out successfully.
401	string	Authentication token provided was empty or not in the correct JWT format.
500	string	Client failed to log out.

Status Code	Type	Description
200	string	User was logged out successfully.
401	string	Authentication token provided was empty or not in the correct JWT format.
500	string	Client failed to log out.

Name	Location	Type	Description
username	formData	string
password	formData	string

Status Code	Type	Description
200		successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
403	string	Client is not authorized to make this request.
409	string	Unable to create access token because NiFi is not in the appropriate state. (i.e. may not be configured to support username/password login.
500	string	Unable to create access token because an unexpected error occurred.

Status Code	Type	Description
200	AccessTokenExpirationEntity	Access Token Expiration found
401	string	Access Token not authorized
409	string	Access Token not resolved

Name	Location	Type	Description
id	path	string	The connection id.

Status Code	Type	Description
200	ConnectionEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Name	Location	Type	Description
id	path	string	The connection id.
	body	ConnectionEntity	The connection configuration details.

Status Code	Type	Description
200	ConnectionEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Name	Location	Type	Description
version	query	string	The revision is used to verify the client is working with the latest version of the flow.
clientId	query	string	If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
disconnectedNodeAcknowledged	query	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
id	path	string	The connection id.

Status Code	Type	Description
200	ConnectionEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Name	Location	Type	Description
id	path	string	The controller service id.
uiOnly	query	boolean

Status Code	Type	Description
200	ControllerServiceEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Name	Location	Type	Description
id	path	string	The controller service id.
	body	ControllerServiceEntity	The controller service configuration details.

Status Code	Type	Description
200	ControllerServiceEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Name	Location	Type	Description
version	query	string	The revision is used to verify the client is working with the latest version of the flow.
clientId	query	string	If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
disconnectedNodeAcknowledged	query	boolean	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
id	path	string	The controller service id.

Status Code	Type	Description
200	ControllerServiceEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Name	Location	Type	Description
id	path	string	The controller service id.
	body	ConfigurationAnalysisEntity	The configuration analysis request.

Status Code	Type	Description
200	ConfigurationAnalysisEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Name	Location	Type	Description
id	path	string	The controller service id.
	body	VerifyConfigRequestEntity	The controller service configuration verification request.

Status Code	Type	Description
200	VerifyConfigRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Name	Location	Type	Description
id	path	string	The ID of the Controller Service
requestId	path	string	The ID of the Verification Request

Status Code	Type	Description
200	VerifyConfigRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Name	Location	Type	Description
id	path	string	The ID of the Controller Service
requestId	path	string	The ID of the Verification Request

Status Code	Type	Description
200	VerifyConfigRequestEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Name	Location	Type	Description
id	path	string	The controller service id.
propertyName	query	string	The property name to return the descriptor for.
sensitive	query	boolean	Property Descriptor requested sensitive status

Status Code	Type	Description
200	PropertyDescriptorEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Name	Location	Type	Description
id	path	string	The controller service id.

Status Code	Type	Description
200	ControllerServiceReferencingComponentsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Name	Location	Type	Description
id	path	string	The controller service id.
	body	UpdateControllerServiceReferenceRequestEntity	The controller service request update request.

Status Code	Type	Description
200	ControllerServiceReferencingComponentsEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Name	Location	Type	Description
id	path	string	The controller service id.
	body	ControllerServiceRunStatusEntity	The controller service run status.

Status Code	Type	Description
200	ControllerServiceEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Name	Location	Type	Description
id	path	string	The controller service id.

Status Code	Type	Description
200	ComponentStateEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Name	Location	Type	Description
id	path	string	The controller service id.

Status Code	Type	Description
200	ComponentStateEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Name	Location	Type	Description
	body	BulletinEntity	The reporting task configuration details.

Status Code	Type	Description
200	BulletinEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Status Code	Type	Description
200	ClusterEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Name	Location	Type	Description
id	path	string	The node id.

Status Code	Type	Description
200	NodeEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

Name	Location	Type	Description
id	path	string	The node id.
	body	NodeEntity	The node configuration. The only configuration that will be honored at this endpoint is the status.

Status Code	Type	Description
200	NodeEntity	successful operation
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.

AboutDTO

Name	Type	Required	Description
title	string	optional	The title to be used on the page and in the about dialog.
version	string	optional	The version of this NiFi.
uri	string	optional	The URI for the NiFi.
contentViewerUrl	string	optional	The URL for the content viewer if configured.
timezone	string	optional	The timezone of the NiFi instance. This property is read only.
buildTag	string	optional	Build tag
buildRevision	string	optional	Build revision or commit hash
buildBranch	string	optional	Build branch
buildTimestamp	string	optional	Build timestamp

Example JSON

{
    "title": "value",
    "version": "value",
    "uri": "value",
    "contentViewerUrl": "value",
    "timezone": "value",
    "buildTag": "value",
    "buildRevision": "value",
    "buildBranch": "value",
    "buildTimestamp": "value",
}

Close

AboutEntity

Name	Type	Required	Description
about	AboutDTO	optional

Example JSON

{
    "about": AboutDTO{…},
}

Close

AccessConfigurationDTO

Name	Type	Required	Description
supportsLogin	boolean	optional	Indicates whether or not this NiFi supports user login. This property is read only.

Example JSON

{
    "supportsLogin": true,
}

Close

AccessConfigurationEntity

Name	Type	Required	Description
config	AccessConfigurationDTO	optional

Example JSON

{
    "config": AccessConfigurationDTO{…},
}

Close

AccessPolicyDTO

Name	Type	Required	Description
id	string	optional	The id of the component.
versionedComponentId	string	optional	The ID of the corresponding component that is under version control
parentGroupId	string	optional	The id of parent process group of this component if applicable.
position	PositionDTO	optional	The position of this component in the UI if applicable.
resource	string	optional	The resource for this access policy.
action	string	optional	The action associated with this access policy. Allowable values: read, write
componentReference	ComponentReferenceEntity	optional	Component this policy references if applicable.
configurable	boolean	optional	Whether this policy is configurable.
users	array[TenantEntity]	optional	The set of user IDs associated with this access policy.
userGroups	array[TenantEntity]	optional	The set of user group IDs associated with this access policy.

Example JSON

{
    "id": "value",
    "versionedComponentId": "value",
    "parentGroupId": "value",
    "position": PositionDTO{…},
    "resource": "value",
    "action": "value",
    "componentReference": ComponentReferenceEntity{…},
    "configurable": true,
    "users": [TenantEntity{…}],
    "userGroups": [TenantEntity{…}],
}

Close

AccessPolicyEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
generated	string	optional	When this content was generated.
component	AccessPolicyDTO	optional

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "generated": "value",
    "component": AccessPolicyDTO{…},
}

Close

AccessPolicySummaryDTO

Name	Type	Required	Description
id	string	optional	The id of the component.
versionedComponentId	string	optional	The ID of the corresponding component that is under version control
parentGroupId	string	optional	The id of parent process group of this component if applicable.
position	PositionDTO	optional	The position of this component in the UI if applicable.
resource	string	optional	The resource for this access policy.
action	string	optional	The action associated with this access policy. Allowable values: read, write
componentReference	ComponentReferenceEntity	optional	Component this policy references if applicable.
configurable	boolean	optional	Whether this policy is configurable.

Example JSON

{
    "id": "value",
    "versionedComponentId": "value",
    "parentGroupId": "value",
    "position": PositionDTO{…},
    "resource": "value",
    "action": "value",
    "componentReference": ComponentReferenceEntity{…},
    "configurable": true,
}

Close

AccessPolicySummaryEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
component	AccessPolicySummaryDTO	optional

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "component": AccessPolicySummaryDTO{…},
}

Close

AccessStatusDTO

Name	Type	Required	Description
identity	string	optional	The user identity. This property is read only.
status	string	optional	The user access status. This property is read only.
message	string	optional	Additional details about the user access status. This property is read only.

Example JSON

{
    "identity": "value",
    "status": "value",
    "message": "value",
}

Close

AccessStatusEntity

Name	Type	Required	Description
accessStatus	AccessStatusDTO	optional

Example JSON

{
    "accessStatus": AccessStatusDTO{…},
}

Close

AccessTokenExpirationDTO

Name	Type	Required	Description
expiration	string	optional	Token Expiration This property is read only.

Example JSON

{
    "expiration": "value",
}

Close

AccessTokenExpirationEntity

Name	Type	Required	Description
accessTokenExpiration	AccessTokenExpirationDTO	optional

Example JSON

{
    "accessTokenExpiration": AccessTokenExpirationDTO{…},
}

Close

ActionDTO

Name	Type	Required	Description
id	integer (int32)	optional	The action id.
userIdentity	string	optional	The identity of the user that performed the action.
timestamp	string	optional	The timestamp of the action.
sourceId	string	optional	The id of the source component.
sourceName	string	optional	The name of the source component.
sourceType	string	optional	The type of the source component.
componentDetails	ComponentDetailsDTO	optional	The details of the source component.
operation	string	optional	The operation that was performed.
actionDetails	ActionDetailsDTO	optional	The details of the action.

Example JSON

{
    "id": 0,
    "userIdentity": "value",
    "timestamp": "value",
    "sourceId": "value",
    "sourceName": "value",
    "sourceType": "value",
    "componentDetails": ComponentDetailsDTO{…},
    "operation": "value",
    "actionDetails": ActionDetailsDTO{…},
}

Close

ActionDetailsDTO

Name	Type	Required	Description

Example JSON

{
}

Close

ActionEntity

Name	Type	Required	Description
id	integer (int32)	optional
timestamp	string	optional	The timestamp of the action.
sourceId	string	optional
canRead	boolean	optional	Indicates whether the user can read a given resource. This property is read only.
action	ActionDTO	optional

Example JSON

{
    "id": 0,
    "timestamp": "value",
    "sourceId": "value",
    "canRead": true,
    "action": ActionDTO{…},
}

Close

ActivateControllerServicesEntity

Name	Type	Required	Description
id	string	optional	The id of the ProcessGroup
state	string	optional	The desired state of the descendant components Allowable values: ENABLED, DISABLED
components	object	optional	Optional services to schedule. If not specified, all authorized descendant controller services will be used.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Example JSON

{
    "id": "value",
    "state": "value",
    "components": {
        "name": RevisionDTO{…}
    },
    "disconnectedNodeAcknowledged": true,
}

Close

AffectedComponentDTO

Name	Type	Required	Description
processGroupId	string	optional	The UUID of the Process Group that this component is in
id	string	optional	The UUID of this component
referenceType	string	optional	The type of this component Allowable values: PROCESSOR, CONTROLLER_SERVICE, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT
name	string	optional	The name of this component.
state	string	optional	The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state.
activeThreadCount	integer (int32)	optional	The number of active threads for the referencing component.
validationErrors	array[string]	optional	The validation errors for the component.

Example JSON

{
    "processGroupId": "value",
    "id": "value",
    "referenceType": "value",
    "name": "value",
    "state": "value",
    "activeThreadCount": 0,
    "validationErrors": ["value"],
}

Close

AffectedComponentEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
component	AffectedComponentDTO	optional
processGroup	ProcessGroupNameDTO	optional	The Process Group that the component belongs to
referenceType	string	optional	The type of component referenced Allowable values: PROCESSOR, CONTROLLER_SERVICE, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "component": AffectedComponentDTO{…},
    "processGroup": ProcessGroupNameDTO{…},
    "referenceType": "value",
}

Close

AllowableValueDTO

Name	Type	Required	Description
displayName	string	optional	A human readable value that is allowed for the property descriptor.
value	string	optional	A value that is allowed for the property descriptor.
description	string	optional	A description for this allowable value.

Example JSON

{
    "displayName": "value",
    "value": "value",
    "description": "value",
}

Close

AllowableValueEntity

Name	Type	Required	Description
allowableValue	AllowableValueDTO	optional
canRead	boolean	optional	Indicates whether the user can read a given resource. This property is read only.

Example JSON

{
    "allowableValue": AllowableValueDTO{…},
    "canRead": true,
}

Close

Attribute

Name	Type	Required	Description
name	string	optional	The name of the attribute
description	string	optional	The description of the attribute

Example JSON

{
    "name": "value",
    "description": "value",
}

Close

AttributeDTO

Name	Type	Required	Description
name	string	optional	The attribute name.
value	string	optional	The attribute value.
previousValue	string	optional	The value of the attribute before the event took place.

Example JSON

{
    "name": "value",
    "value": "value",
    "previousValue": "value",
}

Close

BannerDTO

Name	Type	Required	Description
headerText	string	optional	The header text.
footerText	string	optional	The footer text.

Example JSON

{
    "headerText": "value",
    "footerText": "value",
}

Close

BannerEntity

Name	Type	Required	Description
banners	BannerDTO	optional

Example JSON

{
    "banners": BannerDTO{…},
}

Close

BatchSettingsDTO

Name	Type	Required	Description
count	integer (int32)	optional	Preferred number of flow files to include in a transaction.
size	string	optional	Preferred number of bytes to include in a transaction.
duration	string	optional	Preferred amount of time that a transaction should span.

Example JSON

{
    "count": 0,
    "size": "value",
    "duration": "value",
}

Close

BatchSize

Name	Type	Required	Description
count	integer (int32)	optional	Preferred number of flow files to include in a transaction.
size	string	optional	Preferred number of bytes to include in a transaction.
duration	string	optional	Preferred amount of time that a transaction should span.

Example JSON

{
    "count": 0,
    "size": "value",
    "duration": "value",
}

Close

BuildInfo

Name	Type	Required	Description
version	string	optional	The version number of the built component.
revision	string	optional	The SCM revision id of the source code used for this build.
timestamp	integer (int64)	optional	The timestamp (milliseconds since Epoch) of the build.
targetArch	string	optional	The target architecture of the built component.
compiler	string	optional	The compiler used for the build
compilerFlags	string	optional	The compiler flags used for the build.

Example JSON

{
    "version": "value",
    "revision": "value",
    "timestamp": 0,
    "targetArch": "value",
    "compiler": "value",
    "compilerFlags": "value",
}

Close

BulletinBoardDTO

Name	Type	Required	Description
bulletins	array[BulletinEntity]	optional	The bulletins in the bulletin board, that matches the supplied request.
generated	string	optional	The timestamp when this report was generated.

Example JSON

{
    "bulletins": [BulletinEntity{…}],
    "generated": "value",
}

Close

BulletinBoardEntity

Name	Type	Required	Description
bulletinBoard	BulletinBoardDTO	optional

Example JSON

{
    "bulletinBoard": BulletinBoardDTO{…},
}

Close

BulletinDTO

Name	Type	Required	Description
id	integer (int64)	optional	The id of the bulletin.
nodeAddress	string	optional	If clustered, the address of the node from which the bulletin originated.
category	string	optional	The category of this bulletin.
groupId	string	optional	The group id of the source component.
sourceId	string	optional	The id of the source component.
sourceName	string	optional	The name of the source component.
level	string	optional	The level of the bulletin.
message	string	optional	The bulletin message.
timestamp	string	optional	When this bulletin was generated.

Example JSON

{
    "id": 0,
    "nodeAddress": "value",
    "category": "value",
    "groupId": "value",
    "sourceId": "value",
    "sourceName": "value",
    "level": "value",
    "message": "value",
    "timestamp": "value",
}

Close

BulletinEntity

Name	Type	Required	Description
id	integer (int64)	optional
groupId	string	optional
sourceId	string	optional
timestamp	string	optional	When this bulletin was generated.
nodeAddress	string	optional
canRead	boolean	optional	Indicates whether the user can read a given resource. This property is read only.
bulletin	BulletinDTO	optional

Example JSON

{
    "id": 0,
    "groupId": "value",
    "sourceId": "value",
    "timestamp": "value",
    "nodeAddress": "value",
    "canRead": true,
    "bulletin": BulletinDTO{…},
}

Close

Bundle

Name	Type	Required	Description
group	string	optional	The group of the bundle
artifact	string	optional	The artifact of the bundle
version	string	optional	The version of the bundle

Example JSON

{
    "group": "value",
    "artifact": "value",
    "version": "value",
}

Close

BundleDTO

Name	Type	Required	Description
group	string	optional	The group of the bundle.
artifact	string	optional	The artifact of the bundle.
version	string	optional	The version of the bundle.

Example JSON

{
    "group": "value",
    "artifact": "value",
    "version": "value",
}

Close

ClassLoaderDiagnosticsDTO

Name	Type	Required	Description
bundle	BundleDTO	optional	Information about the Bundle that the ClassLoader belongs to, if any
parentClassLoader	ClassLoaderDiagnosticsDTO	optional	A ClassLoaderDiagnosticsDTO that provides information about the parent ClassLoader

Example JSON

{
    "bundle": BundleDTO{…},
    "parentClassLoader": ClassLoaderDiagnosticsDTO{…},
}

Close

ClusteSummaryEntity

Name	Type	Required	Description
clusterSummary	ClusterSummaryDTO	optional

Example JSON

{
    "clusterSummary": ClusterSummaryDTO{…},
}

Close

ClusterDTO

Name	Type	Required	Description
nodes	array[NodeDTO]	optional	The collection of nodes that are part of the cluster.
generated	string	optional	The timestamp the report was generated.

Example JSON

{
    "nodes": [NodeDTO{…}],
    "generated": "value",
}

Close

ClusterEntity

Name	Type	Required	Description
cluster	ClusterDTO	optional

Example JSON

{
    "cluster": ClusterDTO{…},
}

Close

ClusterSearchResultsEntity

Name	Type	Required	Description
nodeResults	array[NodeSearchResultDTO]	optional

Example JSON

{
    "nodeResults": [NodeSearchResultDTO{…}],
}

Close

ClusterSummaryDTO

Name	Type	Required	Description
connectedNodes	string	optional	When clustered, reports the number of nodes connected vs the number of nodes in the cluster.
connectedNodeCount	integer (int32)	optional	The number of nodes that are currently connected to the cluster
totalNodeCount	integer (int32)	optional	The number of nodes in the cluster, regardless of whether or not they are connected
clustered	boolean	optional	Whether this NiFi instance is clustered.
connectedToCluster	boolean	optional	Whether this NiFi instance is connected to a cluster.

Example JSON

{
    "connectedNodes": "value",
    "connectedNodeCount": 0,
    "totalNodeCount": 0,
    "clustered": true,
    "connectedToCluster": true,
}

Close

ComponentDetailsDTO

Name	Type	Required	Description

Example JSON

{
}

Close

ComponentDifferenceDTO

Name	Type	Required	Description
componentType	string	optional	The type of component
componentId	string	optional	The ID of the component
componentName	string	optional	The name of the component
processGroupId	string	optional	The ID of the Process Group that the component belongs to
differences	array[DifferenceDTO]	optional	The differences in the component between the two flows

Example JSON

{
    "componentType": "value",
    "componentId": "value",
    "componentName": "value",
    "processGroupId": "value",
    "differences": [DifferenceDTO{…}],
}

Close

ComponentHistoryDTO

Name	Type	Required	Description
componentId	string	optional	The component id.
propertyHistory	object	optional	The history for the properties of the component.

Example JSON

{
    "componentId": "value",
    "propertyHistory": {
        "name": PropertyHistoryDTO{…}
    },
}

Close

ComponentHistoryEntity

Name	Type	Required	Description
componentHistory	ComponentHistoryDTO	optional

Example JSON

{
    "componentHistory": ComponentHistoryDTO{…},
}

Close

ComponentLifecycle

Name	Type	Required	Description

Example JSON

{
}

Close

ComponentManifest

Name	Type	Required	Description
apis	array[DefinedType]	optional	Public interfaces defined in this bundle
controllerServices	array[ControllerServiceDefinition]	optional	Controller Services provided in this bundle
processors	array[ProcessorDefinition]	optional	Processors provided in this bundle
reportingTasks	array[ReportingTaskDefinition]	optional	Reporting Tasks provided in this bundle

Example JSON

{
    "apis": [DefinedType{…}],
    "controllerServices": [ControllerServiceDefinition{…}],
    "processors": [ProcessorDefinition{…}],
    "reportingTasks": [ReportingTaskDefinition{…}],
}

Close

ComponentReferenceDTO

Name	Type	Required	Description
id	string	optional	The id of the component.
versionedComponentId	string	optional	The ID of the corresponding component that is under version control
parentGroupId	string	optional	The id of parent process group of this component if applicable.
position	PositionDTO	optional	The position of this component in the UI if applicable.
name	string	optional	The name of the component.

Example JSON

{
    "id": "value",
    "versionedComponentId": "value",
    "parentGroupId": "value",
    "position": PositionDTO{…},
    "name": "value",
}

Close

ComponentReferenceEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
parentGroupId	string	optional	The id of parent process group of this component if applicable.
component	ComponentReferenceDTO	optional

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "parentGroupId": "value",
    "component": ComponentReferenceDTO{…},
}

Close

ComponentRestrictionPermissionDTO

Name	Type	Required	Description
requiredPermission	RequiredPermissionDTO	optional	The required permission necessary for this restriction.
permissions	PermissionsDTO	optional	The permissions for this component restriction. Note: the read permission are not used and will always be false.

Example JSON

{
    "requiredPermission": RequiredPermissionDTO{…},
    "permissions": PermissionsDTO{…},
}

Close

ComponentSearchResultDTO

Name	Type	Required	Description
id	string	optional	The id of the component that matched the search.
groupId	string	optional	The group id of the component that matched the search.
parentGroup	SearchResultGroupDTO	optional	The parent group of the component that matched the search.
versionedGroup	SearchResultGroupDTO	optional	The nearest versioned ancestor group of the component that matched the search.
name	string	optional	The name of the component that matched the search.
matches	array[string]	optional	What matched the search from the component.

Example JSON

{
    "id": "value",
    "groupId": "value",
    "parentGroup": SearchResultGroupDTO{…},
    "versionedGroup": SearchResultGroupDTO{…},
    "name": "value",
    "matches": ["value"],
}

Close

ComponentStateDTO

Name	Type	Required	Description
componentId	string	optional	The component identifier.
stateDescription	string	optional	Description of the state this component persists.
clusterState	StateMapDTO	optional	The cluster state for this component, or null if this NiFi is a standalone instance.
localState	StateMapDTO	optional	The local state for this component.

Example JSON

{
    "componentId": "value",
    "stateDescription": "value",
    "clusterState": StateMapDTO{…},
    "localState": StateMapDTO{…},
}

Close

ComponentStateEntity

Name	Type	Required	Description
componentState	ComponentStateDTO	optional	The component state.

Example JSON

{
    "componentState": ComponentStateDTO{…},
}

Close

ComponentValidationResultDTO

Name	Type	Required	Description
processGroupId	string	optional	The UUID of the Process Group that this component is in
id	string	optional	The UUID of this component
referenceType	string	optional	The type of this component Allowable values: PROCESSOR, CONTROLLER_SERVICE, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT
name	string	optional	The name of this component.
state	string	optional	The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state.
activeThreadCount	integer (int32)	optional	The number of active threads for the referencing component.
validationErrors	array[string]	optional	The validation errors for the component.
currentlyValid	boolean	optional	Whether or not the component is currently valid
resultsValid	boolean	optional	Whether or not the component will be valid if the Parameter Context is changed
resultantValidationErrors	array[string]	optional	The validation errors that will apply to the component if the Parameter Context is changed

Example JSON

{
    "processGroupId": "value",
    "id": "value",
    "referenceType": "value",
    "name": "value",
    "state": "value",
    "activeThreadCount": 0,
    "validationErrors": ["value"],
    "currentlyValid": true,
    "resultsValid": true,
    "resultantValidationErrors": ["value"],
}

Close

ComponentValidationResultEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
component	ComponentValidationResultDTO	optional

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "component": ComponentValidationResultDTO{…},
}

Close

ComponentValidationResultsEntity

Name	Type	Required	Description
validationResults	array[ComponentValidationResultEntity]	optional	A List of ComponentValidationResultEntity, one for each component that is validated

Example JSON

{
    "validationResults": [ComponentValidationResultEntity{…}],
}

Close

ConfigVerificationResultDTO

Name	Type	Required	Description
outcome	string	optional	The outcome of the verification Allowable values: SUCCESSFUL, FAILED, SKIPPED
verificationStepName	string	optional	The name of the verification step
explanation	string	optional	An explanation of why the step was or was not successful

Example JSON

{
    "outcome": "value",
    "verificationStepName": "value",
    "explanation": "value",
}

Close

ConfigurationAnalysisDTO

Name	Type	Required	Description
componentId	string	optional	The ID of the component
properties	object	optional	The configured properties for the component
referencedAttributes	object	optional	The attributes that are referenced by the properties, mapped to recently used values
supportsVerification	boolean	optional	Whether or not the component supports verification

Example JSON

{
    "componentId": "value",
    "properties": {
        "name": "value"
    },
    "referencedAttributes": {
        "name": "value"
    },
    "supportsVerification": true,
}

Close

ConfigurationAnalysisEntity

Name	Type	Required	Description
configurationAnalysis	ConfigurationAnalysisDTO	optional	The configuration analysis

Example JSON

{
    "configurationAnalysis": ConfigurationAnalysisDTO{…},
}

Close

ConnectableComponent

Name	Type	Required	Description
id	string	required	The id of the connectable component.
type	string	required	The type of component the connectable is. Allowable values: PROCESSOR, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, INPUT_PORT, OUTPUT_PORT, FUNNEL
groupId	string	required	The id of the group that the connectable component resides in
name	string	optional	The name of the connectable component
comments	string	optional	The comments for the connectable component.
instanceIdentifier	string	optional	The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component

Example JSON

{
    "id": "value",
    "type": "value",
    "groupId": "value",
    "name": "value",
    "comments": "value",
    "instanceIdentifier": "value",
}

Close

ConnectableDTO

Name	Type	Required	Description
id	string	required	The id of the connectable component.
versionedComponentId	string	optional	The ID of the corresponding component that is under version control
type	string	required	The type of component the connectable is. Allowable values: PROCESSOR, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, INPUT_PORT, OUTPUT_PORT, FUNNEL
groupId	string	required	The id of the group that the connectable component resides in
name	string	optional	The name of the connectable component
running	boolean	optional	Reflects the current state of the connectable component.
transmitting	boolean	optional	If the connectable component represents a remote port, indicates if the target is configured to transmit.
exists	boolean	optional	If the connectable component represents a remote port, indicates if the target exists.
comments	string	optional	The comments for the connectable component.

Example JSON

{
    "id": "value",
    "versionedComponentId": "value",
    "type": "value",
    "groupId": "value",
    "name": "value",
    "running": true,
    "transmitting": true,
    "exists": true,
    "comments": "value",
}

Close

ConnectionDTO

Name	Type	Required	Description
id	string	optional	The id of the component.
versionedComponentId	string	optional	The ID of the corresponding component that is under version control
parentGroupId	string	optional	The id of parent process group of this component if applicable.
position	PositionDTO	optional	The position of this component in the UI if applicable.
source	ConnectableDTO	optional	The source of the connection.
destination	ConnectableDTO	optional	The destination of the connection.
name	string	optional	The name of the connection.
labelIndex	integer (int32)	optional	The index of the bend point where to place the connection label.
getzIndex	integer (int64)	optional	The z index of the connection.
selectedRelationships	array[string]	optional	The selected relationship that comprise the connection.
availableRelationships	array[string]	optional	The relationships that the source of the connection currently supports. This property is read only.
backPressureObjectThreshold	integer (int64)	optional	The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue.
backPressureDataSizeThreshold	string	optional	The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue.
flowFileExpiration	string	optional	The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it.
prioritizers	array[string]	optional	The comparators used to prioritize the queue.
bends	array[PositionDTO]	optional	The bend points on the connection.
loadBalanceStrategy	string	optional	How to load balance the data in this Connection across the nodes in the cluster. Allowable values: DO_NOT_LOAD_BALANCE, PARTITION_BY_ATTRIBUTE, ROUND_ROBIN, SINGLE_NODE
loadBalancePartitionAttribute	string	optional	The FlowFile Attribute to use for determining which node a FlowFile will go to if the Load Balancing Strategy is set to PARTITION_BY_ATTRIBUTE
loadBalanceCompression	string	optional	Whether or not data should be compressed when being transferred between nodes in the cluster. Allowable values: DO_NOT_COMPRESS, COMPRESS_ATTRIBUTES_ONLY, COMPRESS_ATTRIBUTES_AND_CONTENT
loadBalanceStatus	string	optional	The current status of the Connection's Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node. Allowable values: LOAD_BALANCE_NOT_CONFIGURED, LOAD_BALANCE_INACTIVE, LOAD_BALANCE_ACTIVE This property is read only.

Example JSON

{
    "id": "value",
    "versionedComponentId": "value",
    "parentGroupId": "value",
    "position": PositionDTO{…},
    "source": ConnectableDTO{…},
    "destination": ConnectableDTO{…},
    "name": "value",
    "labelIndex": 0,
    "getzIndex": 0,
    "selectedRelationships": ["value"],
    "availableRelationships": ["value"],
    "backPressureObjectThreshold": 0,
    "backPressureDataSizeThreshold": "value",
    "flowFileExpiration": "value",
    "prioritizers": ["value"],
    "bends": [PositionDTO{…}],
    "loadBalanceStrategy": "value",
    "loadBalancePartitionAttribute": "value",
    "loadBalanceCompression": "value",
    "loadBalanceStatus": "value",
}

Close

ConnectionDiagnosticsDTO

Name	Type	Required	Description
connection	ConnectionDTO	optional	Details about the connection This property is read only.
aggregateSnapshot	ConnectionDiagnosticsSnapshotDTO	optional	Aggregate values for all nodes in the cluster, or for this instance if not clustered This property is read only.
nodeSnapshots	array[ConnectionDiagnosticsSnapshotDTO]	optional	A list of values for each node in the cluster, if clustered. This property is read only.

Example JSON

{
    "connection": ConnectionDTO{…},
    "aggregateSnapshot": ConnectionDiagnosticsSnapshotDTO{…},
    "nodeSnapshots": [ConnectionDiagnosticsSnapshotDTO{…}],
}

Close

ConnectionDiagnosticsSnapshotDTO

Name	Type	Required	Description
totalFlowFileCount	integer (int32)	optional	Total number of FlowFiles owned by the Connection
totalByteCount	integer (int64)	optional	Total number of bytes that make up the content for the FlowFiles owned by this Connection
nodeIdentifier	string	optional	The Node Identifier that this information pertains to
localQueuePartition	LocalQueuePartitionDTO	optional	The local queue partition, from which components can pull FlowFiles on this node.
remoteQueuePartitions	array[RemoteQueuePartitionDTO]	optional

Example JSON

{
    "totalFlowFileCount": 0,
    "totalByteCount": 0,
    "nodeIdentifier": "value",
    "localQueuePartition": LocalQueuePartitionDTO{…},
    "remoteQueuePartitions": [RemoteQueuePartitionDTO{…}],
}

Close

ConnectionEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
component	ConnectionDTO	optional
status	ConnectionStatusDTO	optional	The status of the connection.
bends	array[PositionDTO]	optional	The bend points on the connection.
labelIndex	integer (int32)	optional	The index of the bend point where to place the connection label.
getzIndex	integer (int64)	optional	The z index of the connection.
sourceId	string	optional	The identifier of the source of this connection.
sourceGroupId	string	optional	The identifier of the group of the source of this connection.
sourceType	string	required	The type of component the source connectable is. Allowable values: PROCESSOR, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, INPUT_PORT, OUTPUT_PORT, FUNNEL
destinationId	string	optional	The identifier of the destination of this connection.
destinationGroupId	string	optional	The identifier of the group of the destination of this connection.
destinationType	string	required	The type of component the destination connectable is. Allowable values: PROCESSOR, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, INPUT_PORT, OUTPUT_PORT, FUNNEL

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "component": ConnectionDTO{…},
    "status": ConnectionStatusDTO{…},
    "bends": [PositionDTO{…}],
    "labelIndex": 0,
    "getzIndex": 0,
    "sourceId": "value",
    "sourceGroupId": "value",
    "sourceType": "value",
    "destinationId": "value",
    "destinationGroupId": "value",
    "destinationType": "value",
}

Close

ConnectionStatisticsDTO

Name	Type	Required	Description
id	string	optional	The ID of the connection
statsLastRefreshed	string	optional	The timestamp of when the stats were last refreshed
aggregateSnapshot	ConnectionStatisticsSnapshotDTO	optional	The status snapshot that represents the aggregate stats of the cluster
nodeSnapshots	array[NodeConnectionStatisticsSnapshotDTO]	optional	A list of status snapshots for each node

Example JSON

{
    "id": "value",
    "statsLastRefreshed": "value",
    "aggregateSnapshot": ConnectionStatisticsSnapshotDTO{…},
    "nodeSnapshots": [NodeConnectionStatisticsSnapshotDTO{…}],
}

Close

ConnectionStatisticsEntity

Name	Type	Required	Description
connectionStatistics	ConnectionStatisticsDTO	optional
canRead	boolean	optional	Indicates whether the user can read a given resource. This property is read only.

Example JSON

{
    "connectionStatistics": ConnectionStatisticsDTO{…},
    "canRead": true,
}

Close

ConnectionStatisticsSnapshotDTO

Name	Type	Required	Description
id	string	optional	The id of the connection.
predictedMillisUntilCountBackpressure	integer (int64)	optional	The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count.
predictedMillisUntilBytesBackpressure	integer (int64)	optional	The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue.
predictedCountAtNextInterval	integer (int32)	optional	The predicted number of queued objects at the next configured interval.
predictedBytesAtNextInterval	integer (int64)	optional	The predicted total number of bytes in the queue at the next configured interval.
predictedPercentCount	integer (int32)	optional	The predicted percentage of queued objects at the next configured interval.
predictedPercentBytes	integer (int32)	optional	The predicted percentage of bytes in the queue against current threshold at the next configured interval.
predictionIntervalMillis	integer (int64)	optional	The prediction interval in seconds

Example JSON

{
    "id": "value",
    "predictedMillisUntilCountBackpressure": 0,
    "predictedMillisUntilBytesBackpressure": 0,
    "predictedCountAtNextInterval": 0,
    "predictedBytesAtNextInterval": 0,
    "predictedPercentCount": 0,
    "predictedPercentBytes": 0,
    "predictionIntervalMillis": 0,
}

Close

ConnectionStatusDTO

Name	Type	Required	Description
id	string	optional	The ID of the connection
groupId	string	optional	The ID of the Process Group that the connection belongs to
name	string	optional	The name of the connection
statsLastRefreshed	string	optional	The timestamp of when the stats were last refreshed
sourceId	string	optional	The ID of the source component
sourceName	string	optional	The name of the source component
destinationId	string	optional	The ID of the destination component
destinationName	string	optional	The name of the destination component
aggregateSnapshot	ConnectionStatusSnapshotDTO	optional	The status snapshot that represents the aggregate stats of the cluster
nodeSnapshots	array[NodeConnectionStatusSnapshotDTO]	optional	A list of status snapshots for each node

Example JSON

{
    "id": "value",
    "groupId": "value",
    "name": "value",
    "statsLastRefreshed": "value",
    "sourceId": "value",
    "sourceName": "value",
    "destinationId": "value",
    "destinationName": "value",
    "aggregateSnapshot": ConnectionStatusSnapshotDTO{…},
    "nodeSnapshots": [NodeConnectionStatusSnapshotDTO{…}],
}

Close

ConnectionStatusEntity

Name	Type	Required	Description
connectionStatus	ConnectionStatusDTO	optional
canRead	boolean	optional	Indicates whether the user can read a given resource. This property is read only.

Example JSON

{
    "connectionStatus": ConnectionStatusDTO{…},
    "canRead": true,
}

Close

ConnectionStatusPredictionsSnapshotDTO

Name	Type	Required	Description
predictedMillisUntilCountBackpressure	integer (int64)	optional	The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count.
predictedMillisUntilBytesBackpressure	integer (int64)	optional	The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue.
predictionIntervalSeconds	integer (int32)	optional	The configured interval (in seconds) for predicting connection queue count and size (and percent usage).
predictedCountAtNextInterval	integer (int32)	optional	The predicted number of queued objects at the next configured interval.
predictedBytesAtNextInterval	integer (int64)	optional	The predicted total number of bytes in the queue at the next configured interval.
predictedPercentCount	integer (int32)	optional	Predicted connection percent use regarding queued flow files count and backpressure threshold if configured.
predictedPercentBytes	integer (int32)	optional	Predicted connection percent use regarding queued flow files size and backpressure threshold if configured.

Example JSON

{
    "predictedMillisUntilCountBackpressure": 0,
    "predictedMillisUntilBytesBackpressure": 0,
    "predictionIntervalSeconds": 0,
    "predictedCountAtNextInterval": 0,
    "predictedBytesAtNextInterval": 0,
    "predictedPercentCount": 0,
    "predictedPercentBytes": 0,
}

Close

ConnectionStatusSnapshotDTO

Name	Type	Required	Description
id	string	optional	The id of the connection.
groupId	string	optional	The id of the process group the connection belongs to.
name	string	optional	The name of the connection.
sourceId	string	optional	The id of the source of the connection.
sourceName	string	optional	The name of the source of the connection.
destinationId	string	optional	The id of the destination of the connection.
destinationName	string	optional	The name of the destination of the connection.
predictions	ConnectionStatusPredictionsSnapshotDTO	optional	Predictions, if available, for this connection (null if not available)
flowFilesIn	integer (int32)	optional	The number of FlowFiles that have come into the connection in the last 5 minutes.
bytesIn	integer (int64)	optional	The size of the FlowFiles that have come into the connection in the last 5 minutes.
input	string	optional	The input count/size for the connection in the last 5 minutes, pretty printed.
flowFilesOut	integer (int32)	optional	The number of FlowFiles that have left the connection in the last 5 minutes.
bytesOut	integer (int64)	optional	The number of bytes that have left the connection in the last 5 minutes.
output	string	optional	The output count/sie for the connection in the last 5 minutes, pretty printed.
flowFilesQueued	integer (int32)	optional	The number of FlowFiles that are currently queued in the connection.
bytesQueued	integer (int64)	optional	The size of the FlowFiles that are currently queued in the connection.
queued	string	optional	The total count and size of queued flowfiles formatted.
queuedSize	string	optional	The total size of flowfiles that are queued formatted.
queuedCount	string	optional	The number of flowfiles that are queued, pretty printed.
percentUseCount	integer (int32)	optional	Connection percent use regarding queued flow files count and backpressure threshold if configured.
percentUseBytes	integer (int32)	optional	Connection percent use regarding queued flow files size and backpressure threshold if configured.
flowFileAvailability	string	optional	The availability of FlowFiles in this connection

Example JSON

{
    "id": "value",
    "groupId": "value",
    "name": "value",
    "sourceId": "value",
    "sourceName": "value",
    "destinationId": "value",
    "destinationName": "value",
    "predictions": ConnectionStatusPredictionsSnapshotDTO{…},
    "flowFilesIn": 0,
    "bytesIn": 0,
    "input": "value",
    "flowFilesOut": 0,
    "bytesOut": 0,
    "output": "value",
    "flowFilesQueued": 0,
    "bytesQueued": 0,
    "queued": "value",
    "queuedSize": "value",
    "queuedCount": "value",
    "percentUseCount": 0,
    "percentUseBytes": 0,
    "flowFileAvailability": "value",
}

Close

ConnectionStatusSnapshotEntity

Name	Type	Required	Description
id	string	optional	The id of the connection.
connectionStatusSnapshot	ConnectionStatusSnapshotDTO	optional
canRead	boolean	optional	Indicates whether the user can read a given resource. This property is read only.

Example JSON

{
    "id": "value",
    "connectionStatusSnapshot": ConnectionStatusSnapshotDTO{…},
    "canRead": true,
}

Close

ConnectionsEntity

Name	Type	Required	Description
connections	array[ConnectionEntity]	optional

Example JSON

{
    "connections": [ConnectionEntity{…}],
}

Close

ControllerBulletinsEntity

Name	Type	Required	Description
bulletins	array[BulletinEntity]	optional	System level bulletins to be reported to the user.
controllerServiceBulletins	array[BulletinEntity]	optional	Controller service bulletins to be reported to the user.
reportingTaskBulletins	array[BulletinEntity]	optional	Reporting task bulletins to be reported to the user.
parameterProviderBulletins	array[BulletinEntity]	optional	Parameter provider bulletins to be reported to the user.
flowRegistryClientBulletins	array[BulletinEntity]	optional	Flow registry client bulletins to be reported to the user.

Example JSON

{
    "bulletins": [BulletinEntity{…}],
    "controllerServiceBulletins": [BulletinEntity{…}],
    "reportingTaskBulletins": [BulletinEntity{…}],
    "parameterProviderBulletins": [BulletinEntity{…}],
    "flowRegistryClientBulletins": [BulletinEntity{…}],
}

Close

ControllerConfigurationDTO

Name	Type	Required	Description
maxTimerDrivenThreadCount	integer (int32)	optional	The maximum number of timer driven threads the NiFi has available.
maxEventDrivenThreadCount	integer (int32)	optional	The maximum number of event driven threads the NiFi has available.

Example JSON

{
    "maxTimerDrivenThreadCount": 0,
    "maxEventDrivenThreadCount": 0,
}

Close

ControllerConfigurationEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
permissions	PermissionsDTO	optional	The permissions for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
component	ControllerConfigurationDTO	optional	The controller configuration.

Example JSON

{
    "revision": RevisionDTO{…},
    "permissions": PermissionsDTO{…},
    "disconnectedNodeAcknowledged": true,
    "component": ControllerConfigurationDTO{…},
}

Close

ControllerDTO

Name	Type	Required	Description
id	string	optional	The id of the NiFi.
name	string	optional	The name of the NiFi.
comments	string	optional	The comments for the NiFi.
runningCount	integer (int32)	optional	The number of running components in the NiFi.
stoppedCount	integer (int32)	optional	The number of stopped components in the NiFi.
invalidCount	integer (int32)	optional	The number of invalid components in the NiFi.
disabledCount	integer (int32)	optional	The number of disabled components in the NiFi.
activeRemotePortCount	integer (int32)	optional	The number of active remote ports contained in the NiFi.
inactiveRemotePortCount	integer (int32)	optional	The number of inactive remote ports contained in the NiFi.
inputPortCount	integer (int32)	optional	The number of input ports contained in the NiFi.
outputPortCount	integer (int32)	optional	The number of output ports in the NiFi.
remoteSiteListeningPort	integer (int32)	optional	The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null.
remoteSiteHttpListeningPort	integer (int32)	optional	The HTTP(S) Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null.
siteToSiteSecure	boolean	optional	Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication).
instanceId	string	optional	If clustered, the id of the Cluster Manager, otherwise the id of the NiFi.
inputPorts	array[PortDTO]	optional	The input ports available to send data to for the NiFi.
outputPorts	array[PortDTO]	optional	The output ports available to received data from the NiFi.

Example JSON

{
    "id": "value",
    "name": "value",
    "comments": "value",
    "runningCount": 0,
    "stoppedCount": 0,
    "invalidCount": 0,
    "disabledCount": 0,
    "activeRemotePortCount": 0,
    "inactiveRemotePortCount": 0,
    "inputPortCount": 0,
    "outputPortCount": 0,
    "remoteSiteListeningPort": 0,
    "remoteSiteHttpListeningPort": 0,
    "siteToSiteSecure": true,
    "instanceId": "value",
    "inputPorts": [PortDTO{…}],
    "outputPorts": [PortDTO{…}],
}

Close

ControllerEntity

Name	Type	Required	Description
controller	ControllerDTO	optional

Example JSON

{
    "controller": ControllerDTO{…},
}

Close

ControllerServiceAPI

Name	Type	Required	Description
type	string	optional	The fully qualified name of the service interface.
bundle	Bundle	optional	The details of the artifact that bundled this service interface.

Example JSON

{
    "type": "value",
    "bundle": Bundle{…},
}

Close

ControllerServiceApiDTO

Name	Type	Required	Description
type	string	optional	The fully qualified name of the service interface.
bundle	BundleDTO	optional	The details of the artifact that bundled this service interface.

Example JSON

{
    "type": "value",
    "bundle": BundleDTO{…},
}

Close

ControllerServiceDTO

Name	Type	Required	Description
id	string	optional	The id of the component.
versionedComponentId	string	optional	The ID of the corresponding component that is under version control
parentGroupId	string	optional	The id of parent process group of this component if applicable.
position	PositionDTO	optional	The position of this component in the UI if applicable.
name	string	optional	The name of the controller service.
type	string	optional	The type of the controller service.
bundle	BundleDTO	optional	The details of the artifact that bundled this processor type.
controllerServiceApis	array[ControllerServiceApiDTO]	optional	Lists the APIs this Controller Service implements.
comments	string	optional	The comments for the controller service.
state	string	optional	The state of the controller service. Allowable values: ENABLED, ENABLING, DISABLED, DISABLING
persistsState	boolean	optional	Whether the controller service persists state.
restricted	boolean	optional	Whether the controller service requires elevated privileges.
deprecated	boolean	optional	Whether the ontroller service has been deprecated.
multipleVersionsAvailable	boolean	optional	Whether the controller service has multiple versions available.
supportsSensitiveDynamicProperties	boolean	optional	Whether the controller service supports sensitive dynamic properties.
properties	object	optional	The properties of the controller service.
descriptors	object	optional	The descriptors for the controller service properties.
sensitiveDynamicPropertyNames	array[string]	optional	Set of sensitive dynamic property names
customUiUrl	string	optional	The URL for the controller services custom configuration UI if applicable.
annotationData	string	optional	The annotation for the controller service. This is how the custom UI relays configuration to the controller service.
referencingComponents	array[ControllerServiceReferencingComponentEntity]	optional	All components referencing this controller service.
validationErrors	array[string]	optional	The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled.
validationStatus	string	optional	Indicates whether the ControllerService is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the ControllerService is valid) Allowable values: VALID, INVALID, VALIDATING This property is read only.
bulletinLevel	string	optional	The level at which the controller service will report bulletins.
extensionMissing	boolean	optional	Whether the underlying extension is missing.

Example JSON

{
    "id": "value",
    "versionedComponentId": "value",
    "parentGroupId": "value",
    "position": PositionDTO{…},
    "name": "value",
    "type": "value",
    "bundle": BundleDTO{…},
    "controllerServiceApis": [ControllerServiceApiDTO{…}],
    "comments": "value",
    "state": "value",
    "persistsState": true,
    "restricted": true,
    "deprecated": true,
    "multipleVersionsAvailable": true,
    "supportsSensitiveDynamicProperties": true,
    "properties": {
        "name": "value"
    },
    "descriptors": {
        "name": PropertyDescriptorDTO{…}
    },
    "sensitiveDynamicPropertyNames": ["value"],
    "customUiUrl": "value",
    "annotationData": "value",
    "referencingComponents": [ControllerServiceReferencingComponentEntity{…}],
    "validationErrors": ["value"],
    "validationStatus": "value",
    "bulletinLevel": "value",
    "extensionMissing": true,
}

Close

ControllerServiceDefinition

Name	Type	Required	Description
group	string	optional	The group name of the bundle that provides the referenced type.
artifact	string	optional	The artifact name of the bundle that provides the referenced type.
version	string	optional	The version of the bundle that provides the referenced type.
type	string	required	The fully-qualified class type
typeDescription	string	optional	The description of the type.
buildInfo	BuildInfo	optional	The build metadata for this component
providedApiImplementations	array[DefinedType]	optional	If this type represents a provider for an interface, this lists the APIs it implements
tags	array[string]	optional	The tags associated with this type
seeAlso	array[string]	optional	The names of other component types that may be related
deprecated	boolean	optional	Whether or not the component has been deprecated
deprecationReason	string	optional	If this component has been deprecated, this optional field can be used to provide an explanation
deprecationAlternatives	array[string]	optional	If this component has been deprecated, this optional field provides alternatives to use
restricted	boolean	optional	Whether or not the component has a general restriction
restrictedExplanation	string	optional	An optional description of the general restriction
explicitRestrictions	array[Restriction]	optional	Explicit restrictions that indicate a require permission to use the component
stateful	Stateful	optional	Indicates if the component stores state
systemResourceConsiderations	array[SystemResourceConsideration]	optional	The system resource considerations for the given component
additionalDetails	boolean	optional	Indicates if the component has additional details documentation
propertyDescriptors	object	optional	Descriptions of configuration properties applicable to this component.
supportsDynamicProperties	boolean	optional	Whether or not this component makes use of dynamic (user-set) properties.
supportsSensitiveDynamicProperties	boolean	optional	Whether or not this component makes use of sensitive dynamic (user-set) properties.
dynamicProperties	array[DynamicProperty]	optional	Describes the dynamic properties supported by this component

Example JSON

{
    "group": "value",
    "artifact": "value",
    "version": "value",
    "type": "value",
    "typeDescription": "value",
    "buildInfo": BuildInfo{…},
    "providedApiImplementations": [DefinedType{…}],
    "tags": ["value"],
    "seeAlso": ["value"],
    "deprecated": true,
    "deprecationReason": "value",
    "deprecationAlternatives": ["value"],
    "restricted": true,
    "restrictedExplanation": "value",
    "explicitRestrictions": [Restriction{…}],
    "stateful": Stateful{…},
    "systemResourceConsiderations": [SystemResourceConsideration{…}],
    "additionalDetails": true,
    "propertyDescriptors": {
        "name": PropertyDescriptor{…}
    },
    "supportsDynamicProperties": true,
    "supportsSensitiveDynamicProperties": true,
    "dynamicProperties": [DynamicProperty{…}],
}

Close

ControllerServiceDiagnosticsDTO

Name	Type	Required	Description
controllerService	ControllerServiceEntity	optional	The Controller Service
classLoaderDiagnostics	ClassLoaderDiagnosticsDTO	optional	Information about the Controller Service's Class Loader

Example JSON

{
    "controllerService": ControllerServiceEntity{…},
    "classLoaderDiagnostics": ClassLoaderDiagnosticsDTO{…},
}

Close

ControllerServiceEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
parentGroupId	string	optional	The id of parent process group of this ControllerService.
component	ControllerServiceDTO	optional
operatePermissions	PermissionsDTO	optional	The permissions for this component operations.
status	ControllerServiceStatusDTO	optional	The status for this ControllerService. This property is read only.

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "parentGroupId": "value",
    "component": ControllerServiceDTO{…},
    "operatePermissions": PermissionsDTO{…},
    "status": ControllerServiceStatusDTO{…},
}

Close

ControllerServiceReferencingComponentDTO

Name	Type	Required	Description
groupId	string	optional	The group id for the component referencing a controller service. If this component is another controller service or a reporting task, this field is blank.
id	string	optional	The id of the component referencing a controller service.
name	string	optional	The name of the component referencing a controller service.
type	string	optional	The type of the component referencing a controller service in simple Java class name format without package name.
state	string	optional	The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state.
properties	object	optional	The properties for the component.
descriptors	object	optional	The descriptors for the component properties.
validationErrors	array[string]	optional	The validation errors for the component.
referenceType	string	optional	The type of reference this is. Allowable values: Processor, ControllerService, ReportingTask, FlowRegistryClient
activeThreadCount	integer (int32)	optional	The number of active threads for the referencing component.
referenceCycle	boolean	optional	If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy.
referencingComponents	array[ControllerServiceReferencingComponentEntity]	optional	If the referencing component represents a controller service, these are the components that reference it.

Example JSON

{
    "groupId": "value",
    "id": "value",
    "name": "value",
    "type": "value",
    "state": "value",
    "properties": {
        "name": "value"
    },
    "descriptors": {
        "name": PropertyDescriptorDTO{…}
    },
    "validationErrors": ["value"],
    "referenceType": "value",
    "activeThreadCount": 0,
    "referenceCycle": true,
    "referencingComponents": [ControllerServiceReferencingComponentEntity{…}],
}

Close

ControllerServiceReferencingComponentEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
component	ControllerServiceReferencingComponentDTO	optional
operatePermissions	PermissionsDTO	optional	The permissions for this component operations.

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "component": ControllerServiceReferencingComponentDTO{…},
    "operatePermissions": PermissionsDTO{…},
}

Close

ControllerServiceReferencingComponentsEntity

Name	Type	Required	Description
controllerServiceReferencingComponents	array[ControllerServiceReferencingComponentEntity]	optional

Example JSON

{
    "controllerServiceReferencingComponents": [ControllerServiceReferencingComponentEntity{…}],
}

Close

ControllerServiceRunStatusEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
state	string	optional	The run status of the ControllerService. Allowable values: ENABLED, DISABLED
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
uiOnly	boolean	optional	Indicates whether or not responses should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI.

Example JSON

{
    "revision": RevisionDTO{…},
    "state": "value",
    "disconnectedNodeAcknowledged": true,
    "uiOnly": true,
}

Close

ControllerServiceStatusDTO

Name	Type	Required	Description
runStatus	string	optional	The run status of this ControllerService Allowable values: ENABLED, ENABLING, DISABLED, DISABLING This property is read only.
validationStatus	string	optional	Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid) Allowable values: VALID, INVALID, VALIDATING This property is read only.
activeThreadCount	integer (int32)	optional	The number of active threads for the component.

Example JSON

{
    "runStatus": "value",
    "validationStatus": "value",
    "activeThreadCount": 0,
}

Close

ControllerServiceTypesEntity

Name	Type	Required	Description
controllerServiceTypes	array[DocumentedTypeDTO]	optional

Example JSON

{
    "controllerServiceTypes": [DocumentedTypeDTO{…}],
}

Close

ControllerServicesEntity

Name	Type	Required	Description
currentTime	string	optional	The current time on the system.
controllerServices	array[ControllerServiceEntity]	optional

Example JSON

{
    "currentTime": "value",
    "controllerServices": [ControllerServiceEntity{…}],
}

Close

ControllerStatusDTO

Name	Type	Required	Description
activeThreadCount	integer (int32)	optional	The number of active threads in the NiFi.
terminatedThreadCount	integer (int32)	optional	The number of terminated threads in the NiFi.
queued	string	optional	The number of flowfiles queued in the NiFi.
flowFilesQueued	integer (int32)	optional	The number of FlowFiles queued across the entire flow
bytesQueued	integer (int64)	optional	The size of the FlowFiles queued across the entire flow
runningCount	integer (int32)	optional	The number of running components in the NiFi.
stoppedCount	integer (int32)	optional	The number of stopped components in the NiFi.
invalidCount	integer (int32)	optional	The number of invalid components in the NiFi.
disabledCount	integer (int32)	optional	The number of disabled components in the NiFi.
activeRemotePortCount	integer (int32)	optional	The number of active remote ports in the NiFi.
inactiveRemotePortCount	integer (int32)	optional	The number of inactive remote ports in the NiFi.
upToDateCount	integer (int32)	optional	The number of up to date versioned process groups in the NiFi.
locallyModifiedCount	integer (int32)	optional	The number of locally modified versioned process groups in the NiFi.
staleCount	integer (int32)	optional	The number of stale versioned process groups in the NiFi.
locallyModifiedAndStaleCount	integer (int32)	optional	The number of locally modified and stale versioned process groups in the NiFi.
syncFailureCount	integer (int32)	optional	The number of versioned process groups in the NiFi that are unable to sync to a registry.

Example JSON

{
    "activeThreadCount": 0,
    "terminatedThreadCount": 0,
    "queued": "value",
    "flowFilesQueued": 0,
    "bytesQueued": 0,
    "runningCount": 0,
    "stoppedCount": 0,
    "invalidCount": 0,
    "disabledCount": 0,
    "activeRemotePortCount": 0,
    "inactiveRemotePortCount": 0,
    "upToDateCount": 0,
    "locallyModifiedCount": 0,
    "staleCount": 0,
    "locallyModifiedAndStaleCount": 0,
    "syncFailureCount": 0,
}

Close

ControllerStatusEntity

Name	Type	Required	Description
controllerStatus	ControllerStatusDTO	optional

Example JSON

{
    "controllerStatus": ControllerStatusDTO{…},
}

Close

CopySnippetRequestEntity

Name	Type	Required	Description
snippetId	string	optional	The identifier of the snippet.
originX	number (double)	optional	The x coordinate of the origin of the bounding box where the new components will be placed.
originY	number (double)	optional	The y coordinate of the origin of the bounding box where the new components will be placed.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Example JSON

{
    "snippetId": "value",
    "originX": 0.0,
    "originY": 0.0,
    "disconnectedNodeAcknowledged": true,
}

Close

CounterDTO

Name	Type	Required	Description
id	string	optional	The id of the counter.
context	string	optional	The context of the counter.
name	string	optional	The name of the counter.
valueCount	integer (int64)	optional	The value count.
value	string	optional	The value of the counter.

Example JSON

{
    "id": "value",
    "context": "value",
    "name": "value",
    "valueCount": 0,
    "value": "value",
}

Close

CounterEntity

Name	Type	Required	Description
counter	CounterDTO	optional

Example JSON

{
    "counter": CounterDTO{…},
}

Close

CountersDTO

Name	Type	Required	Description
aggregateSnapshot	CountersSnapshotDTO	optional	A Counters snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.
nodeSnapshots	array[NodeCountersSnapshotDTO]	optional	A Counters snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.

Example JSON

{
    "aggregateSnapshot": CountersSnapshotDTO{…},
    "nodeSnapshots": [NodeCountersSnapshotDTO{…}],
}

Close

CountersEntity

Name	Type	Required	Description
counters	CountersDTO	optional

Example JSON

{
    "counters": CountersDTO{…},
}

Close

CountersSnapshotDTO

Name	Type	Required	Description
generated	string	optional	The timestamp when the report was generated.
counters	array[CounterDTO]	optional	All counters in the NiFi.

Example JSON

{
    "generated": "value",
    "counters": [CounterDTO{…}],
}

Close

CreateActiveRequestEntity

Name	Type	Required	Description
processGroupId	string	optional	The Process Group ID that this active request will update
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Example JSON

{
    "processGroupId": "value",
    "disconnectedNodeAcknowledged": true,
}

Close

CreateTemplateRequestEntity

Name	Type	Required	Description
name	string	optional	The name of the template.
description	string	optional	The description of the template.
snippetId	string	optional	The identifier of the snippet.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Example JSON

{
    "name": "value",
    "description": "value",
    "snippetId": "value",
    "disconnectedNodeAcknowledged": true,
}

Close

CurrentUserEntity

Name	Type	Required	Description
identity	string	optional	The user identity being serialized.
anonymous	boolean	optional	Whether the current user is anonymous.
provenancePermissions	PermissionsDTO	optional	Permissions for querying provenance.
countersPermissions	PermissionsDTO	optional	Permissions for accessing counters.
tenantsPermissions	PermissionsDTO	optional	Permissions for accessing tenants.
controllerPermissions	PermissionsDTO	optional	Permissions for accessing the controller.
policiesPermissions	PermissionsDTO	optional	Permissions for accessing the policies.
systemPermissions	PermissionsDTO	optional	Permissions for accessing system.
parameterContextPermissions	PermissionsDTO	optional	Permissions for accessing parameter contexts.
restrictedComponentsPermissions	PermissionsDTO	optional	Permissions for accessing restricted components. Note: the read permission are not used and will always be false.
componentRestrictionPermissions	array[ComponentRestrictionPermissionDTO]	optional	Permissions for specific component restrictions.
canVersionFlows	boolean	optional	Whether the current user can version flows.

Example JSON

{
    "identity": "value",
    "anonymous": true,
    "provenancePermissions": PermissionsDTO{…},
    "countersPermissions": PermissionsDTO{…},
    "tenantsPermissions": PermissionsDTO{…},
    "controllerPermissions": PermissionsDTO{…},
    "policiesPermissions": PermissionsDTO{…},
    "systemPermissions": PermissionsDTO{…},
    "parameterContextPermissions": PermissionsDTO{…},
    "restrictedComponentsPermissions": PermissionsDTO{…},
    "componentRestrictionPermissions": [ComponentRestrictionPermissionDTO{…}],
    "canVersionFlows": true,
}

Close

DefinedType

Name	Type	Required	Description
group	string	optional	The group name of the bundle that provides the referenced type.
artifact	string	optional	The artifact name of the bundle that provides the referenced type.
version	string	optional	The version of the bundle that provides the referenced type.
type	string	required	The fully-qualified class type
typeDescription	string	optional	The description of the type.

Example JSON

{
    "group": "value",
    "artifact": "value",
    "version": "value",
    "type": "value",
    "typeDescription": "value",
}

Close

DifferenceDTO

Name	Type	Required	Description
differenceType	string	optional	The type of difference
difference	string	optional	Description of the difference

Example JSON

{
    "differenceType": "value",
    "difference": "value",
}

Close

DimensionsDTO

Name	Type	Required	Description
width	number (double)	optional	The width of the label in pixels when at a 1:1 scale.
height	number (double)	optional	The height of the label in pixels when at a 1:1 scale.

Example JSON

{
    "width": 0.0,
    "height": 0.0,
}

Close

DocumentedTypeDTO

Name	Type	Required	Description
type	string	optional	The fully qualified name of the type.
bundle	BundleDTO	optional	The details of the artifact that bundled this type.
controllerServiceApis	array[ControllerServiceApiDTO]	optional	If this type represents a ControllerService, this lists the APIs it implements.
description	string	optional	The description of the type.
restricted	boolean	optional	Whether this type is restricted.
usageRestriction	string	optional	The optional description of why the usage of this component is restricted.
explicitRestrictions	array[ExplicitRestrictionDTO]	optional	An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored.
deprecationReason	string	optional	The description of why the usage of this component is restricted.
tags	array[string]	optional	The tags associated with this type.

Example JSON

{
    "type": "value",
    "bundle": BundleDTO{…},
    "controllerServiceApis": [ControllerServiceApiDTO{…}],
    "description": "value",
    "restricted": true,
    "usageRestriction": "value",
    "explicitRestrictions": [ExplicitRestrictionDTO{…}],
    "deprecationReason": "value",
    "tags": ["value"],
}

Close

DropRequestDTO

Name	Type	Required	Description
id	string	optional	The id for this drop request.
uri	string	optional	The URI for future requests to this drop request.
submissionTime	string	optional	The timestamp when the query was submitted.
lastUpdated	string	optional	The last time this drop request was updated.
percentCompleted	integer (int32)	optional	The current percent complete.
finished	boolean	optional	Whether the query has finished.
failureReason	string	optional	The reason, if any, that this drop request failed.
currentCount	integer (int32)	optional	The number of flow files currently queued.
currentSize	integer (int64)	optional	The size of flow files currently queued in bytes.
current	string	optional	The count and size of flow files currently queued.
originalCount	integer (int32)	optional	The number of flow files to be dropped as a result of this request.
originalSize	integer (int64)	optional	The size of flow files to be dropped as a result of this request in bytes.
original	string	optional	The count and size of flow files to be dropped as a result of this request.
droppedCount	integer (int32)	optional	The number of flow files that have been dropped thus far.
droppedSize	integer (int64)	optional	The size of flow files that have been dropped thus far in bytes.
dropped	string	optional	The count and size of flow files that have been dropped thus far.
state	string	optional	The current state of the drop request.

Example JSON

{
    "id": "value",
    "uri": "value",
    "submissionTime": "value",
    "lastUpdated": "value",
    "percentCompleted": 0,
    "finished": true,
    "failureReason": "value",
    "currentCount": 0,
    "currentSize": 0,
    "current": "value",
    "originalCount": 0,
    "originalSize": 0,
    "original": "value",
    "droppedCount": 0,
    "droppedSize": 0,
    "dropped": "value",
    "state": "value",
}

Close

DropRequestEntity

Name	Type	Required	Description
dropRequest	DropRequestDTO	optional

Example JSON

{
    "dropRequest": DropRequestDTO{…},
}

Close

DtoFactory

Name	Type	Required	Description

Example JSON

{
}

Close

DynamicProperty

Name	Type	Required	Description
name	string	optional	The description of the dynamic property name
value	string	optional	The description of the dynamic property value
description	string	optional	The description of the dynamic property
expressionLanguageScope	string	optional	The scope of the expression language support Allowable values: NONE, VARIABLE_REGISTRY, FLOWFILE_ATTRIBUTES

Example JSON

{
    "name": "value",
    "value": "value",
    "description": "value",
    "expressionLanguageScope": "value",
}

Close

DynamicRelationship

Name	Type	Required	Description
name	string	optional	The description of the dynamic relationship name
description	string	optional	The description of the dynamic relationship

Example JSON

{
    "name": "value",
    "description": "value",
}

Close

Entity

Name	Type	Required	Description

Example JSON

{
}

Close

ExplicitRestrictionDTO

Name	Type	Required	Description
requiredPermission	RequiredPermissionDTO	optional	The required permission necessary for this restriction.
explanation	string	optional	The description of why the usage of this component is restricted for this required permission.

Example JSON

{
    "requiredPermission": RequiredPermissionDTO{…},
    "explanation": "value",
}

Close

ExternalControllerServiceReference

Name	Type	Required	Description
identifier	string	optional	The identifier of the controller service
name	string	optional	The name of the controller service

Example JSON

{
    "identifier": "value",
    "name": "value",
}

Close

FlowBreadcrumbDTO

Name	Type	Required	Description
id	string	optional	The id of the group.
name	string	optional	The id of the group.
versionControlInformation	VersionControlInformationDTO	optional	The process group version control information or null if not version controlled.

Example JSON

{
    "id": "value",
    "name": "value",
    "versionControlInformation": VersionControlInformationDTO{…},
}

Close

FlowBreadcrumbEntity

Name	Type	Required	Description
id	string	optional	The id of this ancestor ProcessGroup.
permissions	PermissionsDTO	optional	The permissions for this ancestor ProcessGroup.
versionedFlowState	string	optional	The current state of the Process Group, as it relates to the Versioned Flow Allowable values: LOCALLY_MODIFIED, STALE, LOCALLY_MODIFIED_AND_STALE, UP_TO_DATE, SYNC_FAILURE This property is read only.
breadcrumb	FlowBreadcrumbDTO	optional	This breadcrumb.
parentBreadcrumb	FlowBreadcrumbEntity	optional	The parent breadcrumb for this breadcrumb.

Example JSON

{
    "id": "value",
    "permissions": PermissionsDTO{…},
    "versionedFlowState": "value",
    "breadcrumb": FlowBreadcrumbDTO{…},
    "parentBreadcrumb": FlowBreadcrumbEntity{…},
}

Close

FlowComparisonEntity

Name	Type	Required	Description
componentDifferences	array[ComponentDifferenceDTO]	optional	The list of differences for each component in the flow that is not the same between the two flows

Example JSON

{
    "componentDifferences": [ComponentDifferenceDTO{…}],
}

Close

FlowConfigurationDTO

Name	Type	Required	Description
supportsManagedAuthorizer	boolean	optional	Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI. This property is read only.
supportsConfigurableAuthorizer	boolean	optional	Whether this NiFi supports a configurable authorizer. This property is read only.
supportsConfigurableUsersAndGroups	boolean	optional	Whether this NiFi supports configurable users and groups. This property is read only.
autoRefreshIntervalSeconds	integer (int64)	optional	The interval in seconds between the automatic NiFi refresh requests. This property is read only.
currentTime	string	optional	The current time on the system.
timeOffset	integer (int32)	optional	The time offset of the system.
defaultBackPressureObjectThreshold	integer (int64)	optional	The default back pressure object threshold.
defaultBackPressureDataSizeThreshold	string	optional	The default back pressure data size threshold.

Example JSON

{
    "supportsManagedAuthorizer": true,
    "supportsConfigurableAuthorizer": true,
    "supportsConfigurableUsersAndGroups": true,
    "autoRefreshIntervalSeconds": 0,
    "currentTime": "value",
    "timeOffset": 0,
    "defaultBackPressureObjectThreshold": 0,
    "defaultBackPressureDataSizeThreshold": "value",
}

Close

FlowConfigurationEntity

Name	Type	Required	Description
flowConfiguration	FlowConfigurationDTO	optional	The controller configuration.

Example JSON

{
    "flowConfiguration": FlowConfigurationDTO{…},
}

Close

FlowDTO

Name	Type	Required	Description
processGroups	array[ProcessGroupEntity]	optional	The process groups in this flow.
remoteProcessGroups	array[RemoteProcessGroupEntity]	optional	The remote process groups in this flow.
processors	array[ProcessorEntity]	optional	The processors in this flow.
inputPorts	array[PortEntity]	optional	The input ports in this flow.
outputPorts	array[PortEntity]	optional	The output ports in this flow.
connections	array[ConnectionEntity]	optional	The connections in this flow.
labels	array[LabelEntity]	optional	The labels in this flow.
funnels	array[FunnelEntity]	optional	The funnels in this flow.

Example JSON

{
    "processGroups": [ProcessGroupEntity{…}],
    "remoteProcessGroups": [RemoteProcessGroupEntity{…}],
    "processors": [ProcessorEntity{…}],
    "inputPorts": [PortEntity{…}],
    "outputPorts": [PortEntity{…}],
    "connections": [ConnectionEntity{…}],
    "labels": [LabelEntity{…}],
    "funnels": [FunnelEntity{…}],
}

Close

FlowEntity

Name	Type	Required	Description
flow	FlowDTO	optional

Example JSON

{
    "flow": FlowDTO{…},
}

Close

FlowFileDTO

Name	Type	Required	Description
uri	string	optional	The URI that can be used to access this FlowFile.
uuid	string	optional	The FlowFile UUID.
filename	string	optional	The FlowFile filename.
position	integer (int32)	optional	The FlowFile's position in the queue.
size	integer (int64)	optional	The FlowFile file size.
queuedDuration	integer (int64)	optional	How long this FlowFile has been enqueued.
lineageDuration	integer (int64)	optional	Duration since the FlowFile's greatest ancestor entered the flow.
penaltyExpiresIn	integer (int64)	optional	How long in milliseconds until the FlowFile penalty expires.
clusterNodeId	string	optional	The id of the node where this FlowFile resides.
clusterNodeAddress	string	optional	The label for the node where this FlowFile resides.
attributes	object	optional	The FlowFile attributes.
contentClaimSection	string	optional	The section in which the content claim lives.
contentClaimContainer	string	optional	The container in which the content claim lives.
contentClaimIdentifier	string	optional	The identifier of the content claim.
contentClaimOffset	integer (int64)	optional	The offset into the content claim where the flowfile's content begins.
contentClaimFileSize	string	optional	The file size of the content claim formatted.
contentClaimFileSizeBytes	integer (int64)	optional	The file size of the content claim in bytes.
penalized	boolean	optional	If the FlowFile is penalized.

Example JSON

{
    "uri": "value",
    "uuid": "value",
    "filename": "value",
    "position": 0,
    "size": 0,
    "queuedDuration": 0,
    "lineageDuration": 0,
    "penaltyExpiresIn": 0,
    "clusterNodeId": "value",
    "clusterNodeAddress": "value",
    "attributes": {
        "name": "value"
    },
    "contentClaimSection": "value",
    "contentClaimContainer": "value",
    "contentClaimIdentifier": "value",
    "contentClaimOffset": 0,
    "contentClaimFileSize": "value",
    "contentClaimFileSizeBytes": 0,
    "penalized": true,
}

Close

FlowFileEntity

Name	Type	Required	Description
flowFile	FlowFileDTO	optional

Example JSON

{
    "flowFile": FlowFileDTO{…},
}

Close

FlowFileSummaryDTO

Name	Type	Required	Description
uri	string	optional	The URI that can be used to access this FlowFile.
uuid	string	optional	The FlowFile UUID.
filename	string	optional	The FlowFile filename.
position	integer (int32)	optional	The FlowFile's position in the queue.
size	integer (int64)	optional	The FlowFile file size.
queuedDuration	integer (int64)	optional	How long this FlowFile has been enqueued.
lineageDuration	integer (int64)	optional	Duration since the FlowFile's greatest ancestor entered the flow.
penaltyExpiresIn	integer (int64)	optional	How long in milliseconds until the FlowFile penalty expires.
clusterNodeId	string	optional	The id of the node where this FlowFile resides.
clusterNodeAddress	string	optional	The label for the node where this FlowFile resides.
penalized	boolean	optional	If the FlowFile is penalized.

Example JSON

{
    "uri": "value",
    "uuid": "value",
    "filename": "value",
    "position": 0,
    "size": 0,
    "queuedDuration": 0,
    "lineageDuration": 0,
    "penaltyExpiresIn": 0,
    "clusterNodeId": "value",
    "clusterNodeAddress": "value",
    "penalized": true,
}

Close

FlowRegistryBucket

Name	Type	Required
identifier	string	optional
name	string	optional
description	string	optional
createdTimestamp	integer (int64)	optional
permissions	FlowRegistryPermissions	optional

Example JSON

{
    "identifier": "value",
    "name": "value",
    "description": "value",
    "createdTimestamp": 0,
    "permissions": FlowRegistryPermissions{…},
}

Close

FlowRegistryBucketDTO

Name	Type	Required	Description
id	string	optional	The bucket identifier
name	string	optional	The bucket name
description	string	optional	The bucket description
created	integer (int64)	optional	The created timestamp of this bucket

Example JSON

{
    "id": "value",
    "name": "value",
    "description": "value",
    "created": 0,
}

Close

FlowRegistryBucketEntity

Name	Type	Required
id	string	optional
bucket	FlowRegistryBucketDTO	optional
permissions	PermissionsDTO	optional

Example JSON

{
    "id": "value",
    "bucket": FlowRegistryBucketDTO{…},
    "permissions": PermissionsDTO{…},
}

Close

FlowRegistryBucketsEntity

Name	Type	Required	Description
buckets	array[FlowRegistryBucketEntity]	optional

Example JSON

{
    "buckets": [FlowRegistryBucketEntity{…}],
}

Close

FlowRegistryClientDTO

Name	Type	Required	Description
id	string	optional	The registry identifier
name	string	optional	The registry name
description	string	optional	The registry description
uri	string	optional
type	string	optional	The type of the controller service.
bundle	BundleDTO	optional	The details of the artifact that bundled this processor type.
properties	object	optional	The properties of the controller service.
descriptors	object	optional	The descriptors for the controller service properties.
sensitiveDynamicPropertyNames	array[string]	optional	Set of sensitive dynamic property names
supportsSensitiveDynamicProperties	boolean	optional	Whether the reporting task supports sensitive dynamic properties.
restricted	boolean	optional	Whether the reporting task requires elevated privileges.
deprecated	boolean	optional	Whether the reporting task has been deprecated.
validationErrors	array[string]	optional	Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.
validationStatus	string	optional	Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid) Allowable values: VALID, INVALID, VALIDATING This property is read only.
annotationData	string	optional	The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task.
extensionMissing	boolean	optional	Whether the underlying extension is missing.
multipleVersionsAvailable	boolean	optional	Whether the flow registry client has multiple versions available.

Example JSON

{
    "id": "value",
    "name": "value",
    "description": "value",
    "uri": "value",
    "type": "value",
    "bundle": BundleDTO{…},
    "properties": {
        "name": "value"
    },
    "descriptors": {
        "name": PropertyDescriptorDTO{…}
    },
    "sensitiveDynamicPropertyNames": ["value"],
    "supportsSensitiveDynamicProperties": true,
    "restricted": true,
    "deprecated": true,
    "validationErrors": ["value"],
    "validationStatus": "value",
    "annotationData": "value",
    "extensionMissing": true,
    "multipleVersionsAvailable": true,
}

Close

FlowRegistryClientEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
registry	FlowRegistryClientDTO	optional
operatePermissions	PermissionsDTO	optional
component	FlowRegistryClientDTO	optional

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "registry": FlowRegistryClientDTO{…},
    "operatePermissions": PermissionsDTO{…},
    "component": FlowRegistryClientDTO{…},
}

Close

FlowRegistryClientTypesEntity

Name	Type	Required	Description
flowRegistryClientTypes	array[DocumentedTypeDTO]	optional

Example JSON

{
    "flowRegistryClientTypes": [DocumentedTypeDTO{…}],
}

Close

FlowRegistryClientsEntity

Name	Type	Required	Description
registries	array[FlowRegistryClientEntity]	optional

Example JSON

{
    "registries": [FlowRegistryClientEntity{…}],
}

Close

FlowRegistryPermissions

Name	Type	Required
canRead	boolean	optional
canWrite	boolean	optional
canDelete	boolean	optional

Example JSON

{
    "canRead": true,
    "canWrite": true,
    "canDelete": true,
}

Close

FlowSnippetDTO

Name	Type	Required	Description
processGroups	array[ProcessGroupDTO]	optional	The process groups in this flow snippet.
remoteProcessGroups	array[RemoteProcessGroupDTO]	optional	The remote process groups in this flow snippet.
processors	array[ProcessorDTO]	optional	The processors in this flow snippet.
inputPorts	array[PortDTO]	optional	The input ports in this flow snippet.
outputPorts	array[PortDTO]	optional	The output ports in this flow snippet.
connections	array[ConnectionDTO]	optional	The connections in this flow snippet.
labels	array[LabelDTO]	optional	The labels in this flow snippet.
funnels	array[FunnelDTO]	optional	The funnels in this flow snippet.
controllerServices	array[ControllerServiceDTO]	optional	The controller services in this flow snippet.

Example JSON

{
    "processGroups": [ProcessGroupDTO{…}],
    "remoteProcessGroups": [RemoteProcessGroupDTO{…}],
    "processors": [ProcessorDTO{…}],
    "inputPorts": [PortDTO{…}],
    "outputPorts": [PortDTO{…}],
    "connections": [ConnectionDTO{…}],
    "labels": [LabelDTO{…}],
    "funnels": [FunnelDTO{…}],
    "controllerServices": [ControllerServiceDTO{…}],
}

Close

FunnelDTO

Name	Type	Required	Description
id	string	optional	The id of the component.
versionedComponentId	string	optional	The ID of the corresponding component that is under version control
parentGroupId	string	optional	The id of parent process group of this component if applicable.
position	PositionDTO	optional	The position of this component in the UI if applicable.

Example JSON

{
    "id": "value",
    "versionedComponentId": "value",
    "parentGroupId": "value",
    "position": PositionDTO{…},
}

Close

FunnelEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
component	FunnelDTO	optional

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "component": FunnelDTO{…},
}

Close

FunnelsEntity

Name	Type	Required	Description
funnels	array[FunnelEntity]	optional

Example JSON

{
    "funnels": [FunnelEntity{…}],
}

Close

GCDiagnosticsSnapshotDTO

Name	Type	Required	Description
timestamp	string (date-time)	optional	The timestamp of when the Snapshot was taken
collectionCount	integer (int64)	optional	The number of times that Garbage Collection has occurred
collectionMillis	integer (int64)	optional	The number of milliseconds that the Garbage Collector spent performing Garbage Collection duties

Example JSON

{
    "timestamp": "value",
    "collectionCount": 0,
    "collectionMillis": 0,
}

Close

GarbageCollectionDTO

Name	Type	Required	Description
name	string	optional	The name of the garbage collector.
collectionCount	integer (int64)	optional	The number of times garbage collection has run.
collectionTime	string	optional	The total amount of time spent garbage collecting.
collectionMillis	integer (int64)	optional	The total number of milliseconds spent garbage collecting.

Example JSON

{
    "name": "value",
    "collectionCount": 0,
    "collectionTime": "value",
    "collectionMillis": 0,
}

Close

GarbageCollectionDiagnosticsDTO

Name	Type	Required	Description
memoryManagerName	string	optional	The name of the Memory Manager that this Garbage Collection information pertains to
snapshots	array[GCDiagnosticsSnapshotDTO]	optional	A list of snapshots that have been taken to determine the health of the JVM's heap

Example JSON

{
    "memoryManagerName": "value",
    "snapshots": [GCDiagnosticsSnapshotDTO{…}],
}

Close

HistoryDTO

Name	Type	Required	Description
total	integer (int32)	optional	The number of number of actions that matched the search criteria..
lastRefreshed	string	optional	The timestamp when the report was generated.
actions	array[ActionEntity]	optional	The actions.

Example JSON

{
    "total": 0,
    "lastRefreshed": "value",
    "actions": [ActionEntity{…}],
}

Close

HistoryEntity

Name	Type	Required	Description
history	HistoryDTO	optional

Example JSON

{
    "history": HistoryDTO{…},
}

Close

InputPortsEntity

Name	Type	Required	Description
inputPorts	array[PortEntity]	optional

Example JSON

{
    "inputPorts": [PortEntity{…}],
}

Close

InputStream

Name	Type	Required	Description

Example JSON

{
}

Close

InstantiateTemplateRequestEntity

Name	Type	Required	Description
originX	number (double)	optional	The x coordinate of the origin of the bounding box where the new components will be placed.
originY	number (double)	optional	The y coordinate of the origin of the bounding box where the new components will be placed.
templateId	string	optional	The identifier of the template.
encodingVersion	string	optional	The encoding version of the flow snippet. If not specified, this is automatically populated by the node receiving the user request. If the snippet is specified, the version will be the latest. If the snippet is not specified, the version will come from the underlying template. These details need to be replicated throughout the cluster to ensure consistency.
snippet	FlowSnippetDTO	optional	A flow snippet of the template contents. If not specified, this is automatically populated by the node receiving the user request. These details need to be replicated throughout the cluster to ensure consistency.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Example JSON

{
    "originX": 0.0,
    "originY": 0.0,
    "templateId": "value",
    "encodingVersion": "value",
    "snippet": FlowSnippetDTO{…},
    "disconnectedNodeAcknowledged": true,
}

Close

JVMControllerDiagnosticsSnapshotDTO

Name	Type	Required	Description
primaryNode	boolean	optional	Whether or not this node is primary node
clusterCoordinator	boolean	optional	Whether or not this node is cluster coordinator
maxTimerDrivenThreads	integer (int32)	optional	The maximum number of timer-driven threads
maxEventDrivenThreads	integer (int32)	optional	The maximum number of event-driven threads

Example JSON

{
    "primaryNode": true,
    "clusterCoordinator": true,
    "maxTimerDrivenThreads": 0,
    "maxEventDrivenThreads": 0,
}

Close

JVMDiagnosticsDTO

Name	Type	Required	Description
clustered	boolean	optional	Whether or not the NiFi instance is clustered
connected	boolean	optional	Whether or not the node is connected to the cluster
aggregateSnapshot	JVMDiagnosticsSnapshotDTO	optional	Aggregate JVM diagnostic information about the entire cluster
nodeSnapshots	array[NodeJVMDiagnosticsSnapshotDTO]	optional	Node-wise breakdown of JVM diagnostic information

Example JSON

{
    "clustered": true,
    "connected": true,
    "aggregateSnapshot": JVMDiagnosticsSnapshotDTO{…},
    "nodeSnapshots": [NodeJVMDiagnosticsSnapshotDTO{…}],
}

Close

JVMDiagnosticsSnapshotDTO

Name	Type	Required	Description
systemDiagnosticsDto	JVMSystemDiagnosticsSnapshotDTO	optional	System-related diagnostics information
flowDiagnosticsDto	JVMFlowDiagnosticsSnapshotDTO	optional	Flow-related diagnostics information
controllerDiagnostics	JVMControllerDiagnosticsSnapshotDTO	optional	Controller-related diagnostics information

Example JSON

{
    "systemDiagnosticsDto": JVMSystemDiagnosticsSnapshotDTO{…},
    "flowDiagnosticsDto": JVMFlowDiagnosticsSnapshotDTO{…},
    "controllerDiagnostics": JVMControllerDiagnosticsSnapshotDTO{…},
}

Close

JVMFlowDiagnosticsSnapshotDTO

Name	Type	Required	Description
uptime	string	optional	How long this node has been running, formatted as hours:minutes:seconds.milliseconds
timeZone	string	optional	The name of the Time Zone that is configured, if available
activeTimerDrivenThreads	integer (int32)	optional	The number of timer-driven threads that are active
activeEventDrivenThreads	integer (int32)	optional	The number of event-driven threads that are active
bundlesLoaded	array[BundleDTO]	optional	The NiFi Bundles (NARs) that are loaded by NiFi

Example JSON

{
    "uptime": "value",
    "timeZone": "value",
    "activeTimerDrivenThreads": 0,
    "activeEventDrivenThreads": 0,
    "bundlesLoaded": [BundleDTO{…}],
}

Close

JVMSystemDiagnosticsSnapshotDTO

Name	Type	Required	Description
flowFileRepositoryStorageUsage	RepositoryUsageDTO	optional	Information about the FlowFile Repository's usage
contentRepositoryStorageUsage	array[RepositoryUsageDTO]	optional	Information about the Content Repository's usage
provenanceRepositoryStorageUsage	array[RepositoryUsageDTO]	optional	Information about the Provenance Repository's usage
maxHeapBytes	integer (int64)	optional	The maximum number of bytes that the JVM heap is configured to use for heap
maxHeap	string	optional	The maximum number of bytes that the JVM heap is configured to use, as a human-readable value
garbageCollectionDiagnostics	array[GarbageCollectionDiagnosticsDTO]	optional	Diagnostic information about the JVM's garbage collections
cpuCores	integer (int32)	optional	The number of CPU Cores available on the system
cpuLoadAverage	number (double)	optional	The 1-minute CPU Load Average
physicalMemoryBytes	integer (int64)	optional	The number of bytes of RAM available on the system
physicalMemory	string	optional	The number of bytes of RAM available on the system as a human-readable value
openFileDescriptors	integer (int64)	optional	The number of files that are open by the NiFi process
maxOpenFileDescriptors	integer (int64)	optional	The maximum number of open file descriptors that are available to each process

Example JSON

{
    "flowFileRepositoryStorageUsage": RepositoryUsageDTO{…},
    "contentRepositoryStorageUsage": [RepositoryUsageDTO{…}],
    "provenanceRepositoryStorageUsage": [RepositoryUsageDTO{…}],
    "maxHeapBytes": 0,
    "maxHeap": "value",
    "garbageCollectionDiagnostics": [GarbageCollectionDiagnosticsDTO{…}],
    "cpuCores": 0,
    "cpuLoadAverage": 0.0,
    "physicalMemoryBytes": 0,
    "physicalMemory": "value",
    "openFileDescriptors": 0,
    "maxOpenFileDescriptors": 0,
}

Close

JmxMetricsResultDTO

Name	Type	Required	Description
beanName	string	optional	The bean name of the metrics bean.
attributeName	string	optional	The attribute name of the metrics bean's attribute.
attributeValue	object	optional	The attribute value of the the metrics bean's attribute

Example JSON

{
    "beanName": "value",
    "attributeName": "value",
    "attributeValue": {
        "name": "value"
    },
}

Close

JmxMetricsResultsEntity

Name	Type	Required	Description
jmxMetricsResults	array[JmxMetricsResultDTO]	optional

Example JSON

{
    "jmxMetricsResults": [JmxMetricsResultDTO{…}],
}

Close

LabelDTO

Name	Type	Required	Description
id	string	optional	The id of the component.
versionedComponentId	string	optional	The ID of the corresponding component that is under version control
parentGroupId	string	optional	The id of parent process group of this component if applicable.
position	PositionDTO	optional	The position of this component in the UI if applicable.
label	string	optional	The text that appears in the label.
width	number (double)	optional	The width of the label in pixels when at a 1:1 scale.
height	number (double)	optional	The height of the label in pixels when at a 1:1 scale.
getzIndex	integer (int64)	optional	The z index of the label.
style	object	optional	The styles for this label (font-size : 12px, background-color : #eee, etc).

Example JSON

{
    "id": "value",
    "versionedComponentId": "value",
    "parentGroupId": "value",
    "position": PositionDTO{…},
    "label": "value",
    "width": 0.0,
    "height": 0.0,
    "getzIndex": 0,
    "style": {
        "name": "value"
    },
}

Close

LabelEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
dimensions	DimensionsDTO	optional
getzIndex	integer (int64)	optional	The z index of the label.
component	LabelDTO	optional

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "dimensions": DimensionsDTO{…},
    "getzIndex": 0,
    "component": LabelDTO{…},
}

Close

LabelsEntity

Name	Type	Required	Description
labels	array[LabelEntity]	optional

Example JSON

{
    "labels": [LabelEntity{…}],
}

Close

LineageDTO

Name	Type	Required	Description
id	string	optional	The id of this lineage query.
uri	string	optional	The URI for this lineage query for later retrieval and deletion.
submissionTime	string	optional	When the lineage query was submitted.
expiration	string	optional	When the lineage query will expire.
percentCompleted	integer (int32)	optional	The percent complete for the lineage query.
finished	boolean	optional	Whether the lineage query has finished.
request	LineageRequestDTO	optional	The initial lineage result.
results	LineageResultsDTO	optional	The results of the lineage query.

Example JSON

{
    "id": "value",
    "uri": "value",
    "submissionTime": "value",
    "expiration": "value",
    "percentCompleted": 0,
    "finished": true,
    "request": LineageRequestDTO{…},
    "results": LineageResultsDTO{…},
}

Close

LineageEntity

Name	Type	Required	Description
lineage	LineageDTO	optional

Example JSON

{
    "lineage": LineageDTO{…},
}

Close

LineageRequestDTO

Name	Type	Required	Description
eventId	integer (int64)	optional	The event id that was used to generate this lineage, if applicable. The event id is allowed for any type of lineageRequestType. If the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored.
lineageRequestType	string	optional	The type of lineage request. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile. Allowable values: PARENTS, CHILDREN, and FLOWFILE
uuid	string	optional	The flowfile uuid that was used to generate the lineage. The flowfile uuid is only allowed when the lineageRequestType is FLOWFILE and will take precedence over event id.
clusterNodeId	string	optional	The id of the node where this lineage originated if clustered.

Example JSON

{
    "eventId": 0,
    "lineageRequestType": "value",
    "uuid": "value",
    "clusterNodeId": "value",
}

Close

LineageResultsDTO

Name	Type	Required	Description
errors	array[string]	optional	Any errors that occurred while generating the lineage.
nodes	array[ProvenanceNodeDTO]	optional	The nodes in the lineage.
links	array[ProvenanceLinkDTO]	optional	The links between the nodes in the lineage.

Example JSON

{
    "errors": ["value"],
    "nodes": [ProvenanceNodeDTO{…}],
    "links": [ProvenanceLinkDTO{…}],
}

Close

ListingRequestDTO

Name	Type	Required	Description
id	string	optional	The id for this listing request.
uri	string	optional	The URI for future requests to this listing request.
submissionTime	string	optional	The timestamp when the query was submitted.
lastUpdated	string	optional	The last time this listing request was updated.
percentCompleted	integer (int32)	optional	The current percent complete.
finished	boolean	optional	Whether the query has finished.
failureReason	string	optional	The reason, if any, that this listing request failed.
maxResults	integer (int32)	optional	The maximum number of FlowFileSummary objects to return
state	string	optional	The current state of the listing request.
queueSize	QueueSizeDTO	optional	The size of the queue
flowFileSummaries	array[FlowFileSummaryDTO]	optional	The FlowFile summaries. The summaries will be populated once the request has completed.
sourceRunning	boolean	optional	Whether the source of the connection is running
destinationRunning	boolean	optional	Whether the destination of the connection is running

Example JSON

{
    "id": "value",
    "uri": "value",
    "submissionTime": "value",
    "lastUpdated": "value",
    "percentCompleted": 0,
    "finished": true,
    "failureReason": "value",
    "maxResults": 0,
    "state": "value",
    "queueSize": QueueSizeDTO{…},
    "flowFileSummaries": [FlowFileSummaryDTO{…}],
    "sourceRunning": true,
    "destinationRunning": true,
}

Close

ListingRequestEntity

Name	Type	Required	Description
listingRequest	ListingRequestDTO	optional

Example JSON

{
    "listingRequest": ListingRequestDTO{…},
}

Close

LocalQueuePartitionDTO

Name	Type	Required	Description
totalFlowFileCount	integer (int32)	optional	Total number of FlowFiles owned by the Connection
totalByteCount	integer (int64)	optional	Total number of bytes that make up the content for the FlowFiles owned by this Connection
activeQueueFlowFileCount	integer (int32)	optional	Total number of FlowFiles that exist in the Connection's Active Queue, immediately available to be offered up to a component
activeQueueByteCount	integer (int64)	optional	Total number of bytes that make up the content for the FlowFiles that are present in the Connection's Active Queue
swapFlowFileCount	integer (int32)	optional	The total number of FlowFiles that are swapped out for this Connection
swapByteCount	integer (int64)	optional	Total number of bytes that make up the content for the FlowFiles that are swapped out to disk for the Connection
swapFiles	integer (int32)	optional	The number of Swap Files that exist for this Connection
inFlightFlowFileCount	integer (int32)	optional	The number of In-Flight FlowFiles for this Connection. These are FlowFiles that belong to the connection but are currently being operated on by a Processor, Port, etc.
inFlightByteCount	integer (int64)	optional	The number bytes that make up the content of the FlowFiles that are In-Flight
allActiveQueueFlowFilesPenalized	boolean	optional	Whether or not all of the FlowFiles in the Active Queue are penalized
anyActiveQueueFlowFilesPenalized	boolean	optional	Whether or not any of the FlowFiles in the Active Queue are penalized

Example JSON

{
    "totalFlowFileCount": 0,
    "totalByteCount": 0,
    "activeQueueFlowFileCount": 0,
    "activeQueueByteCount": 0,
    "swapFlowFileCount": 0,
    "swapByteCount": 0,
    "swapFiles": 0,
    "inFlightFlowFileCount": 0,
    "inFlightByteCount": 0,
    "allActiveQueueFlowFilesPenalized": true,
    "anyActiveQueueFlowFilesPenalized": true,
}

Close

NodeConnectionStatisticsSnapshotDTO

Name	Type	Required	Description
nodeId	string	optional	The unique ID that identifies the node
address	string	optional	The API address of the node
apiPort	integer (int32)	optional	The API port used to communicate with the node
statisticsSnapshot	ConnectionStatisticsSnapshotDTO	optional	The connection status snapshot from the node.

Example JSON

{
    "nodeId": "value",
    "address": "value",
    "apiPort": 0,
    "statisticsSnapshot": ConnectionStatisticsSnapshotDTO{…},
}

Close

NodeConnectionStatusSnapshotDTO

Name	Type	Required	Description
nodeId	string	optional	The unique ID that identifies the node
address	string	optional	The API address of the node
apiPort	integer (int32)	optional	The API port used to communicate with the node
statusSnapshot	ConnectionStatusSnapshotDTO	optional	The connection status snapshot from the node.

Example JSON

{
    "nodeId": "value",
    "address": "value",
    "apiPort": 0,
    "statusSnapshot": ConnectionStatusSnapshotDTO{…},
}

Close

NodeCountersSnapshotDTO

Name	Type	Required	Description
nodeId	string	optional	The unique ID that identifies the node
address	string	optional	The API address of the node
apiPort	integer (int32)	optional	The API port used to communicate with the node
snapshot	CountersSnapshotDTO	optional	The counters from the node.

Example JSON

{
    "nodeId": "value",
    "address": "value",
    "apiPort": 0,
    "snapshot": CountersSnapshotDTO{…},
}

Close

NodeDTO

Name	Type	Required	Description
nodeId	string	optional	The id of the node. This property is read only.
address	string	optional	The node's host/ip address. This property is read only.
apiPort	integer (int32)	optional	The port the node is listening for API requests. This property is read only.
status	string	optional	The node's status.
heartbeat	string	optional	the time of the nodes's last heartbeat. This property is read only.
connectionRequested	string	optional	The time of the node's last connection request. This property is read only.
roles	array[string]	optional	The roles of this node. This property is read only.
activeThreadCount	integer (int32)	optional	The active threads for the NiFi on the node. This property is read only.
queued	string	optional	The queue the NiFi on the node. This property is read only.
events	array[NodeEventDTO]	optional	The node's events. This property is read only.
nodeStartTime	string	optional	The time at which this Node was last refreshed. This property is read only.

Example JSON

{
    "nodeId": "value",
    "address": "value",
    "apiPort": 0,
    "status": "value",
    "heartbeat": "value",
    "connectionRequested": "value",
    "roles": ["value"],
    "activeThreadCount": 0,
    "queued": "value",
    "events": [NodeEventDTO{…}],
    "nodeStartTime": "value",
}

Close

NodeEntity

Name	Type	Required	Description
node	NodeDTO	optional

Example JSON

{
    "node": NodeDTO{…},
}

Close

NodeEventDTO

Name	Type	Required	Description
timestamp	string	optional	The timestamp of the node event.
category	string	optional	The category of the node event.
message	string	optional	The message in the node event.

Example JSON

{
    "timestamp": "value",
    "category": "value",
    "message": "value",
}

Close

NodeIdentifier

Name	Type	Required
id	string	optional
apiAddress	string	optional
apiPort	integer (int32)	optional
socketAddress	string	optional
socketPort	integer (int32)	optional
loadBalanceAddress	string	optional
loadBalancePort	integer (int32)	optional
siteToSiteAddress	string	optional
siteToSitePort	integer (int32)	optional
siteToSiteHttpApiPort	integer (int32)	optional
siteToSiteSecure	boolean	optional
nodeIdentities	array[string]	optional
fullDescription	string	optional

Example JSON

{
    "id": "value",
    "apiAddress": "value",
    "apiPort": 0,
    "socketAddress": "value",
    "socketPort": 0,
    "loadBalanceAddress": "value",
    "loadBalancePort": 0,
    "siteToSiteAddress": "value",
    "siteToSitePort": 0,
    "siteToSiteHttpApiPort": 0,
    "siteToSiteSecure": true,
    "nodeIdentities": ["value"],
    "fullDescription": "value",
}

Close

NodeJVMDiagnosticsSnapshotDTO

Name	Type	Required	Description
nodeId	string	optional	The unique ID that identifies the node
address	string	optional	The API address of the node
apiPort	integer (int32)	optional	The API port used to communicate with the node
snapshot	JVMDiagnosticsSnapshotDTO	optional	The JVM Diagnostics Snapshot

Example JSON

{
    "nodeId": "value",
    "address": "value",
    "apiPort": 0,
    "snapshot": JVMDiagnosticsSnapshotDTO{…},
}

Close

NodePortStatusSnapshotDTO

Name	Type	Required	Description
nodeId	string	optional	The unique ID that identifies the node
address	string	optional	The API address of the node
apiPort	integer (int32)	optional	The API port used to communicate with the node
statusSnapshot	PortStatusSnapshotDTO	optional	The port status snapshot from the node.

Example JSON

{
    "nodeId": "value",
    "address": "value",
    "apiPort": 0,
    "statusSnapshot": PortStatusSnapshotDTO{…},
}

Close

NodeProcessGroupStatusSnapshotDTO

Name	Type	Required	Description
nodeId	string	optional	The unique ID that identifies the node
address	string	optional	The API address of the node
apiPort	integer (int32)	optional	The API port used to communicate with the node
statusSnapshot	ProcessGroupStatusSnapshotDTO	optional	The process group status snapshot from the node.

Example JSON

{
    "nodeId": "value",
    "address": "value",
    "apiPort": 0,
    "statusSnapshot": ProcessGroupStatusSnapshotDTO{…},
}

Close

NodeProcessorStatusSnapshotDTO

Name	Type	Required	Description
nodeId	string	optional	The unique ID that identifies the node
address	string	optional	The API address of the node
apiPort	integer (int32)	optional	The API port used to communicate with the node
statusSnapshot	ProcessorStatusSnapshotDTO	optional	The processor status snapshot from the node.

Example JSON

{
    "nodeId": "value",
    "address": "value",
    "apiPort": 0,
    "statusSnapshot": ProcessorStatusSnapshotDTO{…},
}

Close

NodeRemoteProcessGroupStatusSnapshotDTO

Name	Type	Required	Description
nodeId	string	optional	The unique ID that identifies the node
address	string	optional	The API address of the node
apiPort	integer (int32)	optional	The API port used to communicate with the node
statusSnapshot	RemoteProcessGroupStatusSnapshotDTO	optional	The remote process group status snapshot from the node.

Example JSON

{
    "nodeId": "value",
    "address": "value",
    "apiPort": 0,
    "statusSnapshot": RemoteProcessGroupStatusSnapshotDTO{…},
}

Close

NodeReplayLastEventSnapshotDTO

Name	Type	Required	Description
nodeId	string	optional	The unique ID that identifies the node
address	string	optional	The API address of the node
apiPort	integer (int32)	optional	The API port used to communicate with the node
snapshot	ReplayLastEventSnapshotDTO	optional	The snapshot from the node

Example JSON

{
    "nodeId": "value",
    "address": "value",
    "apiPort": 0,
    "snapshot": ReplayLastEventSnapshotDTO{…},
}

Close

NodeResponse

Name	Type	Required
httpMethod	string	optional
requestUri	string (uri)	optional
response	Response	optional
nodeId	NodeIdentifier	optional
throwable	Throwable	optional
updatedEntity	Entity	optional
requestId	string	optional
inputStream	InputStream	optional
is2xx	boolean	optional
is5xx	boolean	optional
status	integer (int32)	optional
clientResponse	Response	optional

Example JSON

{
    "httpMethod": "value",
    "requestUri": "value",
    "response": Response{…},
    "nodeId": NodeIdentifier{…},
    "throwable": Throwable{…},
    "updatedEntity": Entity{…},
    "requestId": "value",
    "inputStream": InputStream{…},
    "is2xx": true,
    "is5xx": true,
    "status": 0,
    "clientResponse": Response{…},
}

Close

NodeSearchResultDTO

Name	Type	Required	Description
id	string	optional	The id of the node that matched the search.
address	string	optional	The address of the node that matched the search.

Example JSON

{
    "id": "value",
    "address": "value",
}

Close

NodeStatusSnapshotsDTO

Name	Type	Required	Description
nodeId	string	optional	The id of the node.
address	string	optional	The node's host/ip address.
apiPort	integer (int32)	optional	The port the node is listening for API requests.
statusSnapshots	array[StatusSnapshotDTO]	optional	A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.

Example JSON

{
    "nodeId": "value",
    "address": "value",
    "apiPort": 0,
    "statusSnapshots": [StatusSnapshotDTO{…}],
}

Close

NodeSystemDiagnosticsSnapshotDTO

Name	Type	Required	Description
nodeId	string	optional	The unique ID that identifies the node
address	string	optional	The API address of the node
apiPort	integer (int32)	optional	The API port used to communicate with the node
snapshot	SystemDiagnosticsSnapshotDTO	optional	The System Diagnostics snapshot from the node.

Example JSON

{
    "nodeId": "value",
    "address": "value",
    "apiPort": 0,
    "snapshot": SystemDiagnosticsSnapshotDTO{…},
}

Close

OutputPortsEntity

Name	Type	Required	Description
outputPorts	array[PortEntity]	optional

Example JSON

{
    "outputPorts": [PortEntity{…}],
}

Close

ParameterContextDTO

Name	Type	Required	Description
name	string	optional	The Name of the Parameter Context.
description	string	optional	The Description of the Parameter Context.
parameters	array[ParameterEntity]	optional	The Parameters for the Parameter Context
boundProcessGroups	array[ProcessGroupEntity]	optional	The Process Groups that are bound to this Parameter Context This property is read only.
inheritedParameterContexts	array[ParameterContextReferenceEntity]	optional	A list of references of Parameter Contexts from which this one inherits parameters
parameterProviderConfiguration	ParameterProviderConfigurationEntity	optional	Optional configuration for a Parameter Provider
id	string	optional	The ID the Parameter Context. This property is read only.

Example JSON

{
    "name": "value",
    "description": "value",
    "parameters": [ParameterEntity{…}],
    "boundProcessGroups": [ProcessGroupEntity{…}],
    "inheritedParameterContexts": [ParameterContextReferenceEntity{…}],
    "parameterProviderConfiguration": ParameterProviderConfigurationEntity{…},
    "id": "value",
}

Close

ParameterContextEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
component	ParameterContextDTO	optional	The Parameter Context

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "component": ParameterContextDTO{…},
}

Close

ParameterContextReferenceDTO

Name	Type	Required	Description
id	string	optional	The ID of the Parameter Context
name	string	optional	The name of the Parameter Context

Example JSON

{
    "id": "value",
    "name": "value",
}

Close

ParameterContextReferenceEntity

Name	Type	Required	Description
id	string	optional	The id of the component.
permissions	PermissionsDTO	optional	The permissions for this component.
component	ParameterContextReferenceDTO	optional

Example JSON

{
    "id": "value",
    "permissions": PermissionsDTO{…},
    "component": ParameterContextReferenceDTO{…},
}

Close

ParameterContextUpdateEntity

Name	Type	Required	Description
parameterContextRevision	RevisionDTO	optional	The Revision of the Parameter Context
parameterContext	ParameterContextDTO	optional	The Parameter Context that is being operated on. This may not be populated until the request has successfully completed. This property is read only.
referencingComponents	array[AffectedComponentEntity]	optional	The components that are referenced by the update. This property is read only.

Example JSON

{
    "parameterContextRevision": RevisionDTO{…},
    "parameterContext": ParameterContextDTO{…},
    "referencingComponents": [AffectedComponentEntity{…}],
}

Close

ParameterContextUpdateRequestDTO

Name	Type	Required	Description
requestId	string	optional	The ID of the request This property is read only.
uri	string	optional	The URI for the request This property is read only.
submissionTime	string (date-time)	optional	The timestamp of when the request was submitted This property is read only.
lastUpdated	string (date-time)	optional	The timestamp of when the request was last updated This property is read only.
complete	boolean	optional	Whether or not the request is completed This property is read only.
failureReason	string	optional	The reason for the request failing, or null if the request has not failed This property is read only.
percentCompleted	integer (int32)	optional	A value between 0 and 100 (inclusive) indicating how close the request is to completion This property is read only.
state	string	optional	A description of the current state of the request This property is read only.
updateSteps	array[ParameterContextUpdateStepDTO]	optional	The steps that are required in order to complete the request, along with the status of each This property is read only.
parameterContext	ParameterContextDTO	optional	The Parameter Context that is being operated on. This may not be populated until the request has successfully completed. This property is read only.
referencingComponents	array[AffectedComponentEntity]	optional	The components that are referenced by the update. This property is read only.

Example JSON

{
    "requestId": "value",
    "uri": "value",
    "submissionTime": "value",
    "lastUpdated": "value",
    "complete": true,
    "failureReason": "value",
    "percentCompleted": 0,
    "state": "value",
    "updateSteps": [ParameterContextUpdateStepDTO{…}],
    "parameterContext": ParameterContextDTO{…},
    "referencingComponents": [AffectedComponentEntity{…}],
}

Close

ParameterContextUpdateRequestEntity

Name	Type	Required	Description
parameterContextRevision	RevisionDTO	optional	The Revision of the Parameter Context
request	ParameterContextUpdateRequestDTO	optional	The Update Request

Example JSON

{
    "parameterContextRevision": RevisionDTO{…},
    "request": ParameterContextUpdateRequestDTO{…},
}

Close

ParameterContextUpdateStepDTO

Name	Type	Required	Description
description	string	optional	Explanation of what happens in this step This property is read only.
complete	boolean	optional	Whether or not this step has completed This property is read only.
failureReason	string	optional	An explanation of why this step failed, or null if this step did not fail This property is read only.

Example JSON

{
    "description": "value",
    "complete": true,
    "failureReason": "value",
}

Close

ParameterContextValidationRequestDTO

Name	Type	Required	Description
requestId	string	optional	The ID of the request This property is read only.
uri	string	optional	The URI for the request This property is read only.
submissionTime	string (date-time)	optional	The timestamp of when the request was submitted This property is read only.
lastUpdated	string (date-time)	optional	The timestamp of when the request was last updated This property is read only.
complete	boolean	optional	Whether or not the request is completed This property is read only.
failureReason	string	optional	The reason for the request failing, or null if the request has not failed This property is read only.
percentCompleted	integer (int32)	optional	A value between 0 and 100 (inclusive) indicating how close the request is to completion This property is read only.
state	string	optional	A description of the current state of the request This property is read only.
updateSteps	array[ParameterContextValidationStepDTO]	optional	The steps that are required in order to complete the request, along with the status of each This property is read only.
parameterContext	ParameterContextDTO	optional	The Parameter Context that is being operated on.
componentValidationResults	ComponentValidationResultsEntity	optional	The Validation Results that were calculated for each component. This value may not be set until the request completes. This property is read only.

Example JSON

{
    "requestId": "value",
    "uri": "value",
    "submissionTime": "value",
    "lastUpdated": "value",
    "complete": true,
    "failureReason": "value",
    "percentCompleted": 0,
    "state": "value",
    "updateSteps": [ParameterContextValidationStepDTO{…}],
    "parameterContext": ParameterContextDTO{…},
    "componentValidationResults": ComponentValidationResultsEntity{…},
}

Close

ParameterContextValidationRequestEntity

Name	Type	Required	Description
request	ParameterContextValidationRequestDTO	optional	The Update Request
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Example JSON

{
    "request": ParameterContextValidationRequestDTO{…},
    "disconnectedNodeAcknowledged": true,
}

Close

ParameterContextValidationStepDTO

Name	Type	Required	Description
description	string	optional	Explanation of what happens in this step This property is read only.
complete	boolean	optional	Whether or not this step has completed This property is read only.
failureReason	string	optional	An explanation of why this step failed, or null if this step did not fail This property is read only.

Example JSON

{
    "description": "value",
    "complete": true,
    "failureReason": "value",
}

Close

ParameterContextsEntity

Name	Type	Required	Description
parameterContexts	array[ParameterContextEntity]	optional	The Parameter Contexts
currentTime	string	optional	The current time on the system. This property is read only.

Example JSON

{
    "parameterContexts": [ParameterContextEntity{…}],
    "currentTime": "value",
}

Close

ParameterDTO

Name	Type	Required	Description
name	string	optional	The name of the Parameter
description	string	optional	The description of the Parameter
sensitive	boolean	optional	Whether or not the Parameter is sensitive
value	string	optional	The value of the Parameter
valueRemoved	boolean	optional	Whether or not the value of the Parameter was removed. When a request is made to change a parameter, the value may be null. The absence of the value may be used either to indicate that the value is not to be changed, or that the value is to be set to null (i.e., removed). This denotes which of the two scenarios is being encountered.
provided	boolean	optional	Whether or not the Parameter is provided by a ParameterProvider
referencingComponents	array[AffectedComponentEntity]	optional	The set of all components in the flow that are referencing this Parameter
parameterContext	ParameterContextReferenceEntity	optional	A reference to the Parameter Context that contains this one
inherited	boolean	optional	Whether or not the Parameter is inherited from another context This property is read only.

Example JSON

{
    "name": "value",
    "description": "value",
    "sensitive": true,
    "value": "value",
    "valueRemoved": true,
    "provided": true,
    "referencingComponents": [AffectedComponentEntity{…}],
    "parameterContext": ParameterContextReferenceEntity{…},
    "inherited": true,
}

Close

ParameterEntity

Name	Type	Required	Description
canWrite	boolean	optional	Indicates whether the user can write a given resource. This property is read only.
parameter	ParameterDTO	optional	The parameter information

Example JSON

{
    "canWrite": true,
    "parameter": ParameterDTO{…},
}

Close

ParameterGroupConfigurationEntity

Name	Type	Required	Description
groupName	string	optional	The name of the external parameter group to which the provided parameter names apply.
parameterContextName	string	optional	The name of the ParameterContext that receives the parameters in this group
parameterSensitivities	object	optional	All fetched parameter names that should be applied.
synchronized	boolean	optional	True if this group should be synchronized to a ParameterContext, including creating one if it does not exist.

Example JSON

{
    "groupName": "value",
    "parameterContextName": "value",
    "parameterSensitivities": {
        "name": "value"
    },
    "synchronized": true,
}

Close

ParameterProviderApplyParametersRequestDTO

Name	Type	Required	Description
requestId	string	optional	The ID of the request This property is read only.
uri	string	optional	The URI for the request This property is read only.
submissionTime	string (date-time)	optional	The timestamp of when the request was submitted This property is read only.
lastUpdated	string (date-time)	optional	The timestamp of when the request was last updated This property is read only.
complete	boolean	optional	Whether or not the request is completed This property is read only.
failureReason	string	optional	The reason for the request failing, or null if the request has not failed This property is read only.
percentCompleted	integer (int32)	optional	A value between 0 and 100 (inclusive) indicating how close the request is to completion This property is read only.
state	string	optional	A description of the current state of the request This property is read only.
updateSteps	array[ParameterProviderApplyParametersUpdateStepDTO]	optional	The steps that are required in order to complete the request, along with the status of each This property is read only.
parameterProvider	ParameterProviderDTO	optional	The Parameter Provider that is being operated on. This may not be populated until the request has successfully completed. This property is read only.
parameterContextUpdates	array[ParameterContextUpdateEntity]	optional	The Parameter Contexts updated by this Parameter Provider. This may not be populated until the request has successfully completed. This property is read only.
referencingComponents	array[AffectedComponentEntity]	optional	The components that are referenced by the update. This property is read only.

Example JSON

{
    "requestId": "value",
    "uri": "value",
    "submissionTime": "value",
    "lastUpdated": "value",
    "complete": true,
    "failureReason": "value",
    "percentCompleted": 0,
    "state": "value",
    "updateSteps": [ParameterProviderApplyParametersUpdateStepDTO{…}],
    "parameterProvider": ParameterProviderDTO{…},
    "parameterContextUpdates": [ParameterContextUpdateEntity{…}],
    "referencingComponents": [AffectedComponentEntity{…}],
}

Close

ParameterProviderApplyParametersRequestEntity

Name	Type	Required	Description
request	ParameterProviderApplyParametersRequestDTO	optional	The Apply Parameters Request

Example JSON

{
    "request": ParameterProviderApplyParametersRequestDTO{…},
}

Close

ParameterProviderApplyParametersUpdateStepDTO

Name	Type	Required	Description
description	string	optional	Explanation of what happens in this step This property is read only.
complete	boolean	optional	Whether or not this step has completed This property is read only.
failureReason	string	optional	An explanation of why this step failed, or null if this step did not fail This property is read only.

Example JSON

{
    "description": "value",
    "complete": true,
    "failureReason": "value",
}

Close

ParameterProviderConfigurationDTO

Name	Type	Required	Description
parameterProviderId	string	optional	The ID of the Parameter Provider
parameterProviderName	string	optional	The name of the Parameter Provider
parameterGroupName	string	optional	The Parameter Group name that maps to the Parameter Context
synchronized	boolean	optional	True if the Parameter Context should receive the parameters from the mapped Parameter Group

Example JSON

{
    "parameterProviderId": "value",
    "parameterProviderName": "value",
    "parameterGroupName": "value",
    "synchronized": true,
}

Close

ParameterProviderConfigurationEntity

Name	Type	Required	Description
id	string	optional	The id of the component.
permissions	PermissionsDTO	optional	The permissions for this component.
component	ParameterProviderConfigurationDTO	optional

Example JSON

{
    "id": "value",
    "permissions": PermissionsDTO{…},
    "component": ParameterProviderConfigurationDTO{…},
}

Close

ParameterProviderDTO

Name	Type	Required	Description
id	string	optional	The id of the component.
versionedComponentId	string	optional	The ID of the corresponding component that is under version control
parentGroupId	string	optional	The id of parent process group of this component if applicable.
position	PositionDTO	optional	The position of this component in the UI if applicable.
name	string	optional	The name of the parameter provider.
type	string	optional	The fully qualified type of the parameter provider.
bundle	BundleDTO	optional	The details of the artifact that bundled this parameter provider type.
comments	string	optional	The comments of the parameter provider.
persistsState	boolean	optional	Whether the parameter provider persists state.
restricted	boolean	optional	Whether the parameter provider requires elevated privileges.
deprecated	boolean	optional	Whether the parameter provider has been deprecated.
multipleVersionsAvailable	boolean	optional	Whether the parameter provider has multiple versions available.
properties	object	optional	The properties of the parameter provider.
descriptors	object	optional	The descriptors for the parameter providers properties.
parameterGroupConfigurations	array[ParameterGroupConfigurationEntity]	optional	Configuration for any fetched parameter groups.
affectedComponents	array[AffectedComponentEntity]	optional	The set of all components in the flow that are referencing Parameters provided by this provider
parameterStatus	array[ParameterStatusDTO]	optional	The status of all provided parameters for this parameter provider
referencingParameterContexts	array[ParameterProviderReferencingComponentEntity]	optional	The Parameter Contexts that reference this Parameter Provider This property is read only.
customUiUrl	string	optional	The URL for the custom configuration UI for the parameter provider.
annotationData	string	optional	The annotation data for the parameter provider. This is how the custom UI relays configuration to the parameter provider.
validationErrors	array[string]	optional	Gets the validation errors from the parameter provider. These validation errors represent the problems with the parameter provider that must be resolved before it can be scheduled to run.
validationStatus	string	optional	Indicates whether the Parameter Provider is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Parameter Provider is valid) Allowable values: VALID, INVALID, VALIDATING This property is read only.
extensionMissing	boolean	optional	Whether the underlying extension is missing.

Example JSON

{
    "id": "value",
    "versionedComponentId": "value",
    "parentGroupId": "value",
    "position": PositionDTO{…},
    "name": "value",
    "type": "value",
    "bundle": BundleDTO{…},
    "comments": "value",
    "persistsState": true,
    "restricted": true,
    "deprecated": true,
    "multipleVersionsAvailable": true,
    "properties": {
        "name": "value"
    },
    "descriptors": {
        "name": PropertyDescriptorDTO{…}
    },
    "parameterGroupConfigurations": [ParameterGroupConfigurationEntity{…}],
    "affectedComponents": [AffectedComponentEntity{…}],
    "parameterStatus": [ParameterStatusDTO{…}],
    "referencingParameterContexts": [ParameterProviderReferencingComponentEntity{…}],
    "customUiUrl": "value",
    "annotationData": "value",
    "validationErrors": ["value"],
    "validationStatus": "value",
    "extensionMissing": true,
}

Close

ParameterProviderEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
component	ParameterProviderDTO	optional

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "component": ParameterProviderDTO{…},
}

Close

ParameterProviderParameterApplicationEntity

Name	Type	Required	Description
id	string	optional	The id of the parameter provider.
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
parameterGroupConfigurations	array[ParameterGroupConfigurationEntity]	optional	Configuration for the fetched Parameter Groups

Example JSON

{
    "id": "value",
    "revision": RevisionDTO{…},
    "disconnectedNodeAcknowledged": true,
    "parameterGroupConfigurations": [ParameterGroupConfigurationEntity{…}],
}

Close

ParameterProviderParameterFetchEntity

Name	Type	Required	Description
id	string	optional	The id of the parameter provider.
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Example JSON

{
    "id": "value",
    "revision": RevisionDTO{…},
    "disconnectedNodeAcknowledged": true,
}

Close

ParameterProviderReference

Name	Type	Required	Description
identifier	string	optional	The identifier of the parameter provider
name	string	optional	The name of the parameter provider
type	string	optional	The fully qualified name of the parameter provider class.
bundle	Bundle	optional	The details of the artifact that bundled this parameter provider.

Example JSON

{
    "identifier": "value",
    "name": "value",
    "type": "value",
    "bundle": Bundle{…},
}

Close

ParameterProviderReferencingComponentDTO

Name	Type	Required	Description
id	string	optional	The id of the component referencing a parameter provider.
name	string	optional	The name of the component referencing a parameter provider.

Example JSON

{
    "id": "value",
    "name": "value",
}

Close

ParameterProviderReferencingComponentEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
component	ParameterProviderReferencingComponentDTO	optional

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "component": ParameterProviderReferencingComponentDTO{…},
}

Close

ParameterProviderReferencingComponentsEntity

Name	Type	Required	Description
parameterProviderReferencingComponents	array[ParameterProviderReferencingComponentEntity]	optional

Example JSON

{
    "parameterProviderReferencingComponents": [ParameterProviderReferencingComponentEntity{…}],
}

Close

ParameterProviderTypesEntity

Name	Type	Required	Description
parameterProviderTypes	array[DocumentedTypeDTO]	optional

Example JSON

{
    "parameterProviderTypes": [DocumentedTypeDTO{…}],
}

Close

ParameterProvidersEntity

Name	Type	Required	Description
parameterProviders	array[ParameterProviderEntity]	optional

Example JSON

{
    "parameterProviders": [ParameterProviderEntity{…}],
}

Close

ParameterStatusDTO

Name	Type	Required	Description
parameter	ParameterEntity	optional	The name of the Parameter
status	string	optional	Indicates the status of the parameter, compared to the existing parameter context Allowable values: NEW, CHANGED, REMOVED, MISSING_BUT_REFERENCED, UNCHANGED

Example JSON

{
    "parameter": ParameterEntity{…},
    "status": "value",
}

Close

PeerDTO

Name	Type	Required	Description
hostname	string	optional	The hostname of this peer.
port	integer (int32)	optional	The port number of this peer.
secure	boolean	optional	Returns if this peer connection is secure.
flowFileCount	integer (int32)	optional	The number of flowFiles this peer holds.

Example JSON

{
    "hostname": "value",
    "port": 0,
    "secure": true,
    "flowFileCount": 0,
}

Close

PeersEntity

Name	Type	Required	Description
peers	array[PeerDTO]	optional

Example JSON

{
    "peers": [PeerDTO{…}],
}

Close

PermissionsDTO

Name	Type	Required	Description
canRead	boolean	optional	Indicates whether the user can read a given resource. This property is read only.
canWrite	boolean	optional	Indicates whether the user can write a given resource. This property is read only.

Example JSON

{
    "canRead": true,
    "canWrite": true,
}

Close

PortDTO

Name	Type	Required	Description
id	string	optional	The id of the component.
versionedComponentId	string	optional	The ID of the corresponding component that is under version control
parentGroupId	string	optional	The id of parent process group of this component if applicable.
position	PositionDTO	optional	The position of this component in the UI if applicable.
name	string	optional	The name of the port.
comments	string	optional	The comments for the port.
state	string	optional	The state of the port. Allowable values: RUNNING, STOPPED, DISABLED
type	string	optional	The type of port. Allowable values: INPUT_PORT, OUTPUT_PORT
transmitting	boolean	optional	Whether the port has incoming or output connections to a remote NiFi. This is only applicable when the port is allowed to be accessed remotely.
concurrentlySchedulableTaskCount	integer (int32)	optional	The number of tasks that should be concurrently scheduled for the port.
userAccessControl	array[string]	optional	The users that are allowed to access the port.
groupAccessControl	array[string]	optional	The user groups that are allowed to access the port.
allowRemoteAccess	boolean	optional	Whether this port can be accessed remotely via Site-to-Site protocol.
validationErrors	array[string]	optional	Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started.

Example JSON

{
    "id": "value",
    "versionedComponentId": "value",
    "parentGroupId": "value",
    "position": PositionDTO{…},
    "name": "value",
    "comments": "value",
    "state": "value",
    "type": "value",
    "transmitting": true,
    "concurrentlySchedulableTaskCount": 0,
    "userAccessControl": ["value"],
    "groupAccessControl": ["value"],
    "allowRemoteAccess": true,
    "validationErrors": ["value"],
}

Close

PortEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
component	PortDTO	optional
status	PortStatusDTO	optional	The status of the port.
portType	string	optional
operatePermissions	PermissionsDTO	optional	The permissions for this component operations.
allowRemoteAccess	boolean	optional	Whether this port can be accessed remotely via Site-to-Site protocol.

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "component": PortDTO{…},
    "status": PortStatusDTO{…},
    "portType": "value",
    "operatePermissions": PermissionsDTO{…},
    "allowRemoteAccess": true,
}

Close

PortRunStatusEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
state	string	optional	The run status of the Port. Allowable values: RUNNING, STOPPED, DISABLED
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Example JSON

{
    "revision": RevisionDTO{…},
    "state": "value",
    "disconnectedNodeAcknowledged": true,
}

Close

PortStatusDTO

Name	Type	Required	Description
id	string	optional	The id of the port.
groupId	string	optional	The id of the parent process group of the port.
name	string	optional	The name of the port.
transmitting	boolean	optional	Whether the port has incoming or outgoing connections to a remote NiFi.
runStatus	string	optional	The run status of the port. Allowable values: Running, Stopped, Validating, Disabled, Invalid
statsLastRefreshed	string	optional	The time the status for the process group was last refreshed.
aggregateSnapshot	PortStatusSnapshotDTO	optional	A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.
nodeSnapshots	array[NodePortStatusSnapshotDTO]	optional	A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.

Example JSON

{
    "id": "value",
    "groupId": "value",
    "name": "value",
    "transmitting": true,
    "runStatus": "value",
    "statsLastRefreshed": "value",
    "aggregateSnapshot": PortStatusSnapshotDTO{…},
    "nodeSnapshots": [NodePortStatusSnapshotDTO{…}],
}

Close

PortStatusEntity

Name	Type	Required	Description
portStatus	PortStatusDTO	optional
canRead	boolean	optional	Indicates whether the user can read a given resource. This property is read only.

Example JSON

{
    "portStatus": PortStatusDTO{…},
    "canRead": true,
}

Close

PortStatusSnapshotDTO

Name	Type	Required	Description
id	string	optional	The id of the port.
groupId	string	optional	The id of the parent process group of the port.
name	string	optional	The name of the port.
activeThreadCount	integer (int32)	optional	The active thread count for the port.
flowFilesIn	integer (int32)	optional	The number of FlowFiles that have been accepted in the last 5 minutes.
bytesIn	integer (int64)	optional	The size of hte FlowFiles that have been accepted in the last 5 minutes.
input	string	optional	The count/size of flowfiles that have been accepted in the last 5 minutes.
flowFilesOut	integer (int32)	optional	The number of FlowFiles that have been processed in the last 5 minutes.
bytesOut	integer (int64)	optional	The number of bytes that have been processed in the last 5 minutes.
output	string	optional	The count/size of flowfiles that have been processed in the last 5 minutes.
transmitting	boolean	optional	Whether the port has incoming or outgoing connections to a remote NiFi.
runStatus	string	optional	The run status of the port. Allowable values: Running, Stopped, Validating, Disabled, Invalid

Example JSON

{
    "id": "value",
    "groupId": "value",
    "name": "value",
    "activeThreadCount": 0,
    "flowFilesIn": 0,
    "bytesIn": 0,
    "input": "value",
    "flowFilesOut": 0,
    "bytesOut": 0,
    "output": "value",
    "transmitting": true,
    "runStatus": "value",
}

Close

PortStatusSnapshotEntity

Name	Type	Required	Description
id	string	optional	The id of the port.
portStatusSnapshot	PortStatusSnapshotDTO	optional
canRead	boolean	optional	Indicates whether the user can read a given resource. This property is read only.

Example JSON

{
    "id": "value",
    "portStatusSnapshot": PortStatusSnapshotDTO{…},
    "canRead": true,
}

Close

Position

Name	Type	Required	Description
x	number (double)	optional	The x coordinate.
y	number (double)	optional	The y coordinate.

Example JSON

{
    "x": 0.0,
    "y": 0.0,
}

Close

PositionDTO

Name	Type	Required	Description
x	number (double)	optional	The x coordinate.
y	number (double)	optional	The y coordinate.

Example JSON

{
    "x": 0.0,
    "y": 0.0,
}

Close

PreviousValueDTO

Name	Type	Required	Description
previousValue	string	optional	The previous value.
timestamp	string	optional	The timestamp when the value was modified.
userIdentity	string	optional	The user who changed the previous value.

Example JSON

{
    "previousValue": "value",
    "timestamp": "value",
    "userIdentity": "value",
}

Close

PrioritizerTypesEntity

Name	Type	Required	Description
prioritizerTypes	array[DocumentedTypeDTO]	optional

Example JSON

{
    "prioritizerTypes": [DocumentedTypeDTO{…}],
}

Close

ProcessGroupDTO

Name	Type	Required	Description
id	string	optional	The id of the component.
versionedComponentId	string	optional	The ID of the corresponding component that is under version control
parentGroupId	string	optional	The id of parent process group of this component if applicable.
position	PositionDTO	optional	The position of this component in the UI if applicable.
name	string	optional	The name of the process group.
comments	string	optional	The comments for the process group.
variables	object	optional	The variables that are configured for the Process Group. Note that this map contains only those variables that are defined on this Process Group and not any variables that are defined in the parent Process Group, etc. I.e., this Map will not contain all variables that are accessible by components in this Process Group by rather only the variables that are defined for this Process Group itself. This property is read only.
versionControlInformation	VersionControlInformationDTO	optional	The Version Control information that indicates which Flow Registry, and where in the Flow Registry, this Process Group is tracking to; or null if this Process Group is not under version control
parameterContext	ParameterContextReferenceEntity	optional	The Parameter Context that this Process Group is bound to.
flowfileConcurrency	string	optional	The FlowFile Concurrency for this Process Group. Allowable values: UNBOUNDED, SINGLE_FLOWFILE_PER_NODE, SINGLE_BATCH_PER_NODE
flowfileOutboundPolicy	string	optional	The Outbound Policy that is used for determining how FlowFiles should be transferred out of the Process Group. Allowable values: STREAM_WHEN_AVAILABLE, BATCH_OUTPUT
defaultFlowFileExpiration	string	optional	The default FlowFile Expiration for this Process Group.
defaultBackPressureObjectThreshold	integer (int64)	optional	Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied.
defaultBackPressureDataSizeThreshold	string	optional	Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied.
logFileSuffix	string	optional	The log file suffix for this Process Group for dedicated logging.
runningCount	integer (int32)	optional	The number of running components in this process group.
stoppedCount	integer (int32)	optional	The number of stopped components in the process group.
invalidCount	integer (int32)	optional	The number of invalid components in the process group.
disabledCount	integer (int32)	optional	The number of disabled components in the process group.
activeRemotePortCount	integer (int32)	optional	The number of active remote ports in the process group.
inactiveRemotePortCount	integer (int32)	optional	The number of inactive remote ports in the process group.
upToDateCount	integer (int32)	optional	The number of up to date versioned process groups in the process group.
locallyModifiedCount	integer (int32)	optional	The number of locally modified versioned process groups in the process group.
staleCount	integer (int32)	optional	The number of stale versioned process groups in the process group.
locallyModifiedAndStaleCount	integer (int32)	optional	The number of locally modified and stale versioned process groups in the process group.
syncFailureCount	integer (int32)	optional	The number of versioned process groups in the process group that are unable to sync to a registry.
localInputPortCount	integer (int32)	optional	The number of local input ports in the process group.
localOutputPortCount	integer (int32)	optional	The number of local output ports in the process group.
publicInputPortCount	integer (int32)	optional	The number of public input ports in the process group.
publicOutputPortCount	integer (int32)	optional	The number of public output ports in the process group.
contents	FlowSnippetDTO	optional	The contents of this process group.
inputPortCount	integer (int32)	optional	The number of input ports in the process group. This property is read only.
outputPortCount	integer (int32)	optional	The number of output ports in the process group. This property is read only.

Example JSON

{
    "id": "value",
    "versionedComponentId": "value",
    "parentGroupId": "value",
    "position": PositionDTO{…},
    "name": "value",
    "comments": "value",
    "variables": {
        "name": "value"
    },
    "versionControlInformation": VersionControlInformationDTO{…},
    "parameterContext": ParameterContextReferenceEntity{…},
    "flowfileConcurrency": "value",
    "flowfileOutboundPolicy": "value",
    "defaultFlowFileExpiration": "value",
    "defaultBackPressureObjectThreshold": 0,
    "defaultBackPressureDataSizeThreshold": "value",
    "logFileSuffix": "value",
    "runningCount": 0,
    "stoppedCount": 0,
    "invalidCount": 0,
    "disabledCount": 0,
    "activeRemotePortCount": 0,
    "inactiveRemotePortCount": 0,
    "upToDateCount": 0,
    "locallyModifiedCount": 0,
    "staleCount": 0,
    "locallyModifiedAndStaleCount": 0,
    "syncFailureCount": 0,
    "localInputPortCount": 0,
    "localOutputPortCount": 0,
    "publicInputPortCount": 0,
    "publicOutputPortCount": 0,
    "contents": FlowSnippetDTO{…},
    "inputPortCount": 0,
    "outputPortCount": 0,
}

Close

ProcessGroupEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
component	ProcessGroupDTO	optional
status	ProcessGroupStatusDTO	optional	The status of the process group.
versionedFlowSnapshot	RegisteredFlowSnapshot	optional	Returns the Versioned Flow that describes the contents of the Versioned Flow to be imported This property is read only.
runningCount	integer (int32)	optional	The number of running components in this process group.
stoppedCount	integer (int32)	optional	The number of stopped components in the process group.
invalidCount	integer (int32)	optional	The number of invalid components in the process group.
disabledCount	integer (int32)	optional	The number of disabled components in the process group.
activeRemotePortCount	integer (int32)	optional	The number of active remote ports in the process group.
inactiveRemotePortCount	integer (int32)	optional	The number of inactive remote ports in the process group.
versionedFlowState	string	optional	The current state of the Process Group, as it relates to the Versioned Flow Allowable values: LOCALLY_MODIFIED, STALE, LOCALLY_MODIFIED_AND_STALE, UP_TO_DATE, SYNC_FAILURE This property is read only.
upToDateCount	integer (int32)	optional	The number of up to date versioned process groups in the process group.
locallyModifiedCount	integer (int32)	optional	The number of locally modified versioned process groups in the process group.
staleCount	integer (int32)	optional	The number of stale versioned process groups in the process group.
locallyModifiedAndStaleCount	integer (int32)	optional	The number of locally modified and stale versioned process groups in the process group.
syncFailureCount	integer (int32)	optional	The number of versioned process groups in the process group that are unable to sync to a registry.
localInputPortCount	integer (int32)	optional	The number of local input ports in the process group.
localOutputPortCount	integer (int32)	optional	The number of local output ports in the process group.
publicInputPortCount	integer (int32)	optional	The number of public input ports in the process group.
publicOutputPortCount	integer (int32)	optional	The number of public output ports in the process group.
parameterContext	ParameterContextReferenceEntity	optional	The Parameter Context, or null if no Parameter Context has been bound to the Process Group
processGroupUpdateStrategy	string	optional	Determines the process group update strategy Allowable values: DIRECT_CHILDREN, ALL_DESCENDANTS
inputPortCount	integer (int32)	optional	The number of input ports in the process group. This property is read only.
outputPortCount	integer (int32)	optional	The number of output ports in the process group. This property is read only.

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "component": ProcessGroupDTO{…},
    "status": ProcessGroupStatusDTO{…},
    "versionedFlowSnapshot": RegisteredFlowSnapshot{…},
    "runningCount": 0,
    "stoppedCount": 0,
    "invalidCount": 0,
    "disabledCount": 0,
    "activeRemotePortCount": 0,
    "inactiveRemotePortCount": 0,
    "versionedFlowState": "value",
    "upToDateCount": 0,
    "locallyModifiedCount": 0,
    "staleCount": 0,
    "locallyModifiedAndStaleCount": 0,
    "syncFailureCount": 0,
    "localInputPortCount": 0,
    "localOutputPortCount": 0,
    "publicInputPortCount": 0,
    "publicOutputPortCount": 0,
    "parameterContext": ParameterContextReferenceEntity{…},
    "processGroupUpdateStrategy": "value",
    "inputPortCount": 0,
    "outputPortCount": 0,
}

Close

ProcessGroupFlowDTO

Name	Type	Required	Description
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
parentGroupId	string	optional	The id of parent process group of this component if applicable.
parameterContext	ParameterContextReferenceEntity	optional	The Parameter Context, or null if no Parameter Context has been bound to the Process Group
breadcrumb	FlowBreadcrumbEntity	optional	The breadcrumb of the process group.
flow	FlowDTO	optional	The flow structure starting at this Process Group.
lastRefreshed	string	optional	The time the flow for the process group was last refreshed.

Example JSON

{
    "id": "value",
    "uri": "value",
    "parentGroupId": "value",
    "parameterContext": ParameterContextReferenceEntity{…},
    "breadcrumb": FlowBreadcrumbEntity{…},
    "flow": FlowDTO{…},
    "lastRefreshed": "value",
}

Close

ProcessGroupFlowEntity

Name	Type	Required	Description
permissions	PermissionsDTO	optional	The access policy for this process group.
processGroupFlow	ProcessGroupFlowDTO	optional

Example JSON

{
    "permissions": PermissionsDTO{…},
    "processGroupFlow": ProcessGroupFlowDTO{…},
}

Close

ProcessGroupImportEntity

Name	Type	Required	Description
processGroupRevision	RevisionDTO	optional	The Revision for the Process Group
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
versionedFlowSnapshot	RegisteredFlowSnapshot	optional	The Versioned Flow Snapshot to import

Example JSON

{
    "processGroupRevision": RevisionDTO{…},
    "disconnectedNodeAcknowledged": true,
    "versionedFlowSnapshot": RegisteredFlowSnapshot{…},
}

Close

ProcessGroupNameDTO

Name	Type	Required	Description
id	string	optional	The ID of the Process Group
name	string	optional	The name of the Process Group, or the ID of the Process Group if the user does not have the READ policy for the Process Group

Example JSON

{
    "id": "value",
    "name": "value",
}

Close

ProcessGroupReplaceRequestDTO

Name	Type	Required	Description
requestId	string	optional	The unique ID of this request. This property is read only.
processGroupId	string	optional	The unique ID of the Process Group being updated
uri	string	optional	The URI for future requests to this drop request. This property is read only.
lastUpdated	string	optional	The last time this request was updated. This property is read only.
complete	boolean	optional	Whether or not this request has completed This property is read only.
failureReason	string	optional	An explanation of why this request failed, or null if this request has not failed This property is read only.
percentCompleted	integer (int32)	optional	The percentage complete for the request, between 0 and 100 This property is read only.
state	string	optional	The state of the request This property is read only.

Example JSON

{
    "requestId": "value",
    "processGroupId": "value",
    "uri": "value",
    "lastUpdated": "value",
    "complete": true,
    "failureReason": "value",
    "percentCompleted": 0,
    "state": "value",
}

Close

ProcessGroupReplaceRequestEntity

Name	Type	Required	Description
processGroupRevision	RevisionDTO	optional	The revision for the Process Group being updated.
request	ProcessGroupReplaceRequestDTO	optional	The Process Group Change Request
versionedFlowSnapshot	RegisteredFlowSnapshot	optional	Returns the Versioned Flow to replace with This property is read only.

Example JSON

{
    "processGroupRevision": RevisionDTO{…},
    "request": ProcessGroupReplaceRequestDTO{…},
    "versionedFlowSnapshot": RegisteredFlowSnapshot{…},
}

Close

ProcessGroupStatusDTO

Name	Type	Required	Description
id	string	optional	The ID of the Process Group
name	string	optional	The name of the Process Group
statsLastRefreshed	string	optional	The time the status for the process group was last refreshed.
aggregateSnapshot	ProcessGroupStatusSnapshotDTO	optional	The aggregate status of all nodes in the cluster
nodeSnapshots	array[NodeProcessGroupStatusSnapshotDTO]	optional	The status reported by each node in the cluster. If the NiFi instance is a standalone instance, rather than a clustered instance, this value may be null.

Example JSON

{
    "id": "value",
    "name": "value",
    "statsLastRefreshed": "value",
    "aggregateSnapshot": ProcessGroupStatusSnapshotDTO{…},
    "nodeSnapshots": [NodeProcessGroupStatusSnapshotDTO{…}],
}

Close

ProcessGroupStatusEntity

Name	Type	Required	Description
processGroupStatus	ProcessGroupStatusDTO	optional
canRead	boolean	optional	Indicates whether the user can read a given resource. This property is read only.

Example JSON

{
    "processGroupStatus": ProcessGroupStatusDTO{…},
    "canRead": true,
}

Close

ProcessGroupStatusSnapshotDTO

Name	Type	Required	Description
id	string	optional	The id of the process group.
name	string	optional	The name of this process group.
connectionStatusSnapshots	array[ConnectionStatusSnapshotEntity]	optional	The status of all connections in the process group.
processorStatusSnapshots	array[ProcessorStatusSnapshotEntity]	optional	The status of all processors in the process group.
processGroupStatusSnapshots	array[ProcessGroupStatusSnapshotEntity]	optional	The status of all process groups in the process group.
remoteProcessGroupStatusSnapshots	array[RemoteProcessGroupStatusSnapshotEntity]	optional	The status of all remote process groups in the process group.
inputPortStatusSnapshots	array[PortStatusSnapshotEntity]	optional	The status of all input ports in the process group.
outputPortStatusSnapshots	array[PortStatusSnapshotEntity]	optional	The status of all output ports in the process group.
versionedFlowState	string	optional	The current state of the Process Group, as it relates to the Versioned Flow Allowable values: LOCALLY_MODIFIED, STALE, LOCALLY_MODIFIED_AND_STALE, UP_TO_DATE, SYNC_FAILURE This property is read only.
flowFilesIn	integer (int32)	optional	The number of FlowFiles that have come into this ProcessGroup in the last 5 minutes
bytesIn	integer (int64)	optional	The number of bytes that have come into this ProcessGroup in the last 5 minutes
input	string	optional	The input count/size for the process group in the last 5 minutes (pretty printed).
flowFilesQueued	integer (int32)	optional	The number of FlowFiles that are queued up in this ProcessGroup right now
bytesQueued	integer (int64)	optional	The number of bytes that are queued up in this ProcessGroup right now
queued	string	optional	The count/size that is queued in the the process group.
queuedCount	string	optional	The count that is queued for the process group.
queuedSize	string	optional	The size that is queued for the process group.
bytesRead	integer (int64)	optional	The number of bytes read by components in this ProcessGroup in the last 5 minutes
read	string	optional	The number of bytes read in the last 5 minutes.
bytesWritten	integer (int64)	optional	The number of bytes written by components in this ProcessGroup in the last 5 minutes
written	string	optional	The number of bytes written in the last 5 minutes.
flowFilesOut	integer (int32)	optional	The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes
bytesOut	integer (int64)	optional	The number of bytes transferred out of this ProcessGroup in the last 5 minutes
output	string	optional	The output count/size for the process group in the last 5 minutes.
flowFilesTransferred	integer (int32)	optional	The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes
bytesTransferred	integer (int64)	optional	The number of bytes transferred in this ProcessGroup in the last 5 minutes
transferred	string	optional	The count/size transferred to/from queues in the process group in the last 5 minutes.
bytesReceived	integer (int64)	optional	The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes
flowFilesReceived	integer (int32)	optional	The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes
received	string	optional	The count/size sent to the process group in the last 5 minutes.
bytesSent	integer (int64)	optional	The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes
flowFilesSent	integer (int32)	optional	The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes
sent	string	optional	The count/size sent from this process group in the last 5 minutes.
activeThreadCount	integer (int32)	optional	The active thread count for this process group.
terminatedThreadCount	integer (int32)	optional	The number of threads currently terminated for the process group.
processingNanos	integer (int64)	optional
processingPerformanceStatus	ProcessingPerformanceStatusDTO	optional	Represents the processing performance for all the processors in the given process group.

Example JSON

{
    "id": "value",
    "name": "value",
    "connectionStatusSnapshots": [ConnectionStatusSnapshotEntity{…}],
    "processorStatusSnapshots": [ProcessorStatusSnapshotEntity{…}],
    "processGroupStatusSnapshots": [ProcessGroupStatusSnapshotEntity{…}],
    "remoteProcessGroupStatusSnapshots": [RemoteProcessGroupStatusSnapshotEntity{…}],
    "inputPortStatusSnapshots": [PortStatusSnapshotEntity{…}],
    "outputPortStatusSnapshots": [PortStatusSnapshotEntity{…}],
    "versionedFlowState": "value",
    "flowFilesIn": 0,
    "bytesIn": 0,
    "input": "value",
    "flowFilesQueued": 0,
    "bytesQueued": 0,
    "queued": "value",
    "queuedCount": "value",
    "queuedSize": "value",
    "bytesRead": 0,
    "read": "value",
    "bytesWritten": 0,
    "written": "value",
    "flowFilesOut": 0,
    "bytesOut": 0,
    "output": "value",
    "flowFilesTransferred": 0,
    "bytesTransferred": 0,
    "transferred": "value",
    "bytesReceived": 0,
    "flowFilesReceived": 0,
    "received": "value",
    "bytesSent": 0,
    "flowFilesSent": 0,
    "sent": "value",
    "activeThreadCount": 0,
    "terminatedThreadCount": 0,
    "processingNanos": 0,
    "processingPerformanceStatus": ProcessingPerformanceStatusDTO{…},
}

Close

ProcessGroupStatusSnapshotEntity

Name	Type	Required	Description
id	string	optional	The id of the process group.
processGroupStatusSnapshot	ProcessGroupStatusSnapshotDTO	optional
canRead	boolean	optional	Indicates whether the user can read a given resource. This property is read only.

Example JSON

{
    "id": "value",
    "processGroupStatusSnapshot": ProcessGroupStatusSnapshotDTO{…},
    "canRead": true,
}

Close

ProcessGroupsEntity

Name	Type	Required	Description
processGroups	array[ProcessGroupEntity]	optional

Example JSON

{
    "processGroups": [ProcessGroupEntity{…}],
}

Close

ProcessingPerformanceStatusDTO

Name	Type	Required	Description
identifier	string	optional	The unique ID of the process group that the Processor belongs to
cpuDuration	integer (int64)	optional	The number of nanoseconds has spent on CPU usage in the last 5 minutes.
contentReadDuration	integer (int64)	optional	The number of nanoseconds has spent to read content in the last 5 minutes.
contentWriteDuration	integer (int64)	optional	The number of nanoseconds has spent to write content in the last 5 minutes.
sessionCommitDuration	integer (int64)	optional	The number of nanoseconds has spent running to commit sessions the last 5 minutes.
garbageCollectionDuration	integer (int64)	optional	The number of nanoseconds has spent running garbage collection in the last 5 minutes.

Example JSON

{
    "identifier": "value",
    "cpuDuration": 0,
    "contentReadDuration": 0,
    "contentWriteDuration": 0,
    "sessionCommitDuration": 0,
    "garbageCollectionDuration": 0,
}

Close

ProcessorConfigDTO

Name	Type	Required	Description
properties	object	optional	The properties for the processor. Properties whose value is not set will only contain the property name.
descriptors	object	optional	Descriptors for the processor's properties.
sensitiveDynamicPropertyNames	array[string]	optional	Set of sensitive dynamic property names
schedulingPeriod	string	optional	The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy.
schedulingStrategy	string	optional	Indcates whether the prcessor should be scheduled to run in event or timer driven mode.
executionNode	string	optional	Indicates the node where the process will execute.
penaltyDuration	string	optional	The amount of time that is used when the process penalizes a flowfile.
yieldDuration	string	optional	The amount of time that must elapse before this processor is scheduled again after yielding.
bulletinLevel	string	optional	The level at which the processor will report bulletins.
runDurationMillis	integer (int64)	optional	The run duration for the processor in milliseconds.
concurrentlySchedulableTaskCount	integer (int32)	optional	The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored.
autoTerminatedRelationships	array[string]	optional	The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.
comments	string	optional	The comments for the processor.
customUiUrl	string	optional	The URL for the processor's custom configuration UI if applicable.
lossTolerant	boolean	optional	Whether the processor is loss tolerant.
annotationData	string	optional	The annotation data for the processor used to relay configuration between a custom UI and the procesosr.
defaultConcurrentTasks	object	optional	Maps default values for concurrent tasks for each applicable scheduling strategy.
defaultSchedulingPeriod	object	optional	Maps default values for scheduling period for each applicable scheduling strategy.
retryCount	integer (int32)	optional	Overall number of retries.
retriedRelationships	array[string]	optional	All the relationships should be retried.
backoffMechanism	string	optional	Determines whether the FlowFile should be penalized or the processor should be yielded between retries. Allowable values: PENALIZE_FLOWFILE, YIELD_PROCESSOR This property is read only.
maxBackoffPeriod	string	optional	Maximum amount of time to be waited during a retry period.

Example JSON

{
    "properties": {
        "name": "value"
    },
    "descriptors": {
        "name": PropertyDescriptorDTO{…}
    },
    "sensitiveDynamicPropertyNames": ["value"],
    "schedulingPeriod": "value",
    "schedulingStrategy": "value",
    "executionNode": "value",
    "penaltyDuration": "value",
    "yieldDuration": "value",
    "bulletinLevel": "value",
    "runDurationMillis": 0,
    "concurrentlySchedulableTaskCount": 0,
    "autoTerminatedRelationships": ["value"],
    "comments": "value",
    "customUiUrl": "value",
    "lossTolerant": true,
    "annotationData": "value",
    "defaultConcurrentTasks": {
        "name": "value"
    },
    "defaultSchedulingPeriod": {
        "name": "value"
    },
    "retryCount": 0,
    "retriedRelationships": ["value"],
    "backoffMechanism": "value",
    "maxBackoffPeriod": "value",
}

Close

ProcessorDTO

Name	Type	Required	Description
id	string	optional	The id of the component.
versionedComponentId	string	optional	The ID of the corresponding component that is under version control
parentGroupId	string	optional	The id of parent process group of this component if applicable.
position	PositionDTO	optional	The position of this component in the UI if applicable.
name	string	optional	The name of the processor.
type	string	optional	The type of the processor.
bundle	BundleDTO	optional	The details of the artifact that bundled this processor type.
state	string	optional	The state of the processor Allowable values: RUNNING, STOPPED, DISABLED
style	object	optional	Styles for the processor (background-color : #eee).
relationships	array[RelationshipDTO]	optional	The available relationships that the processor currently supports. This property is read only.
description	string	optional	The description of the processor.
supportsParallelProcessing	boolean	optional	Whether the processor supports parallel processing.
supportsEventDriven	boolean	optional	Whether the processor supports event driven scheduling.
supportsBatching	boolean	optional	Whether the processor supports batching. This makes the run duration settings available.
supportsSensitiveDynamicProperties	boolean	optional	Whether the processor supports sensitive dynamic properties.
persistsState	boolean	optional	Whether the processor persists state.
restricted	boolean	optional	Whether the processor requires elevated privileges.
deprecated	boolean	optional	Whether the processor has been deprecated.
executionNodeRestricted	boolean	optional	Indicates if the execution node of a processor is restricted to run only on the primary node
multipleVersionsAvailable	boolean	optional	Whether the processor has multiple versions available.
inputRequirement	string	optional	The input requirement for this processor.
config	ProcessorConfigDTO	optional	The configuration details for the processor. These details will be included in a response if the verbose flag is included in a request.
validationErrors	array[string]	optional	The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started.
validationStatus	string	optional	Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid) Allowable values: VALID, INVALID, VALIDATING This property is read only.
extensionMissing	boolean	optional	Whether the underlying extension is missing.

Example JSON

{
    "id": "value",
    "versionedComponentId": "value",
    "parentGroupId": "value",
    "position": PositionDTO{…},
    "name": "value",
    "type": "value",
    "bundle": BundleDTO{…},
    "state": "value",
    "style": {
        "name": "value"
    },
    "relationships": [RelationshipDTO{…}],
    "description": "value",
    "supportsParallelProcessing": true,
    "supportsEventDriven": true,
    "supportsBatching": true,
    "supportsSensitiveDynamicProperties": true,
    "persistsState": true,
    "restricted": true,
    "deprecated": true,
    "executionNodeRestricted": true,
    "multipleVersionsAvailable": true,
    "inputRequirement": "value",
    "config": ProcessorConfigDTO{…},
    "validationErrors": ["value"],
    "validationStatus": "value",
    "extensionMissing": true,
}

Close

ProcessorDefinition

Name	Type	Required	Description
group	string	optional	The group name of the bundle that provides the referenced type.
artifact	string	optional	The artifact name of the bundle that provides the referenced type.
version	string	optional	The version of the bundle that provides the referenced type.
type	string	required	The fully-qualified class type
typeDescription	string	optional	The description of the type.
buildInfo	BuildInfo	optional	The build metadata for this component
providedApiImplementations	array[DefinedType]	optional	If this type represents a provider for an interface, this lists the APIs it implements
tags	array[string]	optional	The tags associated with this type
seeAlso	array[string]	optional	The names of other component types that may be related
deprecated	boolean	optional	Whether or not the component has been deprecated
deprecationReason	string	optional	If this component has been deprecated, this optional field can be used to provide an explanation
deprecationAlternatives	array[string]	optional	If this component has been deprecated, this optional field provides alternatives to use
restricted	boolean	optional	Whether or not the component has a general restriction
restrictedExplanation	string	optional	An optional description of the general restriction
explicitRestrictions	array[Restriction]	optional	Explicit restrictions that indicate a require permission to use the component
stateful	Stateful	optional	Indicates if the component stores state
systemResourceConsiderations	array[SystemResourceConsideration]	optional	The system resource considerations for the given component
additionalDetails	boolean	optional	Indicates if the component has additional details documentation
propertyDescriptors	object	optional	Descriptions of configuration properties applicable to this component.
supportsDynamicProperties	boolean	optional	Whether or not this component makes use of dynamic (user-set) properties.
supportsSensitiveDynamicProperties	boolean	optional	Whether or not this component makes use of sensitive dynamic (user-set) properties.
dynamicProperties	array[DynamicProperty]	optional	Describes the dynamic properties supported by this component
inputRequirement	string	optional	Any input requirements this processor has. Allowable values: INPUT_REQUIRED, INPUT_ALLOWED, INPUT_FORBIDDEN
supportedRelationships	array[Relationship]	optional	The supported relationships for this processor.
supportsDynamicRelationships	boolean	optional	Whether or not this processor supports dynamic relationships.
dynamicRelationship	DynamicRelationship	optional	If the processor supports dynamic relationships, this describes the dynamic relationship
triggerSerially	boolean	optional	Whether or not this processor should be triggered serially (i.e. no concurrent execution).
triggerWhenEmpty	boolean	optional	Whether or not this processor should be triggered when incoming queues are empty.
triggerWhenAnyDestinationAvailable	boolean	optional	Whether or not this processor should be triggered when any destination queue has room.
supportsBatching	boolean	optional	Whether or not this processor supports batching. If a Processor uses this annotation, it allows the Framework to batch calls to session commits, as well as allowing the Framework to return the same session multiple times.
supportsEventDriven	boolean	optional	Whether or not this processor supports event driven scheduling. Indicates to the framework that the Processor is eligible to be scheduled to run based on the occurrence of an "Event" (e.g., when a FlowFile is enqueued in an incoming Connection), rather than being triggered periodically.
primaryNodeOnly	boolean	optional	Whether or not this processor should be scheduled only on the primary node in a cluster.
sideEffectFree	boolean	optional	Whether or not this processor is considered side-effect free. Side-effect free indicate that the processor's operations on FlowFiles can be safely repeated across process sessions.
supportedSchedulingStrategies	array[string]	optional	The supported scheduling strategies, such as TIME_DRIVER, CRON, or EVENT_DRIVEN.
defaultSchedulingStrategy	string	optional	The default scheduling strategy for the processor.
defaultConcurrentTasksBySchedulingStrategy	object	optional	The default concurrent tasks for each scheduling strategy.
defaultSchedulingPeriodBySchedulingStrategy	object	optional	The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as "30 sec".
defaultPenaltyDuration	string	optional	The default penalty duration as a time period, such as "30 sec".
defaultYieldDuration	string	optional	The default yield duration as a time period, such as "1 sec".
defaultBulletinLevel	string	optional	The default bulletin level, such as WARN, INFO, DEBUG, etc.
readsAttributes	array[Attribute]	optional	The FlowFile attributes this processor reads
writesAttributes	array[Attribute]	optional	The FlowFile attributes this processor writes/updates

Example JSON

{
    "group": "value",
    "artifact": "value",
    "version": "value",
    "type": "value",
    "typeDescription": "value",
    "buildInfo": BuildInfo{…},
    "providedApiImplementations": [DefinedType{…}],
    "tags": ["value"],
    "seeAlso": ["value"],
    "deprecated": true,
    "deprecationReason": "value",
    "deprecationAlternatives": ["value"],
    "restricted": true,
    "restrictedExplanation": "value",
    "explicitRestrictions": [Restriction{…}],
    "stateful": Stateful{…},
    "systemResourceConsiderations": [SystemResourceConsideration{…}],
    "additionalDetails": true,
    "propertyDescriptors": {
        "name": PropertyDescriptor{…}
    },
    "supportsDynamicProperties": true,
    "supportsSensitiveDynamicProperties": true,
    "dynamicProperties": [DynamicProperty{…}],
    "inputRequirement": "value",
    "supportedRelationships": [Relationship{…}],
    "supportsDynamicRelationships": true,
    "dynamicRelationship": DynamicRelationship{…},
    "triggerSerially": true,
    "triggerWhenEmpty": true,
    "triggerWhenAnyDestinationAvailable": true,
    "supportsBatching": true,
    "supportsEventDriven": true,
    "primaryNodeOnly": true,
    "sideEffectFree": true,
    "supportedSchedulingStrategies": ["value"],
    "defaultSchedulingStrategy": "value",
    "defaultConcurrentTasksBySchedulingStrategy": {
        "name": 0
    },
    "defaultSchedulingPeriodBySchedulingStrategy": {
        "name": "value"
    },
    "defaultPenaltyDuration": "value",
    "defaultYieldDuration": "value",
    "defaultBulletinLevel": "value",
    "readsAttributes": [Attribute{…}],
    "writesAttributes": [Attribute{…}],
}

Close

ProcessorDiagnosticsDTO

Name	Type	Required	Description
processor	ProcessorDTO	optional	Information about the Processor for which the Diagnostic Report is generated
processorStatus	ProcessorStatusDTO	optional	The Status for the Processor for which the Diagnostic Report is generated
referencedControllerServices	array[ControllerServiceDiagnosticsDTO]	optional	Diagnostic Information about all Controller Services that the Processor is referencing
incomingConnections	array[ConnectionDiagnosticsDTO]	optional	Diagnostic Information about all incoming Connections
outgoingConnections	array[ConnectionDiagnosticsDTO]	optional	Diagnostic Information about all outgoing Connections
jvmDiagnostics	JVMDiagnosticsDTO	optional	Diagnostic Information about the JVM and system-level diagnostics
threadDumps	array[ThreadDumpDTO]	optional	Thread Dumps that were taken of the threads that are active in the Processor
classLoaderDiagnostics	ClassLoaderDiagnosticsDTO	optional	Information about the Controller Service's Class Loader

Example JSON

{
    "processor": ProcessorDTO{…},
    "processorStatus": ProcessorStatusDTO{…},
    "referencedControllerServices": [ControllerServiceDiagnosticsDTO{…}],
    "incomingConnections": [ConnectionDiagnosticsDTO{…}],
    "outgoingConnections": [ConnectionDiagnosticsDTO{…}],
    "jvmDiagnostics": JVMDiagnosticsDTO{…},
    "threadDumps": [ThreadDumpDTO{…}],
    "classLoaderDiagnostics": ClassLoaderDiagnosticsDTO{…},
}

Close

ProcessorDiagnosticsEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
component	ProcessorDiagnosticsDTO	optional	The Processor Diagnostics

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "component": ProcessorDiagnosticsDTO{…},
}

Close

ProcessorEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
component	ProcessorDTO	optional
inputRequirement	string	optional	The input requirement for this processor.
status	ProcessorStatusDTO	optional
operatePermissions	PermissionsDTO	optional	The permissions for this component operations.

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "component": ProcessorDTO{…},
    "inputRequirement": "value",
    "status": ProcessorStatusDTO{…},
    "operatePermissions": PermissionsDTO{…},
}

Close

ProcessorRunStatusDetailsDTO

Name	Type	Required	Description
id	string	optional	The ID of the processor
name	string	optional	The name of the processor
runStatus	string	optional	The run status of the processor Allowable values: Running, Stopped, Invalid, Validating, Disabled
validationErrors	array[string]	optional	The processor's validation errors
activeThreadCount	integer (int32)	optional	The current number of threads that the processor is currently using

Example JSON

{
    "id": "value",
    "name": "value",
    "runStatus": "value",
    "validationErrors": ["value"],
    "activeThreadCount": 0,
}

Close

ProcessorRunStatusDetailsEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for the Processor.
permissions	PermissionsDTO	optional	The permissions for the Processor.
runStatusDetails	ProcessorRunStatusDetailsDTO	optional	The details of a Processor's run status

Example JSON

{
    "revision": RevisionDTO{…},
    "permissions": PermissionsDTO{…},
    "runStatusDetails": ProcessorRunStatusDetailsDTO{…},
}

Close

ProcessorRunStatusEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
state	string	optional	The run status of the Processor. Allowable values: RUNNING, STOPPED, DISABLED, RUN_ONCE
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Example JSON

{
    "revision": RevisionDTO{…},
    "state": "value",
    "disconnectedNodeAcknowledged": true,
}

Close

ProcessorStatusDTO

Name	Type	Required	Description
groupId	string	optional	The unique ID of the process group that the Processor belongs to
id	string	optional	The unique ID of the Processor
name	string	optional	The name of the Processor
type	string	optional	The type of the Processor
runStatus	string	optional	The run status of the Processor Allowable values: Running, Stopped, Validating, Disabled, Invalid
statsLastRefreshed	string	optional	The timestamp of when the stats were last refreshed
aggregateSnapshot	ProcessorStatusSnapshotDTO	optional	A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.
nodeSnapshots	array[NodeProcessorStatusSnapshotDTO]	optional	A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.

Example JSON

{
    "groupId": "value",
    "id": "value",
    "name": "value",
    "type": "value",
    "runStatus": "value",
    "statsLastRefreshed": "value",
    "aggregateSnapshot": ProcessorStatusSnapshotDTO{…},
    "nodeSnapshots": [NodeProcessorStatusSnapshotDTO{…}],
}

Close

ProcessorStatusEntity

Name	Type	Required	Description
processorStatus	ProcessorStatusDTO	optional
canRead	boolean	optional	Indicates whether the user can read a given resource. This property is read only.

Example JSON

{
    "processorStatus": ProcessorStatusDTO{…},
    "canRead": true,
}

Close

ProcessorStatusSnapshotDTO

Name	Type	Required	Description
id	string	optional	The id of the processor.
groupId	string	optional	The id of the parent process group to which the processor belongs.
name	string	optional	The name of the prcessor.
type	string	optional	The type of the processor.
runStatus	string	optional	The state of the processor. Allowable values: Running, Stopped, Validating, Disabled, Invalid
executionNode	string	optional	Indicates the node where the process will execute. Allowable values: ALL, PRIMARY
bytesRead	integer (int64)	optional	The number of bytes read by this Processor in the last 5 mintues
bytesWritten	integer (int64)	optional	The number of bytes written by this Processor in the last 5 minutes
read	string	optional	The number of bytes read in the last 5 minutes.
written	string	optional	The number of bytes written in the last 5 minutes.
flowFilesIn	integer (int32)	optional	The number of FlowFiles that have been accepted in the last 5 minutes
bytesIn	integer (int64)	optional	The size of the FlowFiles that have been accepted in the last 5 minutes
input	string	optional	The count/size of flowfiles that have been accepted in the last 5 minutes.
flowFilesOut	integer (int32)	optional	The number of FlowFiles transferred to a Connection in the last 5 minutes
bytesOut	integer (int64)	optional	The size of the FlowFiles transferred to a Connection in the last 5 minutes
output	string	optional	The count/size of flowfiles that have been processed in the last 5 minutes.
taskCount	integer (int32)	optional	The number of times this Processor has run in the last 5 minutes
tasksDurationNanos	integer (int64)	optional	The number of nanoseconds that this Processor has spent running in the last 5 minutes
tasks	string	optional	The total number of task this connectable has completed over the last 5 minutes.
tasksDuration	string	optional	The total duration of all tasks for this connectable over the last 5 minutes.
activeThreadCount	integer (int32)	optional	The number of threads currently executing in the processor.
terminatedThreadCount	integer (int32)	optional	The number of threads currently terminated for the processor.
processingPerformanceStatus	ProcessingPerformanceStatusDTO	optional	Represents the processor's processing performance.

Example JSON

{
    "id": "value",
    "groupId": "value",
    "name": "value",
    "type": "value",
    "runStatus": "value",
    "executionNode": "value",
    "bytesRead": 0,
    "bytesWritten": 0,
    "read": "value",
    "written": "value",
    "flowFilesIn": 0,
    "bytesIn": 0,
    "input": "value",
    "flowFilesOut": 0,
    "bytesOut": 0,
    "output": "value",
    "taskCount": 0,
    "tasksDurationNanos": 0,
    "tasks": "value",
    "tasksDuration": "value",
    "activeThreadCount": 0,
    "terminatedThreadCount": 0,
    "processingPerformanceStatus": ProcessingPerformanceStatusDTO{…},
}

Close

ProcessorStatusSnapshotEntity

Name	Type	Required	Description
id	string	optional	The id of the processor.
processorStatusSnapshot	ProcessorStatusSnapshotDTO	optional
canRead	boolean	optional	Indicates whether the user can read a given resource. This property is read only.

Example JSON

{
    "id": "value",
    "processorStatusSnapshot": ProcessorStatusSnapshotDTO{…},
    "canRead": true,
}

Close

ProcessorTypesEntity

Name	Type	Required	Description
processorTypes	array[DocumentedTypeDTO]	optional

Example JSON

{
    "processorTypes": [DocumentedTypeDTO{…}],
}

Close

ProcessorsEntity

Name	Type	Required	Description
processors	array[ProcessorEntity]	optional

Example JSON

{
    "processors": [ProcessorEntity{…}],
}

Close

ProcessorsRunStatusDetailsEntity

Name	Type	Required	Description
runStatusDetails	array[ProcessorRunStatusDetailsEntity]	optional

Example JSON

{
    "runStatusDetails": [ProcessorRunStatusDetailsEntity{…}],
}

Close

PropertyAllowableValue

Name	Type	Required	Description
value	string	required	The internal value
displayName	string	optional	The display name of the value, if different from the internal value
description	string	optional	The description of the value, e.g., the behavior it produces.

Example JSON

{
    "value": "value",
    "displayName": "value",
    "description": "value",
}

Close

PropertyDependency

Name	Type	Required	Description
propertyName	string	optional	The name of the property that is depended upon
propertyDisplayName	string	optional	The name of the property that is depended upon
dependentValues	array[string]	optional	The values that satisfy the dependency

Example JSON

{
    "propertyName": "value",
    "propertyDisplayName": "value",
    "dependentValues": ["value"],
}

Close

PropertyDependencyDTO

Name	Type	Required	Description
propertyName	string	optional	The name of the property that is being depended upon
dependentValues	array[string]	optional	The values for the property that satisfies the dependency, or null if the dependency is satisfied by the presence of any value for the associated property name

Example JSON

{
    "propertyName": "value",
    "dependentValues": ["value"],
}

Close

PropertyDescriptor

Name	Type	Required	Description
name	string	required	The name of the property key
displayName	string	optional	The display name of the property key, if different from the name
description	string	optional	The description of what the property does
allowableValues	array[PropertyAllowableValue]	optional	A list of the allowable values for the property
defaultValue	string	optional	The default value if a user-set value is not specified
required	boolean	optional	Whether or not the property is required for the component
sensitive	boolean	optional	Whether or not the value of the property is considered sensitive (e.g., passwords and keys)
expressionLanguageScope	string	optional	The scope of expression language supported by this property Allowable values: NONE, VARIABLE_REGISTRY, FLOWFILE_ATTRIBUTES
expressionLanguageScopeDescription	string	optional	The description of the expression language scope supported by this property This property is read only.
typeProvidedByValue	DefinedType	optional	Indicates that this property is for selecting a controller service of the specified type
validRegex	string	optional	A regular expression that can be used to validate the value of this property
validator	string	optional	Name of the validator used for this property descriptor
dynamic	boolean	optional	Whether or not the descriptor is for a dynamically added property
resourceDefinition	PropertyResourceDefinition	optional	Indicates that this property references external resources
dependencies	array[PropertyDependency]	optional	The dependencies that this property has on other properties

Example JSON

{
    "name": "value",
    "displayName": "value",
    "description": "value",
    "allowableValues": [PropertyAllowableValue{…}],
    "defaultValue": "value",
    "required": true,
    "sensitive": true,
    "expressionLanguageScope": "value",
    "expressionLanguageScopeDescription": "value",
    "typeProvidedByValue": DefinedType{…},
    "validRegex": "value",
    "validator": "value",
    "dynamic": true,
    "resourceDefinition": PropertyResourceDefinition{…},
    "dependencies": [PropertyDependency{…}],
}

Close

PropertyDescriptorDTO

Name	Type	Required	Description
name	string	optional	The name for the property.
displayName	string	optional	The human readable name for the property.
description	string	optional	The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent.
defaultValue	string	optional	The default value for the property.
allowableValues	array[AllowableValueEntity]	optional	Allowable values for the property. If empty then the allowed values are not constrained.
required	boolean	optional	Whether the property is required.
sensitive	boolean	optional	Whether the property is sensitive and protected whenever stored or represented.
dynamic	boolean	optional	Whether the property is dynamic (user-defined).
supportsEl	boolean	optional	Whether the property supports expression language.
expressionLanguageScope	string	optional	Scope of the Expression Language evaluation for the property.
identifiesControllerService	string	optional	If the property identifies a controller service this returns the fully qualified type.
identifiesControllerServiceBundle	BundleDTO	optional	If the property identifies a controller service this returns the bundle of the type, null otherwise.
dependencies	array[PropertyDependencyDTO]	optional	A list of dependencies that must be met in order for this Property to be relevant. If any of these dependencies is not met, the property described by this Property Descriptor is not relevant.

Example JSON

{
    "name": "value",
    "displayName": "value",
    "description": "value",
    "defaultValue": "value",
    "allowableValues": [AllowableValueEntity{…}],
    "required": true,
    "sensitive": true,
    "dynamic": true,
    "supportsEl": true,
    "expressionLanguageScope": "value",
    "identifiesControllerService": "value",
    "identifiesControllerServiceBundle": BundleDTO{…},
    "dependencies": [PropertyDependencyDTO{…}],
}

Close

PropertyDescriptorEntity

Name	Type	Required	Description
propertyDescriptor	PropertyDescriptorDTO	optional

Example JSON

{
    "propertyDescriptor": PropertyDescriptorDTO{…},
}

Close

PropertyHistoryDTO

Name	Type	Required	Description
previousValues	array[PreviousValueDTO]	optional	Previous values for a given property.

Example JSON

{
    "previousValues": [PreviousValueDTO{…}],
}

Close

PropertyResourceDefinition

Name	Type	Required	Description
cardinality	string	optional	The cardinality of the resource definition (i.e. single or multiple) Allowable values: SINGLE, MULTIPLE
resourceTypes	array[string]	optional	The types of resources that can be referenced

Example JSON

{
    "cardinality": "value",
    "resourceTypes": ["value"],
}

Close

ProvenanceDTO

Name	Type	Required	Description
id	string	optional	The id of the provenance query.
uri	string	optional	The URI for this query. Used for obtaining/deleting the request at a later time
submissionTime	string	optional	The timestamp when the query was submitted.
expiration	string	optional	The timestamp when the query will expire.
percentCompleted	integer (int32)	optional	The current percent complete.
finished	boolean	optional	Whether the query has finished.
request	ProvenanceRequestDTO	optional	The provenance request.
results	ProvenanceResultsDTO	optional	The provenance results.

Example JSON

{
    "id": "value",
    "uri": "value",
    "submissionTime": "value",
    "expiration": "value",
    "percentCompleted": 0,
    "finished": true,
    "request": ProvenanceRequestDTO{…},
    "results": ProvenanceResultsDTO{…},
}

Close

ProvenanceEntity

Name	Type	Required	Description
provenance	ProvenanceDTO	optional

Example JSON

{
    "provenance": ProvenanceDTO{…},
}

Close

ProvenanceEventDTO

Name	Type	Required	Description
id	string	optional	The event uuid.
eventId	integer (int64)	optional	The event id. This is a one up number thats unique per node.
eventTime	string	optional	The timestamp of the event.
eventDuration	integer (int64)	optional	The event duration in milliseconds.
lineageDuration	integer (int64)	optional	The duration since the lineage began, in milliseconds.
eventType	string	optional	The type of the event.
flowFileUuid	string	optional	The uuid of the flowfile for the event.
fileSize	string	optional	The size of the flowfile for the event.
fileSizeBytes	integer (int64)	optional	The size of the flowfile in bytes for the event.
clusterNodeId	string	optional	The identifier for the node where the event originated.
clusterNodeAddress	string	optional	The label for the node where the event originated.
groupId	string	optional	The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set.
componentId	string	optional	The id of the component that generated the event.
componentType	string	optional	The type of the component that generated the event.
componentName	string	optional	The name of the component that generated the event.
sourceSystemFlowFileId	string	optional	The source system flowfile id.
alternateIdentifierUri	string	optional	The alternate identifier uri for the fileflow for the event.
attributes	array[AttributeDTO]	optional	The attributes of the flowfile for the event.
parentUuids	array[string]	optional	The parent uuids for the event.
childUuids	array[string]	optional	The child uuids for the event.
transitUri	string	optional	The source/destination system uri if the event was a RECEIVE/SEND.
relationship	string	optional	The relationship to which the flowfile was routed if the event is of type ROUTE.
details	string	optional	The event details.
contentEqual	boolean	optional	Whether the input and output content claim is the same.
inputContentAvailable	boolean	optional	Whether the input content is still available.
inputContentClaimSection	string	optional	The section in which the input content claim lives.
inputContentClaimContainer	string	optional	The container in which the input content claim lives.
inputContentClaimIdentifier	string	optional	The identifier of the input content claim.
inputContentClaimOffset	integer (int64)	optional	The offset into the input content claim where the flowfiles content begins.
inputContentClaimFileSize	string	optional	The file size of the input content claim formatted.
inputContentClaimFileSizeBytes	integer (int64)	optional	The file size of the intput content claim in bytes.
outputContentAvailable	boolean	optional	Whether the output content is still available.
outputContentClaimSection	string	optional	The section in which the output content claim lives.
outputContentClaimContainer	string	optional	The container in which the output content claim lives.
outputContentClaimIdentifier	string	optional	The identifier of the output content claim.
outputContentClaimOffset	integer (int64)	optional	The offset into the output content claim where the flowfiles content begins.
outputContentClaimFileSize	string	optional	The file size of the output content claim formatted.
outputContentClaimFileSizeBytes	integer (int64)	optional	The file size of the output content claim in bytes.
replayAvailable	boolean	optional	Whether or not replay is available.
replayExplanation	string	optional	Explanation as to why replay is unavailable.
sourceConnectionIdentifier	string	optional	The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event.

Example JSON

{
    "id": "value",
    "eventId": 0,
    "eventTime": "value",
    "eventDuration": 0,
    "lineageDuration": 0,
    "eventType": "value",
    "flowFileUuid": "value",
    "fileSize": "value",
    "fileSizeBytes": 0,
    "clusterNodeId": "value",
    "clusterNodeAddress": "value",
    "groupId": "value",
    "componentId": "value",
    "componentType": "value",
    "componentName": "value",
    "sourceSystemFlowFileId": "value",
    "alternateIdentifierUri": "value",
    "attributes": [AttributeDTO{…}],
    "parentUuids": ["value"],
    "childUuids": ["value"],
    "transitUri": "value",
    "relationship": "value",
    "details": "value",
    "contentEqual": true,
    "inputContentAvailable": true,
    "inputContentClaimSection": "value",
    "inputContentClaimContainer": "value",
    "inputContentClaimIdentifier": "value",
    "inputContentClaimOffset": 0,
    "inputContentClaimFileSize": "value",
    "inputContentClaimFileSizeBytes": 0,
    "outputContentAvailable": true,
    "outputContentClaimSection": "value",
    "outputContentClaimContainer": "value",
    "outputContentClaimIdentifier": "value",
    "outputContentClaimOffset": 0,
    "outputContentClaimFileSize": "value",
    "outputContentClaimFileSizeBytes": 0,
    "replayAvailable": true,
    "replayExplanation": "value",
    "sourceConnectionIdentifier": "value",
}

Close

ProvenanceEventEntity

Name	Type	Required	Description
provenanceEvent	ProvenanceEventDTO	optional

Example JSON

{
    "provenanceEvent": ProvenanceEventDTO{…},
}

Close

ProvenanceLinkDTO

Name	Type	Required	Description
sourceId	string	optional	The source node id of the link.
targetId	string	optional	The target node id of the link.
flowFileUuid	string	optional	The flowfile uuid that traversed the link.
timestamp	string	optional	The timestamp of the link (based on the destination).
millis	integer (int64)	optional	The timestamp of this link in milliseconds.

Example JSON

{
    "sourceId": "value",
    "targetId": "value",
    "flowFileUuid": "value",
    "timestamp": "value",
    "millis": 0,
}

Close

ProvenanceNodeDTO

Name	Type	Required	Description
id	string	optional	The id of the node.
flowFileUuid	string	optional	The uuid of the flowfile associated with the provenance event.
parentUuids	array[string]	optional	The uuid of the parent flowfiles of the provenance event.
childUuids	array[string]	optional	The uuid of the childrent flowfiles of the provenance event.
clusterNodeIdentifier	string	optional	The identifier of the node that this event/flowfile originated from.
type	string	optional	The type of the node. Allowable values: FLOWFILE, EVENT
eventType	string	optional	If the type is EVENT, this is the type of event.
millis	integer (int64)	optional	The timestamp of the node in milliseconds.
timestamp	string	optional	The timestamp of the node formatted.

Example JSON

{
    "id": "value",
    "flowFileUuid": "value",
    "parentUuids": ["value"],
    "childUuids": ["value"],
    "clusterNodeIdentifier": "value",
    "type": "value",
    "eventType": "value",
    "millis": 0,
    "timestamp": "value",
}

Close

ProvenanceOptionsDTO

Name	Type	Required	Description
searchableFields	array[ProvenanceSearchableFieldDTO]	optional	The available searchable field for the NiFi.

Example JSON

{
    "searchableFields": [ProvenanceSearchableFieldDTO{…}],
}

Close

ProvenanceOptionsEntity

Name	Type	Required	Description
provenanceOptions	ProvenanceOptionsDTO	optional

Example JSON

{
    "provenanceOptions": ProvenanceOptionsDTO{…},
}

Close

ProvenanceRequestDTO

Name	Type	Required	Description
searchTerms	object	optional	The search terms used to perform the search.
clusterNodeId	string	optional	The id of the node in the cluster where this provenance originated.
startDate	string	optional	The earliest event time to include in the query.
endDate	string	optional	The latest event time to include in the query.
minimumFileSize	string	optional	The minimum file size to include in the query.
maximumFileSize	string	optional	The maximum file size to include in the query.
maxResults	integer (int32)	optional	The maximum number of results to include.
summarize	boolean	optional	Whether or not to summarize provenance events returned. This property is false by default.
incrementalResults	boolean	optional	Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.

Example JSON

{
    "searchTerms": {
        "name": ProvenanceSearchValueDTO{…}
    },
    "clusterNodeId": "value",
    "startDate": "value",
    "endDate": "value",
    "minimumFileSize": "value",
    "maximumFileSize": "value",
    "maxResults": 0,
    "summarize": true,
    "incrementalResults": true,
}

Close

ProvenanceResultsDTO

Name	Type	Required	Description
provenanceEvents	array[ProvenanceEventDTO]	optional	The provenance events that matched the search criteria.
total	string	optional	The total number of results formatted.
totalCount	integer (int64)	optional	The total number of results.
generated	string	optional	Then the search was performed.
oldestEvent	string	optional	The oldest event available in the provenance repository.
timeOffset	integer (int32)	optional	The time offset of the server that's used for event time.
errors	array[string]	optional	Any errors that occurred while performing the provenance request.

Example JSON

{
    "provenanceEvents": [ProvenanceEventDTO{…}],
    "total": "value",
    "totalCount": 0,
    "generated": "value",
    "oldestEvent": "value",
    "timeOffset": 0,
    "errors": ["value"],
}

Close

ProvenanceSearchValueDTO

Name	Type	Required	Description
value	string	optional	The search value.
inverse	boolean	optional	Query for all except for search value.

Example JSON

{
    "value": "value",
    "inverse": true,
}

Close

ProvenanceSearchableFieldDTO

Name	Type	Required	Description
id	string	optional	The id of the searchable field.
field	string	optional	The searchable field.
label	string	optional	The label for the searchable field.
type	string	optional	The type of the searchable field.

Example JSON

{
    "id": "value",
    "field": "value",
    "label": "value",
    "type": "value",
}

Close

QueueSizeDTO

Name	Type	Required	Description
byteCount	integer (int64)	optional	The size of objects in a queue.
objectCount	integer (int32)	optional	The count of objects in a queue.

Example JSON

{
    "byteCount": 0,
    "objectCount": 0,
}

Close

RegisteredFlow

Name	Type	Required
identifier	string	optional
name	string	optional
description	string	optional
bucketIdentifier	string	optional
bucketName	string	optional
createdTimestamp	integer (int64)	optional
lastModifiedTimestamp	integer (int64)	optional
permissions	FlowRegistryPermissions	optional
versionCount	integer (int64)	optional
versionInfo	RegisteredFlowVersionInfo	optional

Example JSON

{
    "identifier": "value",
    "name": "value",
    "description": "value",
    "bucketIdentifier": "value",
    "bucketName": "value",
    "createdTimestamp": 0,
    "lastModifiedTimestamp": 0,
    "permissions": FlowRegistryPermissions{…},
    "versionCount": 0,
    "versionInfo": RegisteredFlowVersionInfo{…},
}

Close

RegisteredFlowSnapshot

Name	Type	Required
snapshotMetadata	RegisteredFlowSnapshotMetadata	optional
flow	RegisteredFlow	optional
bucket	FlowRegistryBucket	optional
flowContents	VersionedProcessGroup	optional
externalControllerServices	object	optional
parameterContexts	object	optional
flowEncodingVersion	string	optional
parameterProviders	object	optional
latest	boolean	optional

Example JSON

{
    "snapshotMetadata": RegisteredFlowSnapshotMetadata{…},
    "flow": RegisteredFlow{…},
    "bucket": FlowRegistryBucket{…},
    "flowContents": VersionedProcessGroup{…},
    "externalControllerServices": {
        "name": ExternalControllerServiceReference{…}
    },
    "parameterContexts": {
        "name": VersionedParameterContext{…}
    },
    "flowEncodingVersion": "value",
    "parameterProviders": {
        "name": ParameterProviderReference{…}
    },
    "latest": true,
}

Close

RegisteredFlowSnapshotMetadata

Name	Type	Required
bucketIdentifier	string	optional
flowIdentifier	string	optional
version	integer (int32)	optional
timestamp	integer (int64)	optional
author	string	optional
comments	string	optional

Example JSON

{
    "bucketIdentifier": "value",
    "flowIdentifier": "value",
    "version": 0,
    "timestamp": 0,
    "author": "value",
    "comments": "value",
}

Close

RegisteredFlowVersionInfo

Name	Type	Required	Description
version	integer (int64)	optional

Example JSON

{
    "version": 0,
}

Close

Relationship

Name	Type	Required	Description
name	string	optional	The name of the relationship
description	string	optional	The description of the relationship

Example JSON

{
    "name": "value",
    "description": "value",
}

Close

RelationshipDTO

Name	Type	Required	Description
name	string	optional	The relationship name.
description	string	optional	The relationship description.
autoTerminate	boolean	optional	Whether or not flowfiles sent to this relationship should auto terminate.
retry	boolean	optional	Whether or not flowfiles sent to this relationship should retry.

Example JSON

{
    "name": "value",
    "description": "value",
    "autoTerminate": true,
    "retry": true,
}

Close

RemotePortRunStatusEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
state	string	optional	The run status of the RemotePort. Allowable values: TRANSMITTING, STOPPED
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Example JSON

{
    "revision": RevisionDTO{…},
    "state": "value",
    "disconnectedNodeAcknowledged": true,
}

Close

RemoteProcessGroupContentsDTO

Name	Type	Required	Description
inputPorts	array[RemoteProcessGroupPortDTO]	optional	The input ports to which data can be sent.
outputPorts	array[RemoteProcessGroupPortDTO]	optional	The output ports from which data can be retrieved.

Example JSON

{
    "inputPorts": [RemoteProcessGroupPortDTO{…}],
    "outputPorts": [RemoteProcessGroupPortDTO{…}],
}

Close

RemoteProcessGroupDTO

Name	Type	Required	Description
id	string	optional	The id of the component.
versionedComponentId	string	optional	The ID of the corresponding component that is under version control
parentGroupId	string	optional	The id of parent process group of this component if applicable.
position	PositionDTO	optional	The position of this component in the UI if applicable.
targetUri	string	optional	The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first url in the urls. If neither target uri nor uris are set, then returns null.
targetUris	string	optional	The target URI of the remote process group. If target uris is not set but target uri is set, then returns a collection containing the single target uri. If neither target uris nor uris are set, then returns null.
targetSecure	boolean	optional	Whether the target is running securely.
name	string	optional	The name of the remote process group.
comments	string	optional	The comments for the remote process group.
communicationsTimeout	string	optional	The time period used for the timeout when communicating with the target.
yieldDuration	string	optional	When yielding, this amount of time must elapse before the remote process group is scheduled again.
transportProtocol	string	optional
localNetworkInterface	string	optional	The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier.
proxyHost	string	optional
proxyPort	integer (int32)	optional
proxyUser	string	optional
proxyPassword	string	optional
authorizationIssues	array[string]	optional	Any remote authorization issues for the remote process group.
validationErrors	array[string]	optional	The validation errors for the remote process group. These validation errors represent the problems with the remote process group that must be resolved before it can transmit.
transmitting	boolean	optional	Whether the remote process group is actively transmitting.
inputPortCount	integer (int32)	optional	The number of remote input ports currently available on the target.
outputPortCount	integer (int32)	optional	The number of remote output ports currently available on the target.
activeRemoteInputPortCount	integer (int32)	optional	The number of active remote input ports.
inactiveRemoteInputPortCount	integer (int32)	optional	The number of inactive remote input ports.
activeRemoteOutputPortCount	integer (int32)	optional	The number of active remote output ports.
inactiveRemoteOutputPortCount	integer (int32)	optional	The number of inactive remote output ports.
flowRefreshed	string	optional	The timestamp when this remote process group was last refreshed.
contents	RemoteProcessGroupContentsDTO	optional	The contents of the remote process group. Will contain available input/output ports.

Example JSON

{
    "id": "value",
    "versionedComponentId": "value",
    "parentGroupId": "value",
    "position": PositionDTO{…},
    "targetUri": "value",
    "targetUris": "value",
    "targetSecure": true,
    "name": "value",
    "comments": "value",
    "communicationsTimeout": "value",
    "yieldDuration": "value",
    "transportProtocol": "value",
    "localNetworkInterface": "value",
    "proxyHost": "value",
    "proxyPort": 0,
    "proxyUser": "value",
    "proxyPassword": "value",
    "authorizationIssues": ["value"],
    "validationErrors": ["value"],
    "transmitting": true,
    "inputPortCount": 0,
    "outputPortCount": 0,
    "activeRemoteInputPortCount": 0,
    "inactiveRemoteInputPortCount": 0,
    "activeRemoteOutputPortCount": 0,
    "inactiveRemoteOutputPortCount": 0,
    "flowRefreshed": "value",
    "contents": RemoteProcessGroupContentsDTO{…},
}

Close

RemoteProcessGroupEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
component	RemoteProcessGroupDTO	optional
status	RemoteProcessGroupStatusDTO	optional	The status of the remote process group.
inputPortCount	integer (int32)	optional	The number of remote input ports currently available on the target.
outputPortCount	integer (int32)	optional	The number of remote output ports currently available on the target.
operatePermissions	PermissionsDTO	optional	The permissions for this component operations.

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "component": RemoteProcessGroupDTO{…},
    "status": RemoteProcessGroupStatusDTO{…},
    "inputPortCount": 0,
    "outputPortCount": 0,
    "operatePermissions": PermissionsDTO{…},
}

Close

RemoteProcessGroupPortDTO

Name	Type	Required	Description
id	string	optional	The id of the port.
targetId	string	optional	The id of the target port.
versionedComponentId	string	optional	The ID of the corresponding component that is under version control
groupId	string	optional	The id of the remote process group that the port resides in.
name	string	optional	The name of the target port.
comments	string	optional	The comments as configured on the target port.
concurrentlySchedulableTaskCount	integer (int32)	optional	The number of task that may transmit flowfiles to the target port concurrently.
transmitting	boolean	optional	Whether the remote port is configured for transmission.
useCompression	boolean	optional	Whether the flowfiles are compressed when sent to the target port.
exists	boolean	optional	Whether the target port exists.
targetRunning	boolean	optional	Whether the target port is running.
connected	boolean	optional	Whether the port has either an incoming or outgoing connection.
batchSettings	BatchSettingsDTO	optional	The batch settings for data transmission.

Example JSON

{
    "id": "value",
    "targetId": "value",
    "versionedComponentId": "value",
    "groupId": "value",
    "name": "value",
    "comments": "value",
    "concurrentlySchedulableTaskCount": 0,
    "transmitting": true,
    "useCompression": true,
    "exists": true,
    "targetRunning": true,
    "connected": true,
    "batchSettings": BatchSettingsDTO{…},
}

Close

RemoteProcessGroupPortEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
remoteProcessGroupPort	RemoteProcessGroupPortDTO	optional
operatePermissions	PermissionsDTO	optional	The permissions for this component operations.

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "remoteProcessGroupPort": RemoteProcessGroupPortDTO{…},
    "operatePermissions": PermissionsDTO{…},
}

Close

RemoteProcessGroupStatusDTO

Name	Type	Required	Description
groupId	string	optional	The unique ID of the process group that the Processor belongs to
id	string	optional	The unique ID of the Processor
name	string	optional	The name of the remote process group.
targetUri	string	optional	The URI of the target system.
transmissionStatus	string	optional	The transmission status of the remote process group.
statsLastRefreshed	string	optional	The time the status for the process group was last refreshed.
validationStatus	string	optional	Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid) Allowable values: VALID, INVALID, VALIDATING This property is read only.
aggregateSnapshot	RemoteProcessGroupStatusSnapshotDTO	optional	A status snapshot that represents the aggregate stats of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.
nodeSnapshots	array[NodeRemoteProcessGroupStatusSnapshotDTO]	optional	A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.

Example JSON

{
    "groupId": "value",
    "id": "value",
    "name": "value",
    "targetUri": "value",
    "transmissionStatus": "value",
    "statsLastRefreshed": "value",
    "validationStatus": "value",
    "aggregateSnapshot": RemoteProcessGroupStatusSnapshotDTO{…},
    "nodeSnapshots": [NodeRemoteProcessGroupStatusSnapshotDTO{…}],
}

Close

RemoteProcessGroupStatusEntity

Name	Type	Required	Description
remoteProcessGroupStatus	RemoteProcessGroupStatusDTO	optional
canRead	boolean	optional	Indicates whether the user can read a given resource. This property is read only.

Example JSON

{
    "remoteProcessGroupStatus": RemoteProcessGroupStatusDTO{…},
    "canRead": true,
}

Close

RemoteProcessGroupStatusSnapshotDTO

Name	Type	Required	Description
id	string	optional	The id of the remote process group.
groupId	string	optional	The id of the parent process group the remote process group resides in.
name	string	optional	The name of the remote process group.
targetUri	string	optional	The URI of the target system.
transmissionStatus	string	optional	The transmission status of the remote process group.
activeThreadCount	integer (int32)	optional	The number of active threads for the remote process group.
flowFilesSent	integer (int32)	optional	The number of FlowFiles sent to the remote process group in the last 5 minutes.
bytesSent	integer (int64)	optional	The size of the FlowFiles sent to the remote process group in the last 5 minutes.
sent	string	optional	The count/size of the flowfiles sent to the remote process group in the last 5 minutes.
flowFilesReceived	integer (int32)	optional	The number of FlowFiles received from the remote process group in the last 5 minutes.
bytesReceived	integer (int64)	optional	The size of the FlowFiles received from the remote process group in the last 5 minutes.
received	string	optional	The count/size of the flowfiles received from the remote process group in the last 5 minutes.

Example JSON

{
    "id": "value",
    "groupId": "value",
    "name": "value",
    "targetUri": "value",
    "transmissionStatus": "value",
    "activeThreadCount": 0,
    "flowFilesSent": 0,
    "bytesSent": 0,
    "sent": "value",
    "flowFilesReceived": 0,
    "bytesReceived": 0,
    "received": "value",
}

Close

RemoteProcessGroupStatusSnapshotEntity

Name	Type	Required	Description
id	string	optional	The id of the remote process group.
remoteProcessGroupStatusSnapshot	RemoteProcessGroupStatusSnapshotDTO	optional
canRead	boolean	optional	Indicates whether the user can read a given resource. This property is read only.

Example JSON

{
    "id": "value",
    "remoteProcessGroupStatusSnapshot": RemoteProcessGroupStatusSnapshotDTO{…},
    "canRead": true,
}

Close

RemoteProcessGroupsEntity

Name	Type	Required	Description
remoteProcessGroups	array[RemoteProcessGroupEntity]	optional

Example JSON

{
    "remoteProcessGroups": [RemoteProcessGroupEntity{…}],
}

Close

RemoteQueuePartitionDTO

Name	Type	Required	Description
totalFlowFileCount	integer (int32)	optional	Total number of FlowFiles owned by the Connection
totalByteCount	integer (int64)	optional	Total number of bytes that make up the content for the FlowFiles owned by this Connection
activeQueueFlowFileCount	integer (int32)	optional	Total number of FlowFiles that exist in the Connection's Active Queue, immediately available to be offered up to a component
activeQueueByteCount	integer (int64)	optional	Total number of bytes that make up the content for the FlowFiles that are present in the Connection's Active Queue
swapFlowFileCount	integer (int32)	optional	The total number of FlowFiles that are swapped out for this Connection
swapByteCount	integer (int64)	optional	Total number of bytes that make up the content for the FlowFiles that are swapped out to disk for the Connection
swapFiles	integer (int32)	optional	The number of Swap Files that exist for this Connection
inFlightFlowFileCount	integer (int32)	optional	The number of In-Flight FlowFiles for this Connection. These are FlowFiles that belong to the connection but are currently being operated on by a Processor, Port, etc.
inFlightByteCount	integer (int64)	optional	The number bytes that make up the content of the FlowFiles that are In-Flight
nodeIdentifier	string	optional	The Node Identifier that this queue partition is sending to

Example JSON

{
    "totalFlowFileCount": 0,
    "totalByteCount": 0,
    "activeQueueFlowFileCount": 0,
    "activeQueueByteCount": 0,
    "swapFlowFileCount": 0,
    "swapByteCount": 0,
    "swapFiles": 0,
    "inFlightFlowFileCount": 0,
    "inFlightByteCount": 0,
    "nodeIdentifier": "value",
}

Close

ReplayLastEventRequestEntity

Name	Type	Required	Description
componentId	string	optional	The UUID of the component whose last event should be replayed.
nodes	string	optional	Which nodes are to replay their last provenance event. Allowable values: ALL, PRIMARY

Example JSON

{
    "componentId": "value",
    "nodes": "value",
}

Close

ReplayLastEventResponseEntity

Name	Type	Required	Description
componentId	string	optional	The UUID of the component whose last event should be replayed.
nodes	string	optional	Which nodes were requested to replay their last provenance event. Allowable values: ALL, PRIMARY
aggregateSnapshot	ReplayLastEventSnapshotDTO	optional	The aggregate result of all nodes' responses
nodeSnapshots	array[NodeReplayLastEventSnapshotDTO]	optional	The node-wise results

Example JSON

{
    "componentId": "value",
    "nodes": "value",
    "aggregateSnapshot": ReplayLastEventSnapshotDTO{…},
    "nodeSnapshots": [NodeReplayLastEventSnapshotDTO{…}],
}

Close

ReplayLastEventSnapshotDTO

Name	Type	Required	Description
eventsReplayed	array[integer]	optional	The IDs of the events that were successfully replayed
failureExplanation	string	optional	If unable to replay an event, specifies why the event could not be replayed
eventAvailable	boolean	optional	Whether or not an event was available. This may not be populated if there was a failure.

Example JSON

{
    "eventsReplayed": ["value"],
    "failureExplanation": "value",
    "eventAvailable": true,
}

Close

ReportingTaskDTO

Name	Type	Required	Description
id	string	optional	The id of the component.
versionedComponentId	string	optional	The ID of the corresponding component that is under version control
parentGroupId	string	optional	The id of parent process group of this component if applicable.
position	PositionDTO	optional	The position of this component in the UI if applicable.
name	string	optional	The name of the reporting task.
type	string	optional	The fully qualified type of the reporting task.
bundle	BundleDTO	optional	The details of the artifact that bundled this reporting task type.
state	string	optional	The state of the reporting task. Allowable values: RUNNING, STOPPED, DISABLED
comments	string	optional	The comments of the reporting task.
persistsState	boolean	optional	Whether the reporting task persists state.
restricted	boolean	optional	Whether the reporting task requires elevated privileges.
deprecated	boolean	optional	Whether the reporting task has been deprecated.
multipleVersionsAvailable	boolean	optional	Whether the reporting task has multiple versions available.
supportsSensitiveDynamicProperties	boolean	optional	Whether the reporting task supports sensitive dynamic properties.
schedulingPeriod	string	optional	The frequency with which to schedule the reporting task. The format of the value will depend on the value of the schedulingStrategy.
schedulingStrategy	string	optional	The scheduling strategy that determines how the schedulingPeriod value should be interpreted.
defaultSchedulingPeriod	object	optional	The default scheduling period for the different scheduling strategies.
properties	object	optional	The properties of the reporting task.
descriptors	object	optional	The descriptors for the reporting tasks properties.
sensitiveDynamicPropertyNames	array[string]	optional	Set of sensitive dynamic property names
customUiUrl	string	optional	The URL for the custom configuration UI for the reporting task.
annotationData	string	optional	The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task.
validationErrors	array[string]	optional	Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.
validationStatus	string	optional	Indicates whether the Reporting Task is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Reporting Task is valid) Allowable values: VALID, INVALID, VALIDATING This property is read only.
activeThreadCount	integer (int32)	optional	The number of active threads for the reporting task.
extensionMissing	boolean	optional	Whether the underlying extension is missing.

Example JSON

{
    "id": "value",
    "versionedComponentId": "value",
    "parentGroupId": "value",
    "position": PositionDTO{…},
    "name": "value",
    "type": "value",
    "bundle": BundleDTO{…},
    "state": "value",
    "comments": "value",
    "persistsState": true,
    "restricted": true,
    "deprecated": true,
    "multipleVersionsAvailable": true,
    "supportsSensitiveDynamicProperties": true,
    "schedulingPeriod": "value",
    "schedulingStrategy": "value",
    "defaultSchedulingPeriod": {
        "name": "value"
    },
    "properties": {
        "name": "value"
    },
    "descriptors": {
        "name": PropertyDescriptorDTO{…}
    },
    "sensitiveDynamicPropertyNames": ["value"],
    "customUiUrl": "value",
    "annotationData": "value",
    "validationErrors": ["value"],
    "validationStatus": "value",
    "activeThreadCount": 0,
    "extensionMissing": true,
}

Close

ReportingTaskDefinition

Name	Type	Required	Description
group	string	optional	The group name of the bundle that provides the referenced type.
artifact	string	optional	The artifact name of the bundle that provides the referenced type.
version	string	optional	The version of the bundle that provides the referenced type.
type	string	required	The fully-qualified class type
typeDescription	string	optional	The description of the type.
buildInfo	BuildInfo	optional	The build metadata for this component
providedApiImplementations	array[DefinedType]	optional	If this type represents a provider for an interface, this lists the APIs it implements
tags	array[string]	optional	The tags associated with this type
seeAlso	array[string]	optional	The names of other component types that may be related
deprecated	boolean	optional	Whether or not the component has been deprecated
deprecationReason	string	optional	If this component has been deprecated, this optional field can be used to provide an explanation
deprecationAlternatives	array[string]	optional	If this component has been deprecated, this optional field provides alternatives to use
restricted	boolean	optional	Whether or not the component has a general restriction
restrictedExplanation	string	optional	An optional description of the general restriction
explicitRestrictions	array[Restriction]	optional	Explicit restrictions that indicate a require permission to use the component
stateful	Stateful	optional	Indicates if the component stores state
systemResourceConsiderations	array[SystemResourceConsideration]	optional	The system resource considerations for the given component
additionalDetails	boolean	optional	Indicates if the component has additional details documentation
propertyDescriptors	object	optional	Descriptions of configuration properties applicable to this component.
supportsDynamicProperties	boolean	optional	Whether or not this component makes use of dynamic (user-set) properties.
supportsSensitiveDynamicProperties	boolean	optional	Whether or not this component makes use of sensitive dynamic (user-set) properties.
dynamicProperties	array[DynamicProperty]	optional	Describes the dynamic properties supported by this component
supportedSchedulingStrategies	array[string]	optional	The supported scheduling strategies, such as TIME_DRIVER or CRON.
defaultSchedulingStrategy	string	optional	The default scheduling strategy for the reporting task.
defaultSchedulingPeriodBySchedulingStrategy	object	optional	The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as "30 sec".

Example JSON

{
    "group": "value",
    "artifact": "value",
    "version": "value",
    "type": "value",
    "typeDescription": "value",
    "buildInfo": BuildInfo{…},
    "providedApiImplementations": [DefinedType{…}],
    "tags": ["value"],
    "seeAlso": ["value"],
    "deprecated": true,
    "deprecationReason": "value",
    "deprecationAlternatives": ["value"],
    "restricted": true,
    "restrictedExplanation": "value",
    "explicitRestrictions": [Restriction{…}],
    "stateful": Stateful{…},
    "systemResourceConsiderations": [SystemResourceConsideration{…}],
    "additionalDetails": true,
    "propertyDescriptors": {
        "name": PropertyDescriptor{…}
    },
    "supportsDynamicProperties": true,
    "supportsSensitiveDynamicProperties": true,
    "dynamicProperties": [DynamicProperty{…}],
    "supportedSchedulingStrategies": ["value"],
    "defaultSchedulingStrategy": "value",
    "defaultSchedulingPeriodBySchedulingStrategy": {
        "name": "value"
    },
}

Close

ReportingTaskEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
component	ReportingTaskDTO	optional
operatePermissions	PermissionsDTO	optional	The permissions for this component operations.
status	ReportingTaskStatusDTO	optional	The status for this ReportingTask. This property is read only.

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "component": ReportingTaskDTO{…},
    "operatePermissions": PermissionsDTO{…},
    "status": ReportingTaskStatusDTO{…},
}

Close

ReportingTaskRunStatusEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
state	string	optional	The run status of the ReportingTask. Allowable values: RUNNING, STOPPED
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Example JSON

{
    "revision": RevisionDTO{…},
    "state": "value",
    "disconnectedNodeAcknowledged": true,
}

Close

ReportingTaskStatusDTO

Name	Type	Required	Description
runStatus	string	optional	The run status of this ReportingTask Allowable values: RUNNING, STOPPED, DISABLED This property is read only.
validationStatus	string	optional	Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid) Allowable values: VALID, INVALID, VALIDATING This property is read only.
activeThreadCount	integer (int32)	optional	The number of active threads for the component.

Example JSON

{
    "runStatus": "value",
    "validationStatus": "value",
    "activeThreadCount": 0,
}

Close

ReportingTaskTypesEntity

Name	Type	Required	Description
reportingTaskTypes	array[DocumentedTypeDTO]	optional

Example JSON

{
    "reportingTaskTypes": [DocumentedTypeDTO{…}],
}

Close

ReportingTasksEntity

Name	Type	Required	Description
reportingTasks	array[ReportingTaskEntity]	optional

Example JSON

{
    "reportingTasks": [ReportingTaskEntity{…}],
}

Close

RepositoryUsageDTO

Name	Type	Required	Description
name	string	optional	The name of the repository
fileStoreHash	string	optional	A SHA-256 hash of the File Store name/path that is used to store the repository's data. This information is exposed as a hash in order to avoid exposing potentially sensitive information that is not generally relevant. What is typically relevant is whether or not multiple repositories on the same node are using the same File Store, as this indicates that the repositories are competing for the resources of the backing disk/storage mechanism.
freeSpace	string	optional	Amount of free space.
totalSpace	string	optional	Amount of total space.
freeSpaceBytes	integer (int64)	optional	The number of bytes of free space.
totalSpaceBytes	integer (int64)	optional	The number of bytes of total space.
utilization	string	optional	Utilization of this storage location.

Example JSON

{
    "name": "value",
    "fileStoreHash": "value",
    "freeSpace": "value",
    "totalSpace": "value",
    "freeSpaceBytes": 0,
    "totalSpaceBytes": 0,
    "utilization": "value",
}

Close

RequiredPermissionDTO

Name	Type	Required	Description
id	string	optional	The required sub-permission necessary for this restriction.
label	string	optional	The label for the required sub-permission necessary for this restriction.

Example JSON

{
    "id": "value",
    "label": "value",
}

Close

ResourceDTO

Name	Type	Required	Description
identifier	string	optional	The identifier of the resource.
name	string	optional	The name of the resource.

Example JSON

{
    "identifier": "value",
    "name": "value",
}

Close

ResourcesEntity

Name	Type	Required	Description
resources	array[ResourceDTO]	optional

Example JSON

{
    "resources": [ResourceDTO{…}],
}

Close

Response

Name	Type	Required
status	integer (int32)	optional
entity	object	optional
metadata	object	optional

Example JSON

{
    "status": 0,
    "entity": {
        "name": "value"
    },
    "metadata": {
        "name": "value"
    },
}

Close

Restriction

Name	Type	Required	Description
requiredPermission	string	optional	The permission required for this restriction
explanation	string	optional	The explanation of this restriction

Example JSON

{
    "requiredPermission": "value",
    "explanation": "value",
}

Close

RevisionDTO

Name	Type	Required	Description
clientId	string	optional	A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back
version	integer (int64)	optional	NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version.
lastModifier	string	optional	The user that last modified the flow. This property is read only.

Example JSON

{
    "clientId": "value",
    "version": 0,
    "lastModifier": "value",
}

Close

RunStatusDetailsRequestEntity

Name	Type	Required	Description
processorIds	array[string]	optional	The IDs of all processors whose run status details should be provided

Example JSON

{
    "processorIds": ["value"],
}

Close

RuntimeManifest

Name	Type	Required	Description
identifier	string	optional	A unique identifier for the manifest
agentType	string	optional	The type of the runtime binary, e.g., 'minifi-java' or 'minifi-cpp'
version	string	optional	The version of the runtime binary, e.g., '1.0.1'
buildInfo	BuildInfo	optional	Build summary for this runtime binary
bundles	array[Bundle]	optional	All extension bundles included with this runtime
schedulingDefaults	SchedulingDefaults	optional	Scheduling defaults for components defined in this manifest

Example JSON

{
    "identifier": "value",
    "agentType": "value",
    "version": "value",
    "buildInfo": BuildInfo{…},
    "bundles": [Bundle{…}],
    "schedulingDefaults": SchedulingDefaults{…},
}

Close

RuntimeManifestEntity

Name	Type	Required	Description
runtimeManifest	RuntimeManifest	optional

Example JSON

{
    "runtimeManifest": RuntimeManifest{…},
}

Close

ScheduleComponentsEntity

Name	Type	Required	Description
id	string	optional	The id of the ProcessGroup
state	string	optional	The desired state of the descendant components Allowable values: RUNNING, STOPPED, ENABLED, DISABLED
components	object	optional	Optional components to schedule. If not specified, all authorized descendant components will be used.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Example JSON

{
    "id": "value",
    "state": "value",
    "components": {
        "name": RevisionDTO{…}
    },
    "disconnectedNodeAcknowledged": true,
}

Close

SchedulingDefaults

Name	Type	Required	Description
defaultSchedulingStrategy	string	optional	The name of the default scheduling strategy Allowable values: EVENT_DRIVEN, TIMER_DRIVEN, PRIMARY_NODE_ONLY, CRON_DRIVEN
defaultSchedulingPeriodMillis	integer (int64)	optional	The default scheduling period in milliseconds
penalizationPeriodMillis	integer (int64)	optional	The default penalization period in milliseconds
yieldDurationMillis	integer (int64)	optional	The default yield duration in milliseconds
defaultRunDurationNanos	integer (int64)	optional	The default run duration in nano-seconds
defaultMaxConcurrentTasks	string	optional	The default concurrent tasks
defaultConcurrentTasksBySchedulingStrategy	object	optional	The default concurrent tasks for each scheduling strategy
defaultSchedulingPeriodsBySchedulingStrategy	object	optional	The default scheduling period for each scheduling strategy

Example JSON

{
    "defaultSchedulingStrategy": "value",
    "defaultSchedulingPeriodMillis": 0,
    "penalizationPeriodMillis": 0,
    "yieldDurationMillis": 0,
    "defaultRunDurationNanos": 0,
    "defaultMaxConcurrentTasks": "value",
    "defaultConcurrentTasksBySchedulingStrategy": {
        "name": 0
    },
    "defaultSchedulingPeriodsBySchedulingStrategy": {
        "name": "value"
    },
}

Close

SearchResultGroupDTO

Name	Type	Required	Description
id	string	required	The id of the group.
name	string	optional	The name of the group.

Example JSON

{
    "id": "value",
    "name": "value",
}

Close

SearchResultsDTO

Name	Type	Required	Description
processorResults	array[ComponentSearchResultDTO]	optional	The processors that matched the search.
connectionResults	array[ComponentSearchResultDTO]	optional	The connections that matched the search.
processGroupResults	array[ComponentSearchResultDTO]	optional	The process groups that matched the search.
inputPortResults	array[ComponentSearchResultDTO]	optional	The input ports that matched the search.
outputPortResults	array[ComponentSearchResultDTO]	optional	The output ports that matched the search.
remoteProcessGroupResults	array[ComponentSearchResultDTO]	optional	The remote process groups that matched the search.
funnelResults	array[ComponentSearchResultDTO]	optional	The funnels that matched the search.
labelResults	array[ComponentSearchResultDTO]	optional	The labels that matched the search.
controllerServiceNodeResults	array[ComponentSearchResultDTO]	optional	The controller service nodes that matched the search
parameterContextResults	array[ComponentSearchResultDTO]	optional	The parameter contexts that matched the search.
parameterProviderNodeResults	array[ComponentSearchResultDTO]	optional	The parameter provider nodes that matched the search
parameterResults	array[ComponentSearchResultDTO]	optional	The parameters that matched the search.

Example JSON

{
    "processorResults": [ComponentSearchResultDTO{…}],
    "connectionResults": [ComponentSearchResultDTO{…}],
    "processGroupResults": [ComponentSearchResultDTO{…}],
    "inputPortResults": [ComponentSearchResultDTO{…}],
    "outputPortResults": [ComponentSearchResultDTO{…}],
    "remoteProcessGroupResults": [ComponentSearchResultDTO{…}],
    "funnelResults": [ComponentSearchResultDTO{…}],
    "labelResults": [ComponentSearchResultDTO{…}],
    "controllerServiceNodeResults": [ComponentSearchResultDTO{…}],
    "parameterContextResults": [ComponentSearchResultDTO{…}],
    "parameterProviderNodeResults": [ComponentSearchResultDTO{…}],
    "parameterResults": [ComponentSearchResultDTO{…}],
}

Close

SearchResultsEntity

Name	Type	Required	Description
searchResultsDTO	SearchResultsDTO	optional

Example JSON

{
    "searchResultsDTO": SearchResultsDTO{…},
}

Close

SnippetDTO

Name	Type	Required	Description
id	string	optional	The id of the snippet.
uri	string	optional	The URI of the snippet.
parentGroupId	string	optional	The group id for the components in the snippet.
processGroups	object	optional	The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).
remoteProcessGroups	object	optional	The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).
processors	object	optional	The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).
inputPorts	object	optional	The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).
outputPorts	object	optional	The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).
connections	object	optional	The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).
labels	object	optional	The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).
funnels	object	optional	The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).

Example JSON

{
    "id": "value",
    "uri": "value",
    "parentGroupId": "value",
    "processGroups": {
        "name": RevisionDTO{…}
    },
    "remoteProcessGroups": {
        "name": RevisionDTO{…}
    },
    "processors": {
        "name": RevisionDTO{…}
    },
    "inputPorts": {
        "name": RevisionDTO{…}
    },
    "outputPorts": {
        "name": RevisionDTO{…}
    },
    "connections": {
        "name": RevisionDTO{…}
    },
    "labels": {
        "name": RevisionDTO{…}
    },
    "funnels": {
        "name": RevisionDTO{…}
    },
}

Close

SnippetEntity

Name	Type	Required	Description
snippet	SnippetDTO	optional	The snippet.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Example JSON

{
    "snippet": SnippetDTO{…},
    "disconnectedNodeAcknowledged": true,
}

Close

StackTraceElement

Name	Type	Required
methodName	string	optional
fileName	string	optional
lineNumber	integer (int32)	optional
className	string	optional
nativeMethod	boolean	optional

Example JSON

{
    "methodName": "value",
    "fileName": "value",
    "lineNumber": 0,
    "className": "value",
    "nativeMethod": true,
}

Close

StartVersionControlRequestEntity

Name	Type	Required	Description
versionedFlow	VersionedFlowDTO	optional	The versioned flow
processGroupRevision	RevisionDTO	optional	The Revision of the Process Group under Version Control
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Example JSON

{
    "versionedFlow": VersionedFlowDTO{…},
    "processGroupRevision": RevisionDTO{…},
    "disconnectedNodeAcknowledged": true,
}

Close

StateEntryDTO

Name	Type	Required	Description
key	string	optional	The key for this state.
value	string	optional	The value for this state.
clusterNodeId	string	optional	The identifier for the node where the state originated.
clusterNodeAddress	string	optional	The label for the node where the state originated.

Example JSON

{
    "key": "value",
    "value": "value",
    "clusterNodeId": "value",
    "clusterNodeAddress": "value",
}

Close

StateMapDTO

Name	Type	Required	Description
scope	string	optional	The scope of this StateMap.
totalEntryCount	integer (int32)	optional	The total number of state entries. When the state map is lengthy, only of portion of the entries are returned.
state	array[StateEntryDTO]	optional	The state.

Example JSON

{
    "scope": "value",
    "totalEntryCount": 0,
    "state": [StateEntryDTO{…}],
}

Close

Stateful

Name	Type	Required	Description
description	string	optional	Description of what information is being stored in the StateManager
scopes	array[string]	optional	Indicates the Scope(s) associated with the State that is stored and retrieved

Example JSON

{
    "description": "value",
    "scopes": ["value"],
}

Close

StatusDescriptorDTO

Name	Type	Required	Description
field	string	optional	The name of the status field.
label	string	optional	The label for the status field.
description	string	optional	The description of the status field.
formatter	string	optional	The formatter for the status descriptor.

Example JSON

{
    "field": "value",
    "label": "value",
    "description": "value",
    "formatter": "value",
}

Close

StatusHistoryDTO

Name	Type	Required	Description
generated	string	optional	When the status history was generated.
componentDetails	object	optional	A Map of key/value pairs that describe the component that the status history belongs to
fieldDescriptors	array[StatusDescriptorDTO]	optional	The Descriptors that provide information on each of the metrics provided in the status history
aggregateSnapshots	array[StatusSnapshotDTO]	optional	A list of StatusSnapshotDTO objects that provide the actual metric values for the component. If the NiFi instance is clustered, this will represent the aggregate status across all nodes. If the NiFi instance is not clustered, this will represent the status of the entire NiFi instance.
nodeSnapshots	array[NodeStatusSnapshotsDTO]	optional	The NodeStatusSnapshotsDTO objects that provide the actual metric values for the component, for each node. If the NiFi instance is not clustered, this value will be null.

Example JSON

{
    "generated": "value",
    "componentDetails": {
        "name": "value"
    },
    "fieldDescriptors": [StatusDescriptorDTO{…}],
    "aggregateSnapshots": [StatusSnapshotDTO{…}],
    "nodeSnapshots": [NodeStatusSnapshotsDTO{…}],
}

Close

StatusHistoryEntity

Name	Type	Required	Description
statusHistory	StatusHistoryDTO	optional
canRead	boolean	optional	Indicates whether the user can read a given resource. This property is read only.

Example JSON

{
    "statusHistory": StatusHistoryDTO{…},
    "canRead": true,
}

Close

StatusSnapshotDTO

Name	Type	Required	Description
timestamp	string (date-time)	optional	The timestamp of the snapshot.
statusMetrics	object	optional	The status metrics.

Example JSON

{
    "timestamp": "value",
    "statusMetrics": {
        "name": 0
    },
}

Close

StorageUsageDTO

Name	Type	Required	Description
identifier	string	optional	The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration.
freeSpace	string	optional	Amount of free space.
totalSpace	string	optional	Amount of total space.
usedSpace	string	optional	Amount of used space.
freeSpaceBytes	integer (int64)	optional	The number of bytes of free space.
totalSpaceBytes	integer (int64)	optional	The number of bytes of total space.
usedSpaceBytes	integer (int64)	optional	The number of bytes of used space.
utilization	string	optional	Utilization of this storage location.

Example JSON

{
    "identifier": "value",
    "freeSpace": "value",
    "totalSpace": "value",
    "usedSpace": "value",
    "freeSpaceBytes": 0,
    "totalSpaceBytes": 0,
    "usedSpaceBytes": 0,
    "utilization": "value",
}

Close

StreamingOutput

Name	Type	Required	Description

Example JSON

{
}

Close

SubmitReplayRequestEntity

Name	Type	Required	Description
eventId	integer (int64)	optional	The event identifier
clusterNodeId	string	optional	The identifier of the node where to submit the replay request.

Example JSON

{
    "eventId": 0,
    "clusterNodeId": "value",
}

Close

SystemDiagnosticsDTO

Name	Type	Required	Description
aggregateSnapshot	SystemDiagnosticsSnapshotDTO	optional	A systems diagnostic snapshot that represents the aggregate values of all nodes in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this represents the stats of the single instance.
nodeSnapshots	array[NodeSystemDiagnosticsSnapshotDTO]	optional	A systems diagnostics snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.

Example JSON

{
    "aggregateSnapshot": SystemDiagnosticsSnapshotDTO{…},
    "nodeSnapshots": [NodeSystemDiagnosticsSnapshotDTO{…}],
}

Close

SystemDiagnosticsEntity

Name	Type	Required	Description
systemDiagnostics	SystemDiagnosticsDTO	optional

Example JSON

{
    "systemDiagnostics": SystemDiagnosticsDTO{…},
}

Close

SystemDiagnosticsSnapshotDTO

Name	Type	Required	Description
totalNonHeap	string	optional	Total size of non heap.
totalNonHeapBytes	integer (int64)	optional	Total number of bytes allocated to the JVM not used for heap
usedNonHeap	string	optional	Amount of use non heap.
usedNonHeapBytes	integer (int64)	optional	Total number of bytes used by the JVM not in the heap space
freeNonHeap	string	optional	Amount of free non heap.
freeNonHeapBytes	integer (int64)	optional	Total number of free non-heap bytes available to the JVM
maxNonHeap	string	optional	Maximum size of non heap.
maxNonHeapBytes	integer (int64)	optional	The maximum number of bytes that the JVM can use for non-heap purposes
nonHeapUtilization	string	optional	Utilization of non heap.
totalHeap	string	optional	Total size of heap.
totalHeapBytes	integer (int64)	optional	The total number of bytes that are available for the JVM heap to use
usedHeap	string	optional	Amount of used heap.
usedHeapBytes	integer (int64)	optional	The number of bytes of JVM heap that are currently being used
freeHeap	string	optional	Amount of free heap.
freeHeapBytes	integer (int64)	optional	The number of bytes that are allocated to the JVM heap but not currently being used
maxHeap	string	optional	Maximum size of heap.
maxHeapBytes	integer (int64)	optional	The maximum number of bytes that can be used by the JVM
heapUtilization	string	optional	Utilization of heap.
availableProcessors	integer (int32)	optional	Number of available processors if supported by the underlying system.
processorLoadAverage	number (double)	optional	The processor load average if supported by the underlying system.
totalThreads	integer (int32)	optional	Total number of threads.
daemonThreads	integer (int32)	optional	Number of daemon threads.
uptime	string	optional	The uptime of the Java virtual machine
flowFileRepositoryStorageUsage	StorageUsageDTO	optional	The flowfile repository storage usage.
contentRepositoryStorageUsage	array[StorageUsageDTO]	optional	The content repository storage usage.
provenanceRepositoryStorageUsage	array[StorageUsageDTO]	optional	The provenance repository storage usage.
garbageCollection	array[GarbageCollectionDTO]	optional	The garbage collection details.
statsLastRefreshed	string	optional	When the diagnostics were generated.
versionInfo	VersionInfoDTO	optional	The nifi, os, java, and build version information

Example JSON

{
    "totalNonHeap": "value",
    "totalNonHeapBytes": 0,
    "usedNonHeap": "value",
    "usedNonHeapBytes": 0,
    "freeNonHeap": "value",
    "freeNonHeapBytes": 0,
    "maxNonHeap": "value",
    "maxNonHeapBytes": 0,
    "nonHeapUtilization": "value",
    "totalHeap": "value",
    "totalHeapBytes": 0,
    "usedHeap": "value",
    "usedHeapBytes": 0,
    "freeHeap": "value",
    "freeHeapBytes": 0,
    "maxHeap": "value",
    "maxHeapBytes": 0,
    "heapUtilization": "value",
    "availableProcessors": 0,
    "processorLoadAverage": 0.0,
    "totalThreads": 0,
    "daemonThreads": 0,
    "uptime": "value",
    "flowFileRepositoryStorageUsage": StorageUsageDTO{…},
    "contentRepositoryStorageUsage": [StorageUsageDTO{…}],
    "provenanceRepositoryStorageUsage": [StorageUsageDTO{…}],
    "garbageCollection": [GarbageCollectionDTO{…}],
    "statsLastRefreshed": "value",
    "versionInfo": VersionInfoDTO{…},
}

Close

SystemResourceConsideration

Name	Type	Required	Description
resource	string	optional	The resource to consider
description	string	optional	The description of how the resource is affected

Example JSON

{
    "resource": "value",
    "description": "value",
}

Close

TemplateDTO

Name	Type	Required	Description
uri	string	optional	The URI for the template.
id	string	optional	The id of the template.
groupId	string	optional	The id of the Process Group that the template belongs to.
name	string	optional	The name of the template.
description	string	optional	The description of the template.
timestamp	string	optional	The timestamp when this template was created.
encodingVersion	string	optional	The encoding version of this template.
snippet	FlowSnippetDTO	optional	The contents of the template.

Example JSON

{
    "uri": "value",
    "id": "value",
    "groupId": "value",
    "name": "value",
    "description": "value",
    "timestamp": "value",
    "encodingVersion": "value",
    "snippet": FlowSnippetDTO{…},
}

Close

TemplateEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
template	TemplateDTO	optional

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "template": TemplateDTO{…},
}

Close

TemplatesEntity

Name	Type	Required	Description
templates	array[TemplateEntity]	optional
generated	string	optional	When this content was generated.

Example JSON

{
    "templates": [TemplateEntity{…}],
    "generated": "value",
}

Close

TenantDTO

Name	Type	Required	Description
id	string	optional	The id of the component.
versionedComponentId	string	optional	The ID of the corresponding component that is under version control
parentGroupId	string	optional	The id of parent process group of this component if applicable.
position	PositionDTO	optional	The position of this component in the UI if applicable.
identity	string	optional	The identity of the tenant.
configurable	boolean	optional	Whether this tenant is configurable.

Example JSON

{
    "id": "value",
    "versionedComponentId": "value",
    "parentGroupId": "value",
    "position": PositionDTO{…},
    "identity": "value",
    "configurable": true,
}

Close

TenantEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
component	TenantDTO	optional

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "component": TenantDTO{…},
}

Close

TenantsEntity

Name	Type	Required	Description
users	array[TenantEntity]	optional
userGroups	array[TenantEntity]	optional

Example JSON

{
    "users": [TenantEntity{…}],
    "userGroups": [TenantEntity{…}],
}

Close

ThreadDumpDTO

Name	Type	Required	Description
nodeId	string	optional	The ID of the node in the cluster
nodeAddress	string	optional	The address of the node in the cluster
apiPort	integer (int32)	optional	The port the node is listening for API requests.
stackTrace	string	optional	The stack trace for the thread
threadName	string	optional	The name of the thread
threadActiveMillis	integer (int64)	optional	The number of milliseconds that the thread has been executing in the Processor
taskTerminated	boolean	optional	Indicates whether or not the user has requested that the task be terminated. If this is true, it may indicate that the thread is in a state where it will continue running indefinitely without returning.

Example JSON

{
    "nodeId": "value",
    "nodeAddress": "value",
    "apiPort": 0,
    "stackTrace": "value",
    "threadName": "value",
    "threadActiveMillis": 0,
    "taskTerminated": true,
}

Close

Throwable

Name	Type	Required
cause	Throwable	optional
stackTrace	array[StackTraceElement]	optional
message	string	optional
localizedMessage	string	optional
suppressed	array[Throwable]	optional

Example JSON

{
    "cause": Throwable{…},
    "stackTrace": [StackTraceElement{…}],
    "message": "value",
    "localizedMessage": "value",
    "suppressed": [Throwable{…}],
}

Close

TransactionResultEntity

Name	Type	Required
flowFileSent	integer (int32)	optional
responseCode	integer (int32)	optional
message	string	optional

Example JSON

{
    "flowFileSent": 0,
    "responseCode": 0,
    "message": "value",
}

Close

UpdateControllerServiceReferenceRequestEntity

Name	Type	Required	Description
id	string	optional	The identifier of the Controller Service.
state	string	optional	The new state of the references for the controller service. Allowable values: ENABLED, DISABLED, RUNNING, STOPPED
referencingComponentRevisions	object	optional	The revisions for all referencing components.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
uiOnly	boolean	optional	Indicates whether or not the response should only include fields necessary for rendering the NiFi User Interface. As such, when this value is set to true, some fields may be returned as null values, and the selected fields may change at any time without notice. As a result, this value should not be set to true by any client other than the UI.

Example JSON

{
    "id": "value",
    "state": "value",
    "referencingComponentRevisions": {
        "name": RevisionDTO{…}
    },
    "disconnectedNodeAcknowledged": true,
    "uiOnly": true,
}

Close

UserDTO

Name	Type	Required	Description
id	string	optional	The id of the component.
versionedComponentId	string	optional	The ID of the corresponding component that is under version control
parentGroupId	string	optional	The id of parent process group of this component if applicable.
position	PositionDTO	optional	The position of this component in the UI if applicable.
identity	string	optional	The identity of the tenant.
configurable	boolean	optional	Whether this tenant is configurable.
userGroups	array[TenantEntity]	optional	The groups to which the user belongs. This field is read only and it provided for convenience. This property is read only.
accessPolicies	array[AccessPolicySummaryEntity]	optional	The access policies this user belongs to. This property is read only.

Example JSON

{
    "id": "value",
    "versionedComponentId": "value",
    "parentGroupId": "value",
    "position": PositionDTO{…},
    "identity": "value",
    "configurable": true,
    "userGroups": [TenantEntity{…}],
    "accessPolicies": [AccessPolicySummaryEntity{…}],
}

Close

UserEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
component	UserDTO	optional

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "component": UserDTO{…},
}

Close

UserGroupDTO

Name	Type	Required	Description
id	string	optional	The id of the component.
versionedComponentId	string	optional	The ID of the corresponding component that is under version control
parentGroupId	string	optional	The id of parent process group of this component if applicable.
position	PositionDTO	optional	The position of this component in the UI if applicable.
identity	string	optional	The identity of the tenant.
configurable	boolean	optional	Whether this tenant is configurable.
users	array[TenantEntity]	optional	The users that belong to the user group.
accessPolicies	array[AccessPolicyEntity]	optional	The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here. This property is read only.

Example JSON

{
    "id": "value",
    "versionedComponentId": "value",
    "parentGroupId": "value",
    "position": PositionDTO{…},
    "identity": "value",
    "configurable": true,
    "users": [TenantEntity{…}],
    "accessPolicies": [AccessPolicyEntity{…}],
}

Close

UserGroupEntity

Name	Type	Required	Description
revision	RevisionDTO	optional	The revision for this request/response. The revision is required for any mutable flow requests and is included in all responses.
id	string	optional	The id of the component.
uri	string	optional	The URI for futures requests to the component.
position	PositionDTO	optional	The position of this component in the UI if applicable.
permissions	PermissionsDTO	optional	The permissions for this component.
bulletins	array[BulletinEntity]	optional	The bulletins for this component.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
component	UserGroupDTO	optional

Example JSON

{
    "revision": RevisionDTO{…},
    "id": "value",
    "uri": "value",
    "position": PositionDTO{…},
    "permissions": PermissionsDTO{…},
    "bulletins": [BulletinEntity{…}],
    "disconnectedNodeAcknowledged": true,
    "component": UserGroupDTO{…},
}

Close

UserGroupsEntity

Name	Type	Required	Description
userGroups	array[UserGroupEntity]	optional

Example JSON

{
    "userGroups": [UserGroupEntity{…}],
}

Close

UsersEntity

Name	Type	Required	Description
generated	string	optional	When this content was generated.
users	array[UserEntity]	optional

Example JSON

{
    "generated": "value",
    "users": [UserEntity{…}],
}

Close

VariableDTO

Name	Type	Required	Description
name	string	optional	The name of the variable
value	string	optional	The value of the variable
processGroupId	string	optional	The ID of the Process Group where this Variable is defined This property is read only.
affectedComponents	array[AffectedComponentEntity]	optional	A set of all components that will be affected if the value of this variable is changed This property is read only.

Example JSON

{
    "name": "value",
    "value": "value",
    "processGroupId": "value",
    "affectedComponents": [AffectedComponentEntity{…}],
}

Close

VariableEntity

Name	Type	Required	Description
variable	VariableDTO	optional	The variable information
canWrite	boolean	optional	Indicates whether the user can write a given resource. This property is read only.

Example JSON

{
    "variable": VariableDTO{…},
    "canWrite": true,
}

Close

VariableRegistryDTO

Name	Type	Required	Description
variables	array[VariableEntity]	optional	The variables that are available in this Variable Registry
processGroupId	string	optional	The UUID of the Process Group that this Variable Registry belongs to

Example JSON

{
    "variables": [VariableEntity{…}],
    "processGroupId": "value",
}

Close

VariableRegistryEntity

Name	Type	Required	Description
processGroupRevision	RevisionDTO	optional	The revision of the Process Group that the Variable Registry belongs to
variableRegistry	VariableRegistryDTO	optional	The Variable Registry.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Example JSON

{
    "processGroupRevision": RevisionDTO{…},
    "variableRegistry": VariableRegistryDTO{…},
    "disconnectedNodeAcknowledged": true,
}

Close

VariableRegistryUpdateRequestDTO

Name	Type	Required	Description
requestId	string	optional	The ID of the request This property is read only.
uri	string	optional	The URI for the request This property is read only.
submissionTime	string (date-time)	optional	The timestamp of when the request was submitted This property is read only.
lastUpdated	string (date-time)	optional	The timestamp of when the request was last updated This property is read only.
complete	boolean	optional	Whether or not the request is completed This property is read only.
failureReason	string	optional	The reason for the request failing, or null if the request has not failed This property is read only.
percentCompleted	integer (int32)	optional	A value between 0 and 100 (inclusive) indicating how close the request is to completion This property is read only.
state	string	optional	A description of the current state of the request This property is read only.
updateSteps	array[VariableRegistryUpdateStepDTO]	optional	The steps that are required in order to complete the request, along with the status of each This property is read only.
processGroupId	string	optional	The unique ID of the Process Group that the variable registry belongs to
affectedComponents	array[AffectedComponentEntity]	optional	A set of all components that will be affected if the value of this variable is changed This property is read only.

Example JSON

{
    "requestId": "value",
    "uri": "value",
    "submissionTime": "value",
    "lastUpdated": "value",
    "complete": true,
    "failureReason": "value",
    "percentCompleted": 0,
    "state": "value",
    "updateSteps": [VariableRegistryUpdateStepDTO{…}],
    "processGroupId": "value",
    "affectedComponents": [AffectedComponentEntity{…}],
}

Close

VariableRegistryUpdateRequestEntity

Name	Type	Required	Description
request	VariableRegistryUpdateRequestDTO	optional	The Variable Registry Update Request
processGroupRevision	RevisionDTO	optional	The revision for the Process Group that owns this variable registry.

Example JSON

{
    "request": VariableRegistryUpdateRequestDTO{…},
    "processGroupRevision": RevisionDTO{…},
}

Close

VariableRegistryUpdateStepDTO

Name	Type	Required	Description
description	string	optional	Explanation of what happens in this step This property is read only.
complete	boolean	optional	Whether or not this step has completed This property is read only.
failureReason	string	optional	An explanation of why this step failed, or null if this step did not fail This property is read only.

Example JSON

{
    "description": "value",
    "complete": true,
    "failureReason": "value",
}

Close

VerifyConfigRequestDTO

Name	Type	Required	Description
requestId	string	optional	The ID of the request This property is read only.
uri	string	optional	The URI for the request This property is read only.
submissionTime	string (date-time)	optional	The timestamp of when the request was submitted This property is read only.
lastUpdated	string (date-time)	optional	The timestamp of when the request was last updated This property is read only.
complete	boolean	optional	Whether or not the request is completed This property is read only.
failureReason	string	optional	The reason for the request failing, or null if the request has not failed This property is read only.
percentCompleted	integer (int32)	optional	A value between 0 and 100 (inclusive) indicating how close the request is to completion This property is read only.
state	string	optional	A description of the current state of the request This property is read only.
updateSteps	array[VerifyConfigUpdateStepDTO]	optional	The steps that are required in order to complete the request, along with the status of each This property is read only.
componentId	string	optional	The ID of the component whose configuration was verified
properties	object	optional	The configured component properties
attributes	object	optional	FlowFile Attributes that should be used to evaluate Expression Language for resolving property values
results	array[ConfigVerificationResultDTO]	optional	The Results of the verification This property is read only.

Example JSON

{
    "requestId": "value",
    "uri": "value",
    "submissionTime": "value",
    "lastUpdated": "value",
    "complete": true,
    "failureReason": "value",
    "percentCompleted": 0,
    "state": "value",
    "updateSteps": [VerifyConfigUpdateStepDTO{…}],
    "componentId": "value",
    "properties": {
        "name": "value"
    },
    "attributes": {
        "name": "value"
    },
    "results": [ConfigVerificationResultDTO{…}],
}

Close

VerifyConfigRequestEntity

Name	Type	Required	Description
request	VerifyConfigRequestDTO	optional	The request

Example JSON

{
    "request": VerifyConfigRequestDTO{…},
}

Close

VerifyConfigUpdateStepDTO

Name	Type	Required	Description
description	string	optional	Explanation of what happens in this step This property is read only.
complete	boolean	optional	Whether or not this step has completed This property is read only.
failureReason	string	optional	An explanation of why this step failed, or null if this step did not fail This property is read only.

Example JSON

{
    "description": "value",
    "complete": true,
    "failureReason": "value",
}

Close

VersionControlComponentMappingEntity

Name	Type	Required	Description
versionControlComponentMapping	object	optional	The mapping of Versioned Component Identifiers to instance ID's
processGroupRevision	RevisionDTO	optional	The revision of the Process Group
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
versionControlInformation	VersionControlInformationDTO	optional	The Version Control information

Example JSON

{
    "versionControlComponentMapping": {
        "name": "value"
    },
    "processGroupRevision": RevisionDTO{…},
    "disconnectedNodeAcknowledged": true,
    "versionControlInformation": VersionControlInformationDTO{…},
}

Close

VersionControlInformationDTO

Name	Type	Required	Description
groupId	string	optional	The ID of the Process Group that is under version control
registryId	string	optional	The ID of the registry that the flow is stored in
registryName	string	optional	The name of the registry that the flow is stored in This property is read only.
bucketId	string	optional	The ID of the bucket that the flow is stored in
bucketName	string	optional	The name of the bucket that the flow is stored in This property is read only.
flowId	string	optional	The ID of the flow
flowName	string	optional	The name of the flow
flowDescription	string	optional	The description of the flow
version	integer (int32)	optional	The version of the flow
storageLocation	string	optional	The storage location
state	string	optional	The current state of the Process Group, as it relates to the Versioned Flow Allowable values: LOCALLY_MODIFIED, STALE, LOCALLY_MODIFIED_AND_STALE, UP_TO_DATE, SYNC_FAILURE This property is read only.
stateExplanation	string	optional	Explanation of why the group is in the specified state This property is read only.

Example JSON

{
    "groupId": "value",
    "registryId": "value",
    "registryName": "value",
    "bucketId": "value",
    "bucketName": "value",
    "flowId": "value",
    "flowName": "value",
    "flowDescription": "value",
    "version": 0,
    "storageLocation": "value",
    "state": "value",
    "stateExplanation": "value",
}

Close

VersionControlInformationEntity

Name	Type	Required	Description
processGroupRevision	RevisionDTO	optional	The Revision for the Process Group
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.
versionControlInformation	VersionControlInformationDTO	optional	The Version Control information

Example JSON

{
    "processGroupRevision": RevisionDTO{…},
    "disconnectedNodeAcknowledged": true,
    "versionControlInformation": VersionControlInformationDTO{…},
}

Close

VersionInfoDTO

Name	Type	Required	Description
niFiVersion	string	optional	The version of this NiFi.
javaVendor	string	optional	Java JVM vendor
javaVersion	string	optional	Java version
osName	string	optional	Host operating system name
osVersion	string	optional	Host operating system version
osArchitecture	string	optional	Host operating system architecture
buildTag	string	optional	Build tag
buildRevision	string	optional	Build revision or commit hash
buildBranch	string	optional	Build branch
buildTimestamp	string (date-time)	optional	Build timestamp

Example JSON

{
    "niFiVersion": "value",
    "javaVendor": "value",
    "javaVersion": "value",
    "osName": "value",
    "osVersion": "value",
    "osArchitecture": "value",
    "buildTag": "value",
    "buildRevision": "value",
    "buildBranch": "value",
    "buildTimestamp": "value",
}

Close

VersionedConnection

Name	Type	Required	Description
identifier	string	optional	The component's unique identifier
instanceIdentifier	string	optional	The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component
name	string	optional	The component's name
comments	string	optional	The user-supplied comments for the component
position	Position	optional	The component's position on the graph
source	ConnectableComponent	optional	The source of the connection.
destination	ConnectableComponent	optional	The destination of the connection.
labelIndex	integer (int32)	optional	The index of the bend point where to place the connection label.
zIndex	integer (int64)	optional	The z index of the connection.
selectedRelationships	array[string]	optional	The selected relationship that comprise the connection.
backPressureObjectThreshold	integer (int64)	optional	The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue.
backPressureDataSizeThreshold	string	optional	The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue.
flowFileExpiration	string	optional	The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it.
prioritizers	array[string]	optional	The comparators used to prioritize the queue.
bends	array[Position]	optional	The bend points on the connection.
loadBalanceStrategy	string	optional	The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified. Allowable values: DO_NOT_LOAD_BALANCE, PARTITION_BY_ATTRIBUTE, ROUND_ROBIN, SINGLE_NODE
partitioningAttribute	string	optional	The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect.
loadBalanceCompression	string	optional	Whether or not compression should be used when transferring FlowFiles between nodes Allowable values: DO_NOT_COMPRESS, COMPRESS_ATTRIBUTES_ONLY, COMPRESS_ATTRIBUTES_AND_CONTENT
componentType	string	optional	Allowable values: CONNECTION, PROCESSOR, PROCESS_GROUP, REMOTE_PROCESS_GROUP, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, FUNNEL, LABEL, CONTROLLER_SERVICE, REPORTING_TASK, PARAMETER_CONTEXT, PARAMETER_PROVIDER, TEMPLATE, FLOW_REGISTRY_CLIENT
groupIdentifier	string	optional	The ID of the Process Group that this component belongs to

Example JSON

{
    "identifier": "value",
    "instanceIdentifier": "value",
    "name": "value",
    "comments": "value",
    "position": Position{…},
    "source": ConnectableComponent{…},
    "destination": ConnectableComponent{…},
    "labelIndex": 0,
    "zIndex": 0,
    "selectedRelationships": ["value"],
    "backPressureObjectThreshold": 0,
    "backPressureDataSizeThreshold": "value",
    "flowFileExpiration": "value",
    "prioritizers": ["value"],
    "bends": [Position{…}],
    "loadBalanceStrategy": "value",
    "partitioningAttribute": "value",
    "loadBalanceCompression": "value",
    "componentType": "value",
    "groupIdentifier": "value",
}

Close

VersionedControllerService

Name	Type	Required	Description
identifier	string	optional	The component's unique identifier
instanceIdentifier	string	optional	The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component
name	string	optional	The component's name
comments	string	optional	The user-supplied comments for the component
position	Position	optional	The component's position on the graph
type	string	optional	The type of the extension component
bundle	Bundle	optional	Information about the bundle from which the component came
properties	object	optional	The properties for the component. Properties whose value is not set will only contain the property name.
propertyDescriptors	object	optional	The property descriptors for the component.
controllerServiceApis	array[ControllerServiceAPI]	optional	Lists the APIs this Controller Service implements.
annotationData	string	optional	The annotation for the controller service. This is how the custom UI relays configuration to the controller service.
scheduledState	string	optional	The ScheduledState denoting whether the Controller Service is ENABLED or DISABLED Allowable values: ENABLED, DISABLED, RUNNING
bulletinLevel	string	optional	The level at which the controller service will report bulletins.
componentType	string	optional	Allowable values: CONNECTION, PROCESSOR, PROCESS_GROUP, REMOTE_PROCESS_GROUP, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, FUNNEL, LABEL, CONTROLLER_SERVICE, REPORTING_TASK, PARAMETER_CONTEXT, PARAMETER_PROVIDER, TEMPLATE, FLOW_REGISTRY_CLIENT
groupIdentifier	string	optional	The ID of the Process Group that this component belongs to

Example JSON

{
    "identifier": "value",
    "instanceIdentifier": "value",
    "name": "value",
    "comments": "value",
    "position": Position{…},
    "type": "value",
    "bundle": Bundle{…},
    "properties": {
        "name": "value"
    },
    "propertyDescriptors": {
        "name": VersionedPropertyDescriptor{…}
    },
    "controllerServiceApis": [ControllerServiceAPI{…}],
    "annotationData": "value",
    "scheduledState": "value",
    "bulletinLevel": "value",
    "componentType": "value",
    "groupIdentifier": "value",
}

Close

VersionedFlowCoordinates

Name	Type	Required	Description
registryId	string	optional	The identifier of the Flow Registry that contains the flow
storageLocation	string	optional	The location of the Flow Registry that stores the flow
registryUrl	string	optional	The URL of the Flow Registry that contains the flow
bucketId	string	optional	The UUID of the bucket that the flow resides in
flowId	string	optional	The UUID of the flow
version	integer (int32)	optional	The version of the flow
latest	boolean	optional	Whether or not these coordinates point to the latest version of the flow

Example JSON

{
    "registryId": "value",
    "storageLocation": "value",
    "registryUrl": "value",
    "bucketId": "value",
    "flowId": "value",
    "version": 0,
    "latest": true,
}

Close

VersionedFlowDTO

Name	Type	Required	Description
registryId	string	optional	The ID of the registry that the flow is tracked to
bucketId	string	optional	The ID of the bucket where the flow is stored
flowId	string	optional	The ID of the flow
flowName	string	optional	The name of the flow
description	string	optional	A description of the flow
comments	string	optional	Comments for the changeset
action	string	optional	The action being performed Allowable values: COMMIT, FORCE_COMMIT

Example JSON

{
    "registryId": "value",
    "bucketId": "value",
    "flowId": "value",
    "flowName": "value",
    "description": "value",
    "comments": "value",
    "action": "value",
}

Close

VersionedFlowEntity

Name	Type	Required	Description
versionedFlow	VersionedFlowDTO	optional	The versioned flow

Example JSON

{
    "versionedFlow": VersionedFlowDTO{…},
}

Close

VersionedFlowSnapshotEntity

Name	Type	Required	Description
versionedFlowSnapshot	RegisteredFlowSnapshot	optional	The versioned flow snapshot
processGroupRevision	RevisionDTO	optional	The Revision of the Process Group under Version Control
registryId	string	optional	The ID of the Registry that this flow belongs to
updateDescendantVersionedFlows	boolean	optional	If the Process Group to be updated has a child or descendant Process Group that is also under Version Control, this specifies whether or not the contents of that child/descendant Process Group should be updated.
disconnectedNodeAcknowledged	boolean	optional	Acknowledges that this node is disconnected to allow for mutable requests to proceed.

Example JSON

{
    "versionedFlowSnapshot": RegisteredFlowSnapshot{…},
    "processGroupRevision": RevisionDTO{…},
    "registryId": "value",
    "updateDescendantVersionedFlows": true,
    "disconnectedNodeAcknowledged": true,
}

Close

VersionedFlowSnapshotMetadataEntity

Name	Type	Required	Description
versionedFlowSnapshotMetadata	RegisteredFlowSnapshotMetadata	optional	The collection of registered flow snapshot metadata
registryId	string	optional	The ID of the Registry that this flow belongs to

Example JSON

{
    "versionedFlowSnapshotMetadata": RegisteredFlowSnapshotMetadata{…},
    "registryId": "value",
}

Close

VersionedFlowSnapshotMetadataSetEntity

Name	Type	Required	Description
versionedFlowSnapshotMetadataSet	array[VersionedFlowSnapshotMetadataEntity]	optional

Example JSON

{
    "versionedFlowSnapshotMetadataSet": [VersionedFlowSnapshotMetadataEntity{…}],
}

Close

VersionedFlowUpdateRequestDTO

Name	Type	Required	Description
requestId	string	optional	The unique ID of this request. This property is read only.
processGroupId	string	optional	The unique ID of the Process Group being updated
uri	string	optional	The URI for future requests to this drop request. This property is read only.
lastUpdated	string	optional	The last time this request was updated. This property is read only.
complete	boolean	optional	Whether or not this request has completed This property is read only.
failureReason	string	optional	An explanation of why this request failed, or null if this request has not failed This property is read only.
percentCompleted	integer (int32)	optional	The percentage complete for the request, between 0 and 100 This property is read only.
state	string	optional	The state of the request This property is read only.
versionControlInformation	VersionControlInformationDTO	optional	The VersionControlInformation that describes where the Versioned Flow is located; this may not be populated until the request is completed. This property is read only.

Example JSON

{
    "requestId": "value",
    "processGroupId": "value",
    "uri": "value",
    "lastUpdated": "value",
    "complete": true,
    "failureReason": "value",
    "percentCompleted": 0,
    "state": "value",
    "versionControlInformation": VersionControlInformationDTO{…},
}

Close

VersionedFlowUpdateRequestEntity

Name	Type	Required	Description
processGroupRevision	RevisionDTO	optional	The revision for the Process Group being updated.
request	VersionedFlowUpdateRequestDTO	optional	The Flow Update Request

Example JSON

{
    "processGroupRevision": RevisionDTO{…},
    "request": VersionedFlowUpdateRequestDTO{…},
}

Close

VersionedFlowsEntity

Name	Type	Required	Description
versionedFlows	array[VersionedFlowEntity]	optional

Example JSON

{
    "versionedFlows": [VersionedFlowEntity{…}],
}

Close

VersionedFunnel

Name	Type	Required	Description
identifier	string	optional	The component's unique identifier
instanceIdentifier	string	optional	The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component
name	string	optional	The component's name
comments	string	optional	The user-supplied comments for the component
position	Position	optional	The component's position on the graph
componentType	string	optional	Allowable values: CONNECTION, PROCESSOR, PROCESS_GROUP, REMOTE_PROCESS_GROUP, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, FUNNEL, LABEL, CONTROLLER_SERVICE, REPORTING_TASK, PARAMETER_CONTEXT, PARAMETER_PROVIDER, TEMPLATE, FLOW_REGISTRY_CLIENT
groupIdentifier	string	optional	The ID of the Process Group that this component belongs to

Example JSON

{
    "identifier": "value",
    "instanceIdentifier": "value",
    "name": "value",
    "comments": "value",
    "position": Position{…},
    "componentType": "value",
    "groupIdentifier": "value",
}

Close

VersionedLabel

Name	Type	Required	Description
identifier	string	optional	The component's unique identifier
instanceIdentifier	string	optional	The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component
name	string	optional	The component's name
comments	string	optional	The user-supplied comments for the component
position	Position	optional	The component's position on the graph
label	string	optional	The text that appears in the label.
zIndex	integer (int64)	optional	The z index of the connection.
width	number (double)	optional	The width of the label in pixels when at a 1:1 scale.
height	number (double)	optional	The height of the label in pixels when at a 1:1 scale.
style	object	optional	The styles for this label (font-size : 12px, background-color : #eee, etc).
componentType	string	optional	Allowable values: CONNECTION, PROCESSOR, PROCESS_GROUP, REMOTE_PROCESS_GROUP, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, FUNNEL, LABEL, CONTROLLER_SERVICE, REPORTING_TASK, PARAMETER_CONTEXT, PARAMETER_PROVIDER, TEMPLATE, FLOW_REGISTRY_CLIENT
groupIdentifier	string	optional	The ID of the Process Group that this component belongs to

Example JSON

{
    "identifier": "value",
    "instanceIdentifier": "value",
    "name": "value",
    "comments": "value",
    "position": Position{…},
    "label": "value",
    "zIndex": 0,
    "width": 0.0,
    "height": 0.0,
    "style": {
        "name": "value"
    },
    "componentType": "value",
    "groupIdentifier": "value",
}

Close

VersionedParameter

Name	Type	Required	Description
name	string	optional	The name of the parameter
description	string	optional	The description of the param
sensitive	boolean	optional	Whether or not the parameter value is sensitive
provided	boolean	optional	Whether or not the parameter value is provided by a ParameterProvider
value	string	optional	The value of the parameter

Example JSON

{
    "name": "value",
    "description": "value",
    "sensitive": true,
    "provided": true,
    "value": "value",
}

Close

VersionedParameterContext

Name	Type	Required	Description
identifier	string	optional	The component's unique identifier
instanceIdentifier	string	optional	The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component
name	string	optional	The component's name
comments	string	optional	The user-supplied comments for the component
position	Position	optional	The component's position on the graph
parameters	array[VersionedParameter]	optional	The parameters in the context
inheritedParameterContexts	array[string]	optional	The names of additional parameter contexts from which to inherit parameters
description	string	optional	The description of the parameter context
parameterProvider	string	optional	The identifier of an optional parameter provider
parameterGroupName	string	optional	The corresponding parameter group name fetched from the parameter provider, if applicable
componentType	string	optional	Allowable values: CONNECTION, PROCESSOR, PROCESS_GROUP, REMOTE_PROCESS_GROUP, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, FUNNEL, LABEL, CONTROLLER_SERVICE, REPORTING_TASK, PARAMETER_CONTEXT, PARAMETER_PROVIDER, TEMPLATE, FLOW_REGISTRY_CLIENT
synchronized	boolean	optional	True if the parameter provider is set and the context should receive updates when its parameters are next fetched
groupIdentifier	string	optional	The ID of the Process Group that this component belongs to

Example JSON

{
    "identifier": "value",
    "instanceIdentifier": "value",
    "name": "value",
    "comments": "value",
    "position": Position{…},
    "parameters": [VersionedParameter{…}],
    "inheritedParameterContexts": ["value"],
    "description": "value",
    "parameterProvider": "value",
    "parameterGroupName": "value",
    "componentType": "value",
    "synchronized": true,
    "groupIdentifier": "value",
}

Close

VersionedPort

Name	Type	Required	Description
identifier	string	optional	The component's unique identifier
instanceIdentifier	string	optional	The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component
name	string	optional	The component's name
comments	string	optional	The user-supplied comments for the component
position	Position	optional	The component's position on the graph
type	string	optional	The type of port. Allowable values: INPUT_PORT, OUTPUT_PORT
concurrentlySchedulableTaskCount	integer (int32)	optional	The number of tasks that should be concurrently scheduled for the port.
scheduledState	string	optional	The scheduled state of the component Allowable values: ENABLED, DISABLED, RUNNING
allowRemoteAccess	boolean	optional	Whether or not this port allows remote access for site-to-site
componentType	string	optional	Allowable values: CONNECTION, PROCESSOR, PROCESS_GROUP, REMOTE_PROCESS_GROUP, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, FUNNEL, LABEL, CONTROLLER_SERVICE, REPORTING_TASK, PARAMETER_CONTEXT, PARAMETER_PROVIDER, TEMPLATE, FLOW_REGISTRY_CLIENT
groupIdentifier	string	optional	The ID of the Process Group that this component belongs to

Example JSON

{
    "identifier": "value",
    "instanceIdentifier": "value",
    "name": "value",
    "comments": "value",
    "position": Position{…},
    "type": "value",
    "concurrentlySchedulableTaskCount": 0,
    "scheduledState": "value",
    "allowRemoteAccess": true,
    "componentType": "value",
    "groupIdentifier": "value",
}

Close

VersionedProcessGroup

Name	Type	Required	Description
identifier	string	optional	The component's unique identifier
instanceIdentifier	string	optional	The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component
name	string	optional	The component's name
comments	string	optional	The user-supplied comments for the component
position	Position	optional	The component's position on the graph
processGroups	array[VersionedProcessGroup]	optional	The child Process Groups
remoteProcessGroups	array[VersionedRemoteProcessGroup]	optional	The Remote Process Groups
processors	array[VersionedProcessor]	optional	The Processors
inputPorts	array[VersionedPort]	optional	The Input Ports
outputPorts	array[VersionedPort]	optional	The Output Ports
connections	array[VersionedConnection]	optional	The Connections
labels	array[VersionedLabel]	optional	The Labels
funnels	array[VersionedFunnel]	optional	The Funnels
controllerServices	array[VersionedControllerService]	optional	The Controller Services
versionedFlowCoordinates	VersionedFlowCoordinates	optional	The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control
variables	object	optional	The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)
parameterContextName	string	optional	The name of the parameter context used by this process group
defaultFlowFileExpiration	string	optional	The default FlowFile Expiration for this Process Group.
defaultBackPressureObjectThreshold	integer (int64)	optional	Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied.
defaultBackPressureDataSizeThreshold	string	optional	Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied.
logFileSuffix	string	optional	The log file suffix for this Process Group for dedicated logging.
componentType	string	optional	Allowable values: CONNECTION, PROCESSOR, PROCESS_GROUP, REMOTE_PROCESS_GROUP, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, FUNNEL, LABEL, CONTROLLER_SERVICE, REPORTING_TASK, PARAMETER_CONTEXT, PARAMETER_PROVIDER, TEMPLATE, FLOW_REGISTRY_CLIENT
flowFileConcurrency	string	optional	The configured FlowFile Concurrency for the Process Group
flowFileOutboundPolicy	string	optional	The FlowFile Outbound Policy for the Process Group
groupIdentifier	string	optional	The ID of the Process Group that this component belongs to

Example JSON

{
    "identifier": "value",
    "instanceIdentifier": "value",
    "name": "value",
    "comments": "value",
    "position": Position{…},
    "processGroups": [VersionedProcessGroup{…}],
    "remoteProcessGroups": [VersionedRemoteProcessGroup{…}],
    "processors": [VersionedProcessor{…}],
    "inputPorts": [VersionedPort{…}],
    "outputPorts": [VersionedPort{…}],
    "connections": [VersionedConnection{…}],
    "labels": [VersionedLabel{…}],
    "funnels": [VersionedFunnel{…}],
    "controllerServices": [VersionedControllerService{…}],
    "versionedFlowCoordinates": VersionedFlowCoordinates{…},
    "variables": {
        "name": "value"
    },
    "parameterContextName": "value",
    "defaultFlowFileExpiration": "value",
    "defaultBackPressureObjectThreshold": 0,
    "defaultBackPressureDataSizeThreshold": "value",
    "logFileSuffix": "value",
    "componentType": "value",
    "flowFileConcurrency": "value",
    "flowFileOutboundPolicy": "value",
    "groupIdentifier": "value",
}

Close

VersionedProcessor

Name	Type	Required	Description
identifier	string	optional	The component's unique identifier
instanceIdentifier	string	optional	The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component
name	string	optional	The component's name
comments	string	optional	The user-supplied comments for the component
position	Position	optional	The component's position on the graph
type	string	optional	The type of the extension component
bundle	Bundle	optional	Information about the bundle from which the component came
properties	object	optional	The properties for the component. Properties whose value is not set will only contain the property name.
propertyDescriptors	object	optional	The property descriptors for the component.
style	object	optional	Stylistic data for rendering in a UI
annotationData	string	optional	The annotation data for the processor used to relay configuration between a custom UI and the procesosr.
schedulingPeriod	string	optional	The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy.
schedulingStrategy	string	optional	Indicates whether the processor should be scheduled to run in event or timer driven mode.
executionNode	string	optional	Indicates the node where the process will execute.
penaltyDuration	string	optional	The amout of time that is used when the process penalizes a flowfile.
yieldDuration	string	optional	The amount of time that must elapse before this processor is scheduled again after yielding.
bulletinLevel	string	optional	The level at which the processor will report bulletins.
runDurationMillis	integer (int64)	optional	The run duration for the processor in milliseconds.
concurrentlySchedulableTaskCount	integer (int32)	optional	The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored.
autoTerminatedRelationships	array[string]	optional	The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.
scheduledState	string	optional	The scheduled state of the component Allowable values: ENABLED, DISABLED, RUNNING
retryCount	integer (int32)	optional	Overall number of retries.
retriedRelationships	array[string]	optional	All the relationships should be retried.
backoffMechanism	string	optional	Determines whether the FlowFile should be penalized or the processor should be yielded between retries. Allowable values: PENALIZE_FLOWFILE, YIELD_PROCESSOR
maxBackoffPeriod	string	optional	Maximum amount of time to be waited during a retry period.
componentType	string	optional	Allowable values: CONNECTION, PROCESSOR, PROCESS_GROUP, REMOTE_PROCESS_GROUP, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, FUNNEL, LABEL, CONTROLLER_SERVICE, REPORTING_TASK, PARAMETER_CONTEXT, PARAMETER_PROVIDER, TEMPLATE, FLOW_REGISTRY_CLIENT
groupIdentifier	string	optional	The ID of the Process Group that this component belongs to

Example JSON

{
    "identifier": "value",
    "instanceIdentifier": "value",
    "name": "value",
    "comments": "value",
    "position": Position{…},
    "type": "value",
    "bundle": Bundle{…},
    "properties": {
        "name": "value"
    },
    "propertyDescriptors": {
        "name": VersionedPropertyDescriptor{…}
    },
    "style": {
        "name": "value"
    },
    "annotationData": "value",
    "schedulingPeriod": "value",
    "schedulingStrategy": "value",
    "executionNode": "value",
    "penaltyDuration": "value",
    "yieldDuration": "value",
    "bulletinLevel": "value",
    "runDurationMillis": 0,
    "concurrentlySchedulableTaskCount": 0,
    "autoTerminatedRelationships": ["value"],
    "scheduledState": "value",
    "retryCount": 0,
    "retriedRelationships": ["value"],
    "backoffMechanism": "value",
    "maxBackoffPeriod": "value",
    "componentType": "value",
    "groupIdentifier": "value",
}

Close

VersionedPropertyDescriptor

Name	Type	Required	Description
name	string	optional	The name of the property
displayName	string	optional	The display name of the property
identifiesControllerService	boolean	optional	Whether or not the property provides the identifier of a Controller Service
sensitive	boolean	optional	Whether or not the property is considered sensitive
resourceDefinition	VersionedResourceDefinition	optional	Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any

Example JSON

{
    "name": "value",
    "displayName": "value",
    "identifiesControllerService": true,
    "sensitive": true,
    "resourceDefinition": VersionedResourceDefinition{…},
}

Close

VersionedRemoteGroupPort

Name	Type	Required	Description
identifier	string	optional	The component's unique identifier
instanceIdentifier	string	optional	The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component
name	string	optional	The component's name
comments	string	optional	The user-supplied comments for the component
position	Position	optional	The component's position on the graph
remoteGroupId	string	optional	The id of the remote process group that the port resides in.
concurrentlySchedulableTaskCount	integer (int32)	optional	The number of task that may transmit flowfiles to the target port concurrently.
useCompression	boolean	optional	Whether the flowfiles are compressed when sent to the target port.
batchSize	BatchSize	optional	The batch settings for data transmission.
componentType	string	optional	Allowable values: CONNECTION, PROCESSOR, PROCESS_GROUP, REMOTE_PROCESS_GROUP, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, FUNNEL, LABEL, CONTROLLER_SERVICE, REPORTING_TASK, PARAMETER_CONTEXT, PARAMETER_PROVIDER, TEMPLATE, FLOW_REGISTRY_CLIENT
targetId	string	optional	The ID of the port on the target NiFi instance
scheduledState	string	optional	The scheduled state of the component Allowable values: ENABLED, DISABLED, RUNNING
groupIdentifier	string	optional	The ID of the Process Group that this component belongs to

Example JSON

{
    "identifier": "value",
    "instanceIdentifier": "value",
    "name": "value",
    "comments": "value",
    "position": Position{…},
    "remoteGroupId": "value",
    "concurrentlySchedulableTaskCount": 0,
    "useCompression": true,
    "batchSize": BatchSize{…},
    "componentType": "value",
    "targetId": "value",
    "scheduledState": "value",
    "groupIdentifier": "value",
}

Close

VersionedRemoteProcessGroup

Name	Type	Required	Description
identifier	string	optional	The component's unique identifier
instanceIdentifier	string	optional	The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component
name	string	optional	The component's name
comments	string	optional	The user-supplied comments for the component
position	Position	optional	The component's position on the graph
targetUri	string	optional	[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null.
targetUris	string	optional	The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null.
communicationsTimeout	string	optional	The time period used for the timeout when communicating with the target.
yieldDuration	string	optional	When yielding, this amount of time must elapse before the remote process group is scheduled again.
transportProtocol	string	optional	The Transport Protocol that is used for Site-to-Site communications Allowable values: RAW, HTTP
localNetworkInterface	string	optional	The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier.
proxyHost	string	optional
proxyPort	integer (int32)	optional
proxyUser	string	optional
proxyPassword	string	optional
inputPorts	array[VersionedRemoteGroupPort]	optional	A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance
outputPorts	array[VersionedRemoteGroupPort]	optional	A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance
componentType	string	optional	Allowable values: CONNECTION, PROCESSOR, PROCESS_GROUP, REMOTE_PROCESS_GROUP, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, FUNNEL, LABEL, CONTROLLER_SERVICE, REPORTING_TASK, PARAMETER_CONTEXT, PARAMETER_PROVIDER, TEMPLATE, FLOW_REGISTRY_CLIENT
groupIdentifier	string	optional	The ID of the Process Group that this component belongs to

Example JSON

{
    "identifier": "value",
    "instanceIdentifier": "value",
    "name": "value",
    "comments": "value",
    "position": Position{…},
    "targetUri": "value",
    "targetUris": "value",
    "communicationsTimeout": "value",
    "yieldDuration": "value",
    "transportProtocol": "value",
    "localNetworkInterface": "value",
    "proxyHost": "value",
    "proxyPort": 0,
    "proxyUser": "value",
    "proxyPassword": "value",
    "inputPorts": [VersionedRemoteGroupPort{…}],
    "outputPorts": [VersionedRemoteGroupPort{…}],
    "componentType": "value",
    "groupIdentifier": "value",
}

Close

VersionedReportingTask

Name	Type	Required	Description
identifier	string	optional	The component's unique identifier
instanceIdentifier	string	optional	The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component
name	string	optional	The component's name
comments	string	optional	The user-supplied comments for the component
position	Position	optional	The component's position on the graph
type	string	optional	The type of the extension component
bundle	Bundle	optional	Information about the bundle from which the component came
properties	object	optional	The properties for the component. Properties whose value is not set will only contain the property name.
propertyDescriptors	object	optional	The property descriptors for the component.
annotationData	string	optional	The annotation for the reporting task. This is how the custom UI relays configuration to the reporting task.
scheduledState	string	optional	Indicates the scheduled state for the Reporting Task Allowable values: ENABLED, DISABLED, RUNNING
schedulingPeriod	string	optional	The frequency with which to schedule the reporting task. The format of the value will depend on the value of schedulingStrategy.
schedulingStrategy	string	optional	Indicates scheduling strategy that should dictate how the reporting task is triggered.
componentType	string	optional	Allowable values: CONNECTION, PROCESSOR, PROCESS_GROUP, REMOTE_PROCESS_GROUP, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, FUNNEL, LABEL, CONTROLLER_SERVICE, REPORTING_TASK, PARAMETER_CONTEXT, PARAMETER_PROVIDER, TEMPLATE, FLOW_REGISTRY_CLIENT
groupIdentifier	string	optional	The ID of the Process Group that this component belongs to

Example JSON

{
    "identifier": "value",
    "instanceIdentifier": "value",
    "name": "value",
    "comments": "value",
    "position": Position{…},
    "type": "value",
    "bundle": Bundle{…},
    "properties": {
        "name": "value"
    },
    "propertyDescriptors": {
        "name": VersionedPropertyDescriptor{…}
    },
    "annotationData": "value",
    "scheduledState": "value",
    "schedulingPeriod": "value",
    "schedulingStrategy": "value",
    "componentType": "value",
    "groupIdentifier": "value",
}

Close

VersionedReportingTaskSnapshot

Name	Type	Required	Description
reportingTasks	array[VersionedReportingTask]	optional	The reporting tasks
controllerServices	array[VersionedControllerService]	optional	The controller services

Example JSON

{
    "reportingTasks": [VersionedReportingTask{…}],
    "controllerServices": [VersionedControllerService{…}],
}

Close

VersionedResourceDefinition

Name	Type	Required	Description
cardinality	string	optional	The cardinality of the resource Allowable values: SINGLE, MULTIPLE
resourceTypes	array[string]	optional	The types of resource that the Property Descriptor is allowed to reference

Example JSON

{
    "cardinality": "value",
    "resourceTypes": ["value"],
}

Close

Name	Location	Type	Description
id	path	string	The flow registry client id.
	body	FlowRegistryClientEntity	The flow registry client configuration details.

Name	Location	Type	Description
nodewise	query	boolean	Whether or not to include the breakdown per node. Optional, defaults to false
clusterNodeId	query	string	The id of the node where to get the status.

Status Code	Type	Description
200	StreamingOutput	There is no flow file to return.
400	string	NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.
401	string	Client could not be authenticated.
403	string	Client is not authorized to make this request.
404	string	The specified resource could not be found.
409	string	The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.
503	string	NiFi instance is not ready for serving request, or temporarily overloaded. Retrying the same request later may be successful

Name	Location	Type	Description
after	query	string	Includes bulletins with an id after this value.
sourceName	query	string	Includes bulletins originating from this sources whose name match this regular expression.
message	query	string	Includes bulletins whose message that match this regular expression.
sourceId	query	string	Includes bulletins originating from this sources whose id match this regular expression.
groupId	query	string	Includes bulletins originating from this sources whose group id match this regular expression.
limit	query	string	The number of bulletins to limit the response to.

Name	Location	Type	Description
serviceType	query	string	If specified, will only return controller services that are compatible with this type of service.
serviceBundleGroup	query	string	If serviceType specified, is the bundle group of the serviceType.
serviceBundleArtifact	query	string	If serviceType specified, is the bundle artifact of the serviceType.
serviceBundleVersion	query	string	If serviceType specified, is the bundle version of the serviceType.
bundleGroupFilter	query	string	If specified, will only return types that are a member of this bundle group.
bundleArtifactFilter	query	string	If specified, will only return types that are a member of this bundle artifact.
typeFilter	query	string	If specified, will only return types whose fully qualified classname matches.

Name	Location	Type	Description
offset	query	string	The offset into the result set.
count	query	string	The number of actions to return.
sortColumn	query	string	The field to sort on.
sortOrder	query	string	The direction to sort.
startDate	query	string	Include actions after this date.
endDate	query	string	Include actions before this date.
userIdentity	query	string	Include actions performed by this user.
sourceId	query	string	Include actions on this component.

Name	Location	Type	Description
producer	path	string	The producer for flow file metrics. Each producer may have its own output format.
includedRegistries	query	Array[string] (multi)	Set of included metrics registries
sampleName	query	string	Regular Expression Pattern to be applied against the sample name field
sampleLabelValue	query	string	Regular Expression Pattern to be applied against the sample label value field
rootFieldName	query	string	Name of the first field of JSON object. Applicable for JSON producer only.

Name	Location	Type	Description
id	path	string	The process group id.
	body	ScheduleComponentsEntity	The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.

Name	Location	Type	Description
recursive	query	boolean	Whether all descendant groups and the status of their content will be included. Optional, defaults to false
nodewise	query	boolean	Whether or not to include the breakdown per node. Optional, defaults to false
clusterNodeId	query	string	The id of the node where to get the status.
id	path	string	The process group id.

Name	Location	Type	Description
registry-id	path	string	The registry client id.
bucket-id	path	string	The bucket id.

Name	Location	Type	Description
id	path	string	The funnel id.
	body	FunnelEntity	The funnel configuration details.

Name	Location	Type	Description
id	path	string	The input port id.
	body	PortEntity	The input port configuration details.

Name	Location	Type	Description
id	path	string	The port id.
	body	PortRunStatusEntity	The port run status.

Name	Location	Type	Description
id	path	string	The label id.
	body	LabelEntity	The label configuration details.

Name	Location	Type	Description
id	path	string	The output port id.
	body	PortEntity	The output port configuration details.

Name	Location	Type	Description
contextId	path	string
	body	ParameterContextEntity	The updated version of the parameter context.

Name	Location	Type	Description
id	path	string	The parameter provider id.
	body	ParameterProviderEntity	The parameter provider configuration details.

Name	Location	Type	Description
providerId	path	string
	body	ParameterProviderParameterApplicationEntity	The apply parameters request.

Name	Location	Type	Description
id	path	string	The access policy id.
	body	AccessPolicyEntity	The access policy configuration details.

Name	Location	Type	Description
id	path	string	The processor id.
	body	ProcessorEntity	The processor configuration details.

Name	Location	Type	Description
id	path	string	The remote process group id.
	body	RemoteProcessGroupEntity	The remote process group.

Name	Location	Type	Description
id	path	string	The reporting task id.
	body	ReportingTaskEntity	The reporting task configuration details.

Name	Location	Type	Description
id	path	string	The ID of the Reporting Task
requestId	path	string	The ID of the Verification Request

Name	Location	Type	Description
id	path	string	The snippet id.
	body	SnippetEntity	The snippet configuration details.

Name	Location	Type	Description
id	path	string	The user group id.
	body	UserGroupEntity	The user group configuration details.

Name	Location	Type	Description
id	path	string	The user id.
	body	UserEntity	The user configuration details.

Name	Location	Type	Description
id	path	string	The request ID.
	body	VersionControlComponentMappingEntity	The version control component mapping.