Apache NiFi Registry REST API

REST API definition for Apache NiFi Registry web services
More information: https://nifi.apache.org
Contact Info: dev@nifi.apache.org
Version: 2.12.0
Apache 2.0
https://www.apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

About

Access

BucketBundles

BucketFlows

Buckets

Bundles

Config

ExtensionRepository

Extensions

Flows

Items

Policies

Tenants

About

Up 
get /about
Get version (getVersion)
Gets the NiFi Registry version.

Return type

RegistryAbout

Example data

Content-Type: application/json
{
  "registryAboutVersion" : "registryAboutVersion"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

RegistryAbout

Access

Up 
post /access/token
Create token trying all providers (createAccessTokenByTryingAllProviders)
Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.

Return type

String

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

String

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password.

500

NiFi Registry was unable to complete the request because an unexpected error occurred.
Up 
post /access/token/login
Create token using basic auth (createAccessTokenUsingBasicAuthCredentials)
Creates a token for accessing the REST API via username/password. The user credentials must be passed in standard HTTP Basic Auth format. That is: 'Authorization: Basic ', where is the base64 encoded value of ':'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.

Return type

String

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

String

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with username/password.

500

NiFi Registry was unable to complete the request because an unexpected error occurred.
Up 
post /access/token/identity-provider
Create token using identity provider (createAccessTokenUsingIdentityProviderCredentials)
Creates a token for accessing the REST API via a custom identity provider. The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by 'GET /access/token/identity-provider/usage'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.

Return type

String

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

String

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials.

500

NiFi Registry was unable to complete the request because an unexpected error occurred.
Up 
post /access/token/kerberos
Create token using kerberos (createAccessTokenUsingKerberosTicket)
Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets). The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer '.

Return type

String

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

String

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login Kerberos credentials.

500

NiFi Registry was unable to complete the request because an unexpected error occurred.
Up 
get /access
Get access status (getAccessStatus)
Returns the current client's authenticated identity and permissions to top-level resources

Return type

CurrentUser

Example data

Content-Type: application/json
{
  "oidcloginSupported" : true,
  "resourcePermissions" : {
    "anyTopLevelResource" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    }
  },
  "identity" : "identity",
  "anonymous" : true,
  "loginSupported" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

CurrentUser

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might be running unsecured.
Up 
get /access/token/identity-provider/usage
Get identity provider usage (getIdentityProviderUsageInstructions)
Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider

Return type

String

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

String

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials.

500

NiFi Registry was unable to complete the request because an unexpected error occurred.
Up 
delete /access/logout
Performs a logout for other providers that have been issued a JWT. (logout)
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Responses

200

User was logged out successfully.

401

Authentication token provided was empty or not in the correct JWT format.

500

Client failed to log out.
Up 
get /access/logout/complete
Completes the logout sequence. (logoutComplete)
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Responses

200

User was logged out successfully.

401

Authentication token provided was empty or not in the correct JWT format.

500

Client failed to log out.
Up 
get /access/oidc/callback
Redirect/callback URI for processing the result of the OpenId Connect login sequence. (oidcCallback)
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

default response
Up 
post /access/oidc/exchange
Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider. (oidcExchange)
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

default response
Up 
get /access/oidc/logout
Performs a logout in the OpenId Provider. (oidcLogout)
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

default response
Up 
get /access/oidc/logout/callback
Redirect/callback URI for processing the result of the OpenId Connect logout sequence. (oidcLogoutCallback)
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

default response
Up 
get /access/oidc/request
Initiates a request to authenticate through the configured OpenId Connect provider. (oidcRequest)
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

default response
Up 
post /access/token/identity-provider/test
Test identity provider (testIdentityProviderRecognizesCredentialsFormat)
Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them. The user credentials should be passed in a format understood by the custom identity provider as defined by 'GET /access/token/identity-provider/usage'.

Return type

String

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

String

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

The format of the credentials were not recognized by the currently configured identity provider.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry may not be configured to support login with customized credentials.

500

NiFi Registry was unable to complete the request because an unexpected error occurred.

BucketBundles

Up 
post /buckets/{bucketId}/bundles/{bundleType}
Create extension bundle version (createExtensionBundleVersion)

Creates a version of an extension bundle by uploading a binary artifact. If an extension bundle already exists in the given bucket with the same group id and artifact id as that of the bundle being uploaded, then it will be added as a new version to the existing bundle. If an extension bundle does not already exist in the given bucket with the same group id and artifact id, then a new extension bundle will be created and this version will be added to the new bundle. Client's may optionally supply a SHA-256 in hex format through the multi-part form field 'sha256'. If supplied, then this value will be compared against the SHA-256 computed by the server, and the bundle will be rejected if the values do not match. If not supplied, the bundle will be accepted, but will be marked to indicate that the client did not supply a SHA-256 during creation.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

bucketId (required)
Path Parameter — The bucket identifier
bundleType (required)
Path Parameter — The type of the bundle

Consumes

This API call consumes the following media types via the Content-Type request header:

Form parameters

file (optional)
Form Parameter —
sha256 (optional)
Form Parameter —

Return type

BundleVersion

Example data

Content-Type: application/json
{
  "bucket" : {
    "identifier" : "identifier",
    "allowBundleRedeploy" : true,
    "permissions" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "name" : "name",
    "description" : "description",
    "allowPublicRead" : true,
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "filename" : "filename",
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "versionMetadata" : {
    "sha256" : "sha256",
    "buildInfo" : {
      "buildBranch" : "buildBranch",
      "builtBy" : "builtBy",
      "buildRevision" : "buildRevision",
      "buildTag" : "buildTag",
      "built" : 0,
      "buildTool" : "buildTool",
      "buildFlags" : "buildFlags"
    },
    "author" : "author",
    "groupId" : "groupId",
    "bundleId" : "bundleId",
    "description" : "description",
    "bucketId" : "bucketId",
    "version" : "version",
    "sha256Supplied" : true,
    "contentSize" : 0,
    "artifactId" : "artifactId",
    "id" : "id",
    "systemApiVersion" : "systemApiVersion",
    "timestamp" : 1
  },
  "bundle" : {
    "artifact" : "artifact",
    "version" : "version",
    "group" : "group"
  },
  "dependencies" : [ {
    "groupId" : "groupId",
    "artifactId" : "artifactId",
    "version" : "version"
  }, {
    "groupId" : "groupId",
    "artifactId" : "artifactId",
    "version" : "version"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

BundleVersion

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /buckets/{bucketId}/bundles
Get extension bundles by bucket (getExtensionBundles)
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

bucketId (required)
Path Parameter — The bucket identifier

Return type

array[Bundle]

Example data

Content-Type: application/json
[ {
  "artifact" : "artifact",
  "version" : "version",
  "group" : "group"
}, {
  "artifact" : "artifact",
  "version" : "version",
  "group" : "group"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.

BucketFlows

Up 
post /buckets/{bucketId}/flows
Create flow (createFlow)
Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity.

Path parameters

bucketId (required)
Path Parameter — The bucket identifier

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body VersionedFlow (required)
Body Parameter — The details of the flow to create.

Return type

VersionedFlow

Example data

Content-Type: application/json
{
  "versionCount" : 0,
  "bucketName" : "bucketName",
  "identifier" : "identifier",
  "permissions" : {
    "canRead" : true,
    "canDelete" : true,
    "canWrite" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "name" : "name",
  "description" : "description",
  "modifiedTimestamp" : 1,
  "bucketIdentifier" : "bucketIdentifier",
  "type" : "Flow",
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VersionedFlow

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
post /buckets/{bucketId}/flows/{flowId}/versions
Create flow version (createFlowVersion)
Creates the next version of a flow. The version number of the object being created must be the next available version integer. Flow versions are immutable after they are created.

Path parameters

bucketId (required)
Path Parameter — The bucket identifier
flowId (required)
Path Parameter — The flow identifier

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body VersionedFlowSnapshot (required)
Body Parameter — The new versioned flow snapshot.

Query parameters

preserveSourceProperties (optional)
Query Parameter — Whether source properties like author should be kept

Return type

VersionedFlowSnapshot

Example data

Content-Type: application/json
{
  "bucket" : {
    "identifier" : "identifier",
    "allowBundleRedeploy" : true,
    "permissions" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "name" : "name",
    "description" : "description",
    "allowPublicRead" : true,
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "externalControllerServices" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name"
    }
  },
  "snapshotMetadata" : {
    "flowIdentifier" : "flowIdentifier",
    "comments" : "comments",
    "author" : "author",
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "bucketIdentifier" : "bucketIdentifier",
    "version" : 0,
    "timestamp" : 1
  },
  "flowContents" : {
    "processors" : [ {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 1,
      "propertyDescriptors" : { },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 1,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "backoffMechanism",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "schedulingPeriod" : "schedulingPeriod",
      "style" : {
        "key" : "style"
      },
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    }, {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 1,
      "propertyDescriptors" : { },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 1,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "backoffMechanism",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "schedulingPeriod" : "schedulingPeriod",
      "style" : {
        "key" : "style"
      },
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    } ],
    "scheduledState" : "ENABLED",
    "processGroups" : [ null, null ],
    "outputPorts" : [ null, null ],
    "funnels" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    } ],
    "versionedFlowCoordinates" : {
      "registryId" : "registryId",
      "storageLocation" : "storageLocation",
      "bucketId" : "bucketId",
      "branch" : "branch",
      "flowId" : "flowId",
      "version" : "version",
      "latest" : true
    },
    "connections" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "loadBalanceCompression",
      "destination" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "loadBalanceStrategy",
      "labelIndex" : 5,
      "bends" : [ {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      }, {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      } ],
      "backPressureObjectThreshold" : 0,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 5
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "loadBalanceCompression",
      "destination" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "loadBalanceStrategy",
      "labelIndex" : 5,
      "bends" : [ {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      }, {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      } ],
      "backPressureObjectThreshold" : 0,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 5
    } ],
    "logFileSuffix" : "logFileSuffix",
    "parameterContextName" : "parameterContextName",
    "componentType" : "CONNECTION",
    "identifier" : "identifier",
    "defaultBackPressureObjectThreshold" : 2,
    "comments" : "comments",
    "executionEngine" : "STANDARD",
    "defaultBackPressureDataSizeThreshold" : "defaultBackPressureDataSizeThreshold",
    "labels" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "width" : 3.616076749251911,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "height" : 9.301444243932576,
      "zIndex" : 2
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "width" : 3.616076749251911,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "height" : 9.301444243932576,
      "zIndex" : 2
    } ],
    "controllerServices" : [ {
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "dynamic" : true,
          "sensitive" : true,
          "listenPortDefinition" : {
            "applicationProtocols" : [ "applicationProtocols", "applicationProtocols" ],
            "transportProtocol" : "TCP"
          }
        }
      },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "componentState" : {
        "localNodeStates" : [ {
          "state" : {
            "key" : "state"
          }
        }, {
          "state" : {
            "key" : "state"
          }
        } ],
        "clusterState" : {
          "key" : "clusterState"
        }
      },
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "properties" : {
        "key" : "properties"
      }
    }, {
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "dynamic" : true,
          "sensitive" : true,
          "listenPortDefinition" : {
            "applicationProtocols" : [ "applicationProtocols", "applicationProtocols" ],
            "transportProtocol" : "TCP"
          }
        }
      },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "componentState" : {
        "localNodeStates" : [ {
          "state" : {
            "key" : "state"
          }
        }, {
          "state" : {
            "key" : "state"
          }
        } ],
        "clusterState" : {
          "key" : "clusterState"
        }
      },
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "properties" : {
        "key" : "properties"
      }
    } ],
    "defaultFlowFileExpiration" : "defaultFlowFileExpiration",
    "flowFileConcurrency" : "flowFileConcurrency",
    "flowFileOutboundPolicy" : "flowFileOutboundPolicy",
    "name" : "name",
    "inputPorts" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "portFunction" : "STANDARD",
      "groupIdentifier" : "groupIdentifier",
      "type" : "INPUT_PORT",
      "scheduledState" : "ENABLED"
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "portFunction" : "STANDARD",
      "groupIdentifier" : "groupIdentifier",
      "type" : "INPUT_PORT",
      "scheduledState" : "ENABLED"
    } ],
    "instanceIdentifier" : "instanceIdentifier",
    "maxConcurrentTasks" : 4,
    "statelessFlowTimeout" : "statelessFlowTimeout",
    "groupIdentifier" : "groupIdentifier",
    "remoteProcessGroups" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 7,
      "outputPorts" : [ null, null ],
      "transportProtocol" : "transportProtocol",
      "name" : "name",
      "proxyUser" : "proxyUser",
      "inputPorts" : [ {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "targetUris" : "targetUris",
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 7,
      "outputPorts" : [ null, null ],
      "transportProtocol" : "transportProtocol",
      "name" : "name",
      "proxyUser" : "proxyUser",
      "inputPorts" : [ {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "targetUris" : "targetUris",
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    } ]
  },
  "parameterProviders" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name",
      "type" : "type"
    }
  },
  "flow" : {
    "versionCount" : 0,
    "bucketName" : "bucketName",
    "identifier" : "identifier",
    "permissions" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "name" : "name",
    "description" : "description",
    "modifiedTimestamp" : 1,
    "bucketIdentifier" : "bucketIdentifier",
    "type" : "Flow",
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "flowEncodingVersion" : "flowEncodingVersion",
  "latest" : true,
  "parameterContexts" : {
    "key" : {
      "parameterGroupName" : "parameterGroupName",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "synchronized" : true,
      "comments" : "comments",
      "description" : "description",
      "inheritedParameterContexts" : [ "inheritedParameterContexts", "inheritedParameterContexts" ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "parameterProvider" : "parameterProvider",
      "parameters" : [ {
        "referencedAssets" : [ {
          "identifier" : "identifier",
          "name" : "name"
        }, {
          "identifier" : "identifier",
          "name" : "name"
        } ],
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      }, {
        "referencedAssets" : [ {
          "identifier" : "identifier",
          "name" : "name"
        }, {
          "identifier" : "identifier",
          "name" : "name"
        } ],
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      } ]
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VersionedFlowSnapshot

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
delete /buckets/{bucketId}/flows/{flowId}
Delete bucket flow (deleteFlow)
Deletes a flow, including all saved versions of that flow.

Path parameters

bucketId (required)
Path Parameter — The bucket identifier
flowId (required)
Path Parameter — The flow identifier

Query parameters

version (required)
Query Parameter — The version is used to verify the client is working with the latest version of the entity.
clientId (optional)
Query Parameter — If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

Return type

VersionedFlow

Example data

Content-Type: application/json
{
  "versionCount" : 0,
  "bucketName" : "bucketName",
  "identifier" : "identifier",
  "permissions" : {
    "canRead" : true,
    "canDelete" : true,
    "canWrite" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "name" : "name",
  "description" : "description",
  "modifiedTimestamp" : 1,
  "bucketIdentifier" : "bucketIdentifier",
  "type" : "Flow",
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VersionedFlow

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}/export
Exports specified bucket flow version content (exportVersionedFlow)
Exports the specified version of a flow, including the metadata and content of the flow.

Path parameters

bucketId (required)
Path Parameter — The bucket identifier
flowId (required)
Path Parameter — The flow identifier
versionNumber (required)
Path Parameter — The version number format: int32

Return type

VersionedFlowSnapshot

Example data

Content-Type: application/json
{
  "bucket" : {
    "identifier" : "identifier",
    "allowBundleRedeploy" : true,
    "permissions" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "name" : "name",
    "description" : "description",
    "allowPublicRead" : true,
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "externalControllerServices" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name"
    }
  },
  "snapshotMetadata" : {
    "flowIdentifier" : "flowIdentifier",
    "comments" : "comments",
    "author" : "author",
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "bucketIdentifier" : "bucketIdentifier",
    "version" : 0,
    "timestamp" : 1
  },
  "flowContents" : {
    "processors" : [ {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 1,
      "propertyDescriptors" : { },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 1,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "backoffMechanism",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "schedulingPeriod" : "schedulingPeriod",
      "style" : {
        "key" : "style"
      },
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    }, {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 1,
      "propertyDescriptors" : { },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 1,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "backoffMechanism",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "schedulingPeriod" : "schedulingPeriod",
      "style" : {
        "key" : "style"
      },
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    } ],
    "scheduledState" : "ENABLED",
    "processGroups" : [ null, null ],
    "outputPorts" : [ null, null ],
    "funnels" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    } ],
    "versionedFlowCoordinates" : {
      "registryId" : "registryId",
      "storageLocation" : "storageLocation",
      "bucketId" : "bucketId",
      "branch" : "branch",
      "flowId" : "flowId",
      "version" : "version",
      "latest" : true
    },
    "connections" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "loadBalanceCompression",
      "destination" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "loadBalanceStrategy",
      "labelIndex" : 5,
      "bends" : [ {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      }, {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      } ],
      "backPressureObjectThreshold" : 0,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 5
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "loadBalanceCompression",
      "destination" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "loadBalanceStrategy",
      "labelIndex" : 5,
      "bends" : [ {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      }, {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      } ],
      "backPressureObjectThreshold" : 0,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 5
    } ],
    "logFileSuffix" : "logFileSuffix",
    "parameterContextName" : "parameterContextName",
    "componentType" : "CONNECTION",
    "identifier" : "identifier",
    "defaultBackPressureObjectThreshold" : 2,
    "comments" : "comments",
    "executionEngine" : "STANDARD",
    "defaultBackPressureDataSizeThreshold" : "defaultBackPressureDataSizeThreshold",
    "labels" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "width" : 3.616076749251911,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "height" : 9.301444243932576,
      "zIndex" : 2
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "width" : 3.616076749251911,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "height" : 9.301444243932576,
      "zIndex" : 2
    } ],
    "controllerServices" : [ {
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "dynamic" : true,
          "sensitive" : true,
          "listenPortDefinition" : {
            "applicationProtocols" : [ "applicationProtocols", "applicationProtocols" ],
            "transportProtocol" : "TCP"
          }
        }
      },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "componentState" : {
        "localNodeStates" : [ {
          "state" : {
            "key" : "state"
          }
        }, {
          "state" : {
            "key" : "state"
          }
        } ],
        "clusterState" : {
          "key" : "clusterState"
        }
      },
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "properties" : {
        "key" : "properties"
      }
    }, {
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "dynamic" : true,
          "sensitive" : true,
          "listenPortDefinition" : {
            "applicationProtocols" : [ "applicationProtocols", "applicationProtocols" ],
            "transportProtocol" : "TCP"
          }
        }
      },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "componentState" : {
        "localNodeStates" : [ {
          "state" : {
            "key" : "state"
          }
        }, {
          "state" : {
            "key" : "state"
          }
        } ],
        "clusterState" : {
          "key" : "clusterState"
        }
      },
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "properties" : {
        "key" : "properties"
      }
    } ],
    "defaultFlowFileExpiration" : "defaultFlowFileExpiration",
    "flowFileConcurrency" : "flowFileConcurrency",
    "flowFileOutboundPolicy" : "flowFileOutboundPolicy",
    "name" : "name",
    "inputPorts" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "portFunction" : "STANDARD",
      "groupIdentifier" : "groupIdentifier",
      "type" : "INPUT_PORT",
      "scheduledState" : "ENABLED"
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "portFunction" : "STANDARD",
      "groupIdentifier" : "groupIdentifier",
      "type" : "INPUT_PORT",
      "scheduledState" : "ENABLED"
    } ],
    "instanceIdentifier" : "instanceIdentifier",
    "maxConcurrentTasks" : 4,
    "statelessFlowTimeout" : "statelessFlowTimeout",
    "groupIdentifier" : "groupIdentifier",
    "remoteProcessGroups" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 7,
      "outputPorts" : [ null, null ],
      "transportProtocol" : "transportProtocol",
      "name" : "name",
      "proxyUser" : "proxyUser",
      "inputPorts" : [ {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "targetUris" : "targetUris",
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 7,
      "outputPorts" : [ null, null ],
      "transportProtocol" : "transportProtocol",
      "name" : "name",
      "proxyUser" : "proxyUser",
      "inputPorts" : [ {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "targetUris" : "targetUris",
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    } ]
  },
  "parameterProviders" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name",
      "type" : "type"
    }
  },
  "flow" : {
    "versionCount" : 0,
    "bucketName" : "bucketName",
    "identifier" : "identifier",
    "permissions" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "name" : "name",
    "description" : "description",
    "modifiedTimestamp" : 1,
    "bucketIdentifier" : "bucketIdentifier",
    "type" : "Flow",
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "flowEncodingVersion" : "flowEncodingVersion",
  "latest" : true,
  "parameterContexts" : {
    "key" : {
      "parameterGroupName" : "parameterGroupName",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "synchronized" : true,
      "comments" : "comments",
      "description" : "description",
      "inheritedParameterContexts" : [ "inheritedParameterContexts", "inheritedParameterContexts" ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "parameterProvider" : "parameterProvider",
      "parameters" : [ {
        "referencedAssets" : [ {
          "identifier" : "identifier",
          "name" : "name"
        }, {
          "identifier" : "identifier",
          "name" : "name"
        } ],
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      }, {
        "referencedAssets" : [ {
          "identifier" : "identifier",
          "name" : "name"
        }, {
          "identifier" : "identifier",
          "name" : "name"
        } ],
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      } ]
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VersionedFlowSnapshot

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /buckets/{bucketId}/flows/{flowId}
Get bucket flow (getFlow)
Retrieves the flow with the given id in the given bucket.

Path parameters

bucketId (required)
Path Parameter — The bucket identifier
flowId (required)
Path Parameter — The flow identifier

Return type

VersionedFlow

Example data

Content-Type: application/json
{
  "versionCount" : 0,
  "bucketName" : "bucketName",
  "identifier" : "identifier",
  "permissions" : {
    "canRead" : true,
    "canDelete" : true,
    "canWrite" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "name" : "name",
  "description" : "description",
  "modifiedTimestamp" : 1,
  "bucketIdentifier" : "bucketIdentifier",
  "type" : "Flow",
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VersionedFlow

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB}
Get bucket flow diff (getFlowDiff)
Computes the differences between two given versions of a flow.

Path parameters

bucketId (required)
Path Parameter — The bucket identifier
flowId (required)
Path Parameter — The flow identifier
versionA (required)
Path Parameter — The first version number format: int32
versionB (required)
Path Parameter — The second version number format: int32

Return type

VersionedFlowDifference

Example data

Content-Type: application/json
{
  "versionB" : 6,
  "versionA" : 0,
  "bucketId" : "bucketId",
  "componentDifferenceGroups" : [ {
    "componentType" : "componentType",
    "componentId" : "componentId",
    "processGroupId" : "processGroupId",
    "differences" : [ {
      "differenceType" : "differenceType",
      "differenceTypeDescription" : "differenceTypeDescription",
      "changeDescription" : "changeDescription",
      "valueB" : "valueB",
      "valueA" : "valueA"
    }, {
      "differenceType" : "differenceType",
      "differenceTypeDescription" : "differenceTypeDescription",
      "changeDescription" : "changeDescription",
      "valueB" : "valueB",
      "valueA" : "valueA"
    } ],
    "componentName" : "componentName"
  }, {
    "componentType" : "componentType",
    "componentId" : "componentId",
    "processGroupId" : "processGroupId",
    "differences" : [ {
      "differenceType" : "differenceType",
      "differenceTypeDescription" : "differenceTypeDescription",
      "changeDescription" : "changeDescription",
      "valueB" : "valueB",
      "valueA" : "valueA"
    }, {
      "differenceType" : "differenceType",
      "differenceTypeDescription" : "differenceTypeDescription",
      "changeDescription" : "changeDescription",
      "valueB" : "valueB",
      "valueA" : "valueA"
    } ],
    "componentName" : "componentName"
  } ],
  "flowId" : "flowId"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VersionedFlowDifference

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}
Get bucket flow version (getFlowVersion)
Gets the given version of a flow, including the metadata and content for the version.

Path parameters

bucketId (required)
Path Parameter — The bucket identifier
flowId (required)
Path Parameter — The flow identifier
versionNumber (required)
Path Parameter — The version number format: int32

Return type

VersionedFlowSnapshot

Example data

Content-Type: application/json
{
  "bucket" : {
    "identifier" : "identifier",
    "allowBundleRedeploy" : true,
    "permissions" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "name" : "name",
    "description" : "description",
    "allowPublicRead" : true,
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "externalControllerServices" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name"
    }
  },
  "snapshotMetadata" : {
    "flowIdentifier" : "flowIdentifier",
    "comments" : "comments",
    "author" : "author",
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "bucketIdentifier" : "bucketIdentifier",
    "version" : 0,
    "timestamp" : 1
  },
  "flowContents" : {
    "processors" : [ {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 1,
      "propertyDescriptors" : { },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 1,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "backoffMechanism",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "schedulingPeriod" : "schedulingPeriod",
      "style" : {
        "key" : "style"
      },
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    }, {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 1,
      "propertyDescriptors" : { },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 1,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "backoffMechanism",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "schedulingPeriod" : "schedulingPeriod",
      "style" : {
        "key" : "style"
      },
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    } ],
    "scheduledState" : "ENABLED",
    "processGroups" : [ null, null ],
    "outputPorts" : [ null, null ],
    "funnels" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    } ],
    "versionedFlowCoordinates" : {
      "registryId" : "registryId",
      "storageLocation" : "storageLocation",
      "bucketId" : "bucketId",
      "branch" : "branch",
      "flowId" : "flowId",
      "version" : "version",
      "latest" : true
    },
    "connections" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "loadBalanceCompression",
      "destination" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "loadBalanceStrategy",
      "labelIndex" : 5,
      "bends" : [ {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      }, {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      } ],
      "backPressureObjectThreshold" : 0,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 5
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "loadBalanceCompression",
      "destination" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "loadBalanceStrategy",
      "labelIndex" : 5,
      "bends" : [ {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      }, {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      } ],
      "backPressureObjectThreshold" : 0,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 5
    } ],
    "logFileSuffix" : "logFileSuffix",
    "parameterContextName" : "parameterContextName",
    "componentType" : "CONNECTION",
    "identifier" : "identifier",
    "defaultBackPressureObjectThreshold" : 2,
    "comments" : "comments",
    "executionEngine" : "STANDARD",
    "defaultBackPressureDataSizeThreshold" : "defaultBackPressureDataSizeThreshold",
    "labels" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "width" : 3.616076749251911,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "height" : 9.301444243932576,
      "zIndex" : 2
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "width" : 3.616076749251911,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "height" : 9.301444243932576,
      "zIndex" : 2
    } ],
    "controllerServices" : [ {
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "dynamic" : true,
          "sensitive" : true,
          "listenPortDefinition" : {
            "applicationProtocols" : [ "applicationProtocols", "applicationProtocols" ],
            "transportProtocol" : "TCP"
          }
        }
      },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "componentState" : {
        "localNodeStates" : [ {
          "state" : {
            "key" : "state"
          }
        }, {
          "state" : {
            "key" : "state"
          }
        } ],
        "clusterState" : {
          "key" : "clusterState"
        }
      },
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "properties" : {
        "key" : "properties"
      }
    }, {
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "dynamic" : true,
          "sensitive" : true,
          "listenPortDefinition" : {
            "applicationProtocols" : [ "applicationProtocols", "applicationProtocols" ],
            "transportProtocol" : "TCP"
          }
        }
      },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "componentState" : {
        "localNodeStates" : [ {
          "state" : {
            "key" : "state"
          }
        }, {
          "state" : {
            "key" : "state"
          }
        } ],
        "clusterState" : {
          "key" : "clusterState"
        }
      },
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "properties" : {
        "key" : "properties"
      }
    } ],
    "defaultFlowFileExpiration" : "defaultFlowFileExpiration",
    "flowFileConcurrency" : "flowFileConcurrency",
    "flowFileOutboundPolicy" : "flowFileOutboundPolicy",
    "name" : "name",
    "inputPorts" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "portFunction" : "STANDARD",
      "groupIdentifier" : "groupIdentifier",
      "type" : "INPUT_PORT",
      "scheduledState" : "ENABLED"
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "portFunction" : "STANDARD",
      "groupIdentifier" : "groupIdentifier",
      "type" : "INPUT_PORT",
      "scheduledState" : "ENABLED"
    } ],
    "instanceIdentifier" : "instanceIdentifier",
    "maxConcurrentTasks" : 4,
    "statelessFlowTimeout" : "statelessFlowTimeout",
    "groupIdentifier" : "groupIdentifier",
    "remoteProcessGroups" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 7,
      "outputPorts" : [ null, null ],
      "transportProtocol" : "transportProtocol",
      "name" : "name",
      "proxyUser" : "proxyUser",
      "inputPorts" : [ {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "targetUris" : "targetUris",
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 7,
      "outputPorts" : [ null, null ],
      "transportProtocol" : "transportProtocol",
      "name" : "name",
      "proxyUser" : "proxyUser",
      "inputPorts" : [ {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "targetUris" : "targetUris",
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    } ]
  },
  "parameterProviders" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name",
      "type" : "type"
    }
  },
  "flow" : {
    "versionCount" : 0,
    "bucketName" : "bucketName",
    "identifier" : "identifier",
    "permissions" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "name" : "name",
    "description" : "description",
    "modifiedTimestamp" : 1,
    "bucketIdentifier" : "bucketIdentifier",
    "type" : "Flow",
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "flowEncodingVersion" : "flowEncodingVersion",
  "latest" : true,
  "parameterContexts" : {
    "key" : {
      "parameterGroupName" : "parameterGroupName",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "synchronized" : true,
      "comments" : "comments",
      "description" : "description",
      "inheritedParameterContexts" : [ "inheritedParameterContexts", "inheritedParameterContexts" ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "parameterProvider" : "parameterProvider",
      "parameters" : [ {
        "referencedAssets" : [ {
          "identifier" : "identifier",
          "name" : "name"
        }, {
          "identifier" : "identifier",
          "name" : "name"
        } ],
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      }, {
        "referencedAssets" : [ {
          "identifier" : "identifier",
          "name" : "name"
        }, {
          "identifier" : "identifier",
          "name" : "name"
        } ],
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      } ]
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VersionedFlowSnapshot

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /buckets/{bucketId}/flows/{flowId}/versions
Get bucket flow versions (getFlowVersions)
Gets summary information for all versions of a flow. Versions are ordered newest->oldest.

Path parameters

bucketId (required)
Path Parameter — The bucket identifier
flowId (required)
Path Parameter — The flow identifier

Return type

array[VersionedFlowSnapshotMetadata]

Example data

Content-Type: application/json
[ {
  "flowIdentifier" : "flowIdentifier",
  "comments" : "comments",
  "author" : "author",
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "bucketIdentifier" : "bucketIdentifier",
  "version" : 0,
  "timestamp" : 1
}, {
  "flowIdentifier" : "flowIdentifier",
  "comments" : "comments",
  "author" : "author",
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "bucketIdentifier" : "bucketIdentifier",
  "version" : 0,
  "timestamp" : 1
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /buckets/{bucketId}/flows
Get bucket flows (getFlows)
Retrieves all flows in the given bucket.

Path parameters

bucketId (required)
Path Parameter — The bucket identifier

Return type

array[VersionedFlow]

Example data

Content-Type: application/json
[ {
  "versionCount" : 0,
  "bucketName" : "bucketName",
  "identifier" : "identifier",
  "permissions" : {
    "canRead" : true,
    "canDelete" : true,
    "canWrite" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "name" : "name",
  "description" : "description",
  "modifiedTimestamp" : 1,
  "bucketIdentifier" : "bucketIdentifier",
  "type" : "Flow",
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}, {
  "versionCount" : 0,
  "bucketName" : "bucketName",
  "identifier" : "identifier",
  "permissions" : {
    "canRead" : true,
    "canDelete" : true,
    "canWrite" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "name" : "name",
  "description" : "description",
  "modifiedTimestamp" : 1,
  "bucketIdentifier" : "bucketIdentifier",
  "type" : "Flow",
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /buckets/{bucketId}/flows/{flowId}/versions/latest
Get latest bucket flow version content (getLatestFlowVersion)
Gets the latest version of a flow, including the metadata and content of the flow.

Path parameters

bucketId (required)
Path Parameter — The bucket identifier
flowId (required)
Path Parameter — The flow identifier

Return type

VersionedFlowSnapshot

Example data

Content-Type: application/json
{
  "bucket" : {
    "identifier" : "identifier",
    "allowBundleRedeploy" : true,
    "permissions" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "name" : "name",
    "description" : "description",
    "allowPublicRead" : true,
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "externalControllerServices" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name"
    }
  },
  "snapshotMetadata" : {
    "flowIdentifier" : "flowIdentifier",
    "comments" : "comments",
    "author" : "author",
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "bucketIdentifier" : "bucketIdentifier",
    "version" : 0,
    "timestamp" : 1
  },
  "flowContents" : {
    "processors" : [ {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 1,
      "propertyDescriptors" : { },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 1,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "backoffMechanism",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "schedulingPeriod" : "schedulingPeriod",
      "style" : {
        "key" : "style"
      },
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    }, {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 1,
      "propertyDescriptors" : { },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 1,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "backoffMechanism",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "schedulingPeriod" : "schedulingPeriod",
      "style" : {
        "key" : "style"
      },
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    } ],
    "scheduledState" : "ENABLED",
    "processGroups" : [ null, null ],
    "outputPorts" : [ null, null ],
    "funnels" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    } ],
    "versionedFlowCoordinates" : {
      "registryId" : "registryId",
      "storageLocation" : "storageLocation",
      "bucketId" : "bucketId",
      "branch" : "branch",
      "flowId" : "flowId",
      "version" : "version",
      "latest" : true
    },
    "connections" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "loadBalanceCompression",
      "destination" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "loadBalanceStrategy",
      "labelIndex" : 5,
      "bends" : [ {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      }, {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      } ],
      "backPressureObjectThreshold" : 0,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 5
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "loadBalanceCompression",
      "destination" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "loadBalanceStrategy",
      "labelIndex" : 5,
      "bends" : [ {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      }, {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      } ],
      "backPressureObjectThreshold" : 0,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 5
    } ],
    "logFileSuffix" : "logFileSuffix",
    "parameterContextName" : "parameterContextName",
    "componentType" : "CONNECTION",
    "identifier" : "identifier",
    "defaultBackPressureObjectThreshold" : 2,
    "comments" : "comments",
    "executionEngine" : "STANDARD",
    "defaultBackPressureDataSizeThreshold" : "defaultBackPressureDataSizeThreshold",
    "labels" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "width" : 3.616076749251911,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "height" : 9.301444243932576,
      "zIndex" : 2
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "width" : 3.616076749251911,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "height" : 9.301444243932576,
      "zIndex" : 2
    } ],
    "controllerServices" : [ {
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "dynamic" : true,
          "sensitive" : true,
          "listenPortDefinition" : {
            "applicationProtocols" : [ "applicationProtocols", "applicationProtocols" ],
            "transportProtocol" : "TCP"
          }
        }
      },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "componentState" : {
        "localNodeStates" : [ {
          "state" : {
            "key" : "state"
          }
        }, {
          "state" : {
            "key" : "state"
          }
        } ],
        "clusterState" : {
          "key" : "clusterState"
        }
      },
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "properties" : {
        "key" : "properties"
      }
    }, {
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "dynamic" : true,
          "sensitive" : true,
          "listenPortDefinition" : {
            "applicationProtocols" : [ "applicationProtocols", "applicationProtocols" ],
            "transportProtocol" : "TCP"
          }
        }
      },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "componentState" : {
        "localNodeStates" : [ {
          "state" : {
            "key" : "state"
          }
        }, {
          "state" : {
            "key" : "state"
          }
        } ],
        "clusterState" : {
          "key" : "clusterState"
        }
      },
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "properties" : {
        "key" : "properties"
      }
    } ],
    "defaultFlowFileExpiration" : "defaultFlowFileExpiration",
    "flowFileConcurrency" : "flowFileConcurrency",
    "flowFileOutboundPolicy" : "flowFileOutboundPolicy",
    "name" : "name",
    "inputPorts" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "portFunction" : "STANDARD",
      "groupIdentifier" : "groupIdentifier",
      "type" : "INPUT_PORT",
      "scheduledState" : "ENABLED"
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "portFunction" : "STANDARD",
      "groupIdentifier" : "groupIdentifier",
      "type" : "INPUT_PORT",
      "scheduledState" : "ENABLED"
    } ],
    "instanceIdentifier" : "instanceIdentifier",
    "maxConcurrentTasks" : 4,
    "statelessFlowTimeout" : "statelessFlowTimeout",
    "groupIdentifier" : "groupIdentifier",
    "remoteProcessGroups" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 7,
      "outputPorts" : [ null, null ],
      "transportProtocol" : "transportProtocol",
      "name" : "name",
      "proxyUser" : "proxyUser",
      "inputPorts" : [ {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "targetUris" : "targetUris",
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 7,
      "outputPorts" : [ null, null ],
      "transportProtocol" : "transportProtocol",
      "name" : "name",
      "proxyUser" : "proxyUser",
      "inputPorts" : [ {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "targetUris" : "targetUris",
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    } ]
  },
  "parameterProviders" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name",
      "type" : "type"
    }
  },
  "flow" : {
    "versionCount" : 0,
    "bucketName" : "bucketName",
    "identifier" : "identifier",
    "permissions" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "name" : "name",
    "description" : "description",
    "modifiedTimestamp" : 1,
    "bucketIdentifier" : "bucketIdentifier",
    "type" : "Flow",
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "flowEncodingVersion" : "flowEncodingVersion",
  "latest" : true,
  "parameterContexts" : {
    "key" : {
      "parameterGroupName" : "parameterGroupName",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "synchronized" : true,
      "comments" : "comments",
      "description" : "description",
      "inheritedParameterContexts" : [ "inheritedParameterContexts", "inheritedParameterContexts" ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "parameterProvider" : "parameterProvider",
      "parameters" : [ {
        "referencedAssets" : [ {
          "identifier" : "identifier",
          "name" : "name"
        }, {
          "identifier" : "identifier",
          "name" : "name"
        } ],
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      }, {
        "referencedAssets" : [ {
          "identifier" : "identifier",
          "name" : "name"
        }, {
          "identifier" : "identifier",
          "name" : "name"
        } ],
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      } ]
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VersionedFlowSnapshot

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /buckets/{bucketId}/flows/{flowId}/versions/latest/metadata
Get latest bucket flow version metadata (getLatestFlowVersionMetadata)
Gets the metadata for the latest version of a flow.

Path parameters

bucketId (required)
Path Parameter — The bucket identifier
flowId (required)
Path Parameter — The flow identifier

Return type

VersionedFlowSnapshotMetadata

Example data

Content-Type: application/json
{
  "flowIdentifier" : "flowIdentifier",
  "comments" : "comments",
  "author" : "author",
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "bucketIdentifier" : "bucketIdentifier",
  "version" : 0,
  "timestamp" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VersionedFlowSnapshotMetadata

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
post /buckets/{bucketId}/flows/{flowId}/versions/import
Import flow version (importVersionedFlow)
Import the next version of a flow. The version number of the object being created will be the next available version integer. Flow versions are immutable after they are created.

Path parameters

bucketId (required)
Path Parameter — The bucket identifier
flowId (required)
Path Parameter — The flow identifier

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body VersionedFlowSnapshot (optional)
Body Parameter — file

Request headers

Return type

VersionedFlowSnapshot

Example data

Content-Type: application/json
{
  "bucket" : {
    "identifier" : "identifier",
    "allowBundleRedeploy" : true,
    "permissions" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "name" : "name",
    "description" : "description",
    "allowPublicRead" : true,
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "externalControllerServices" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name"
    }
  },
  "snapshotMetadata" : {
    "flowIdentifier" : "flowIdentifier",
    "comments" : "comments",
    "author" : "author",
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "bucketIdentifier" : "bucketIdentifier",
    "version" : 0,
    "timestamp" : 1
  },
  "flowContents" : {
    "processors" : [ {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 1,
      "propertyDescriptors" : { },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 1,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "backoffMechanism",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "schedulingPeriod" : "schedulingPeriod",
      "style" : {
        "key" : "style"
      },
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    }, {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 1,
      "propertyDescriptors" : { },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 1,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "backoffMechanism",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "schedulingPeriod" : "schedulingPeriod",
      "style" : {
        "key" : "style"
      },
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    } ],
    "scheduledState" : "ENABLED",
    "processGroups" : [ null, null ],
    "outputPorts" : [ null, null ],
    "funnels" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    } ],
    "versionedFlowCoordinates" : {
      "registryId" : "registryId",
      "storageLocation" : "storageLocation",
      "bucketId" : "bucketId",
      "branch" : "branch",
      "flowId" : "flowId",
      "version" : "version",
      "latest" : true
    },
    "connections" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "loadBalanceCompression",
      "destination" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "loadBalanceStrategy",
      "labelIndex" : 5,
      "bends" : [ {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      }, {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      } ],
      "backPressureObjectThreshold" : 0,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 5
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "loadBalanceCompression",
      "destination" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "loadBalanceStrategy",
      "labelIndex" : 5,
      "bends" : [ {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      }, {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      } ],
      "backPressureObjectThreshold" : 0,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 5
    } ],
    "logFileSuffix" : "logFileSuffix",
    "parameterContextName" : "parameterContextName",
    "componentType" : "CONNECTION",
    "identifier" : "identifier",
    "defaultBackPressureObjectThreshold" : 2,
    "comments" : "comments",
    "executionEngine" : "STANDARD",
    "defaultBackPressureDataSizeThreshold" : "defaultBackPressureDataSizeThreshold",
    "labels" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "width" : 3.616076749251911,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "height" : 9.301444243932576,
      "zIndex" : 2
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "width" : 3.616076749251911,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "height" : 9.301444243932576,
      "zIndex" : 2
    } ],
    "controllerServices" : [ {
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "dynamic" : true,
          "sensitive" : true,
          "listenPortDefinition" : {
            "applicationProtocols" : [ "applicationProtocols", "applicationProtocols" ],
            "transportProtocol" : "TCP"
          }
        }
      },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "componentState" : {
        "localNodeStates" : [ {
          "state" : {
            "key" : "state"
          }
        }, {
          "state" : {
            "key" : "state"
          }
        } ],
        "clusterState" : {
          "key" : "clusterState"
        }
      },
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "properties" : {
        "key" : "properties"
      }
    }, {
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "dynamic" : true,
          "sensitive" : true,
          "listenPortDefinition" : {
            "applicationProtocols" : [ "applicationProtocols", "applicationProtocols" ],
            "transportProtocol" : "TCP"
          }
        }
      },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "componentState" : {
        "localNodeStates" : [ {
          "state" : {
            "key" : "state"
          }
        }, {
          "state" : {
            "key" : "state"
          }
        } ],
        "clusterState" : {
          "key" : "clusterState"
        }
      },
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "properties" : {
        "key" : "properties"
      }
    } ],
    "defaultFlowFileExpiration" : "defaultFlowFileExpiration",
    "flowFileConcurrency" : "flowFileConcurrency",
    "flowFileOutboundPolicy" : "flowFileOutboundPolicy",
    "name" : "name",
    "inputPorts" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "portFunction" : "STANDARD",
      "groupIdentifier" : "groupIdentifier",
      "type" : "INPUT_PORT",
      "scheduledState" : "ENABLED"
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "portFunction" : "STANDARD",
      "groupIdentifier" : "groupIdentifier",
      "type" : "INPUT_PORT",
      "scheduledState" : "ENABLED"
    } ],
    "instanceIdentifier" : "instanceIdentifier",
    "maxConcurrentTasks" : 4,
    "statelessFlowTimeout" : "statelessFlowTimeout",
    "groupIdentifier" : "groupIdentifier",
    "remoteProcessGroups" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 7,
      "outputPorts" : [ null, null ],
      "transportProtocol" : "transportProtocol",
      "name" : "name",
      "proxyUser" : "proxyUser",
      "inputPorts" : [ {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "targetUris" : "targetUris",
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 7,
      "outputPorts" : [ null, null ],
      "transportProtocol" : "transportProtocol",
      "name" : "name",
      "proxyUser" : "proxyUser",
      "inputPorts" : [ {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "targetUris" : "targetUris",
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    } ]
  },
  "parameterProviders" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name",
      "type" : "type"
    }
  },
  "flow" : {
    "versionCount" : 0,
    "bucketName" : "bucketName",
    "identifier" : "identifier",
    "permissions" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "name" : "name",
    "description" : "description",
    "modifiedTimestamp" : 1,
    "bucketIdentifier" : "bucketIdentifier",
    "type" : "Flow",
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "flowEncodingVersion" : "flowEncodingVersion",
  "latest" : true,
  "parameterContexts" : {
    "key" : {
      "parameterGroupName" : "parameterGroupName",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "synchronized" : true,
      "comments" : "comments",
      "description" : "description",
      "inheritedParameterContexts" : [ "inheritedParameterContexts", "inheritedParameterContexts" ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "parameterProvider" : "parameterProvider",
      "parameters" : [ {
        "referencedAssets" : [ {
          "identifier" : "identifier",
          "name" : "name"
        }, {
          "identifier" : "identifier",
          "name" : "name"
        } ],
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      }, {
        "referencedAssets" : [ {
          "identifier" : "identifier",
          "name" : "name"
        }, {
          "identifier" : "identifier",
          "name" : "name"
        } ],
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      } ]
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

The resource has been successfully created. VersionedFlowSnapshot

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
put /buckets/{bucketId}/flows/{flowId}
Update bucket flow (updateFlow)
Updates the flow with the given id in the given bucket.

Path parameters

bucketId (required)
Path Parameter — The bucket identifier
flowId (required)
Path Parameter — The flow identifier

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body VersionedFlow (required)
Body Parameter — The updated flow

Return type

VersionedFlow

Example data

Content-Type: application/json
{
  "versionCount" : 0,
  "bucketName" : "bucketName",
  "identifier" : "identifier",
  "permissions" : {
    "canRead" : true,
    "canDelete" : true,
    "canWrite" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "name" : "name",
  "description" : "description",
  "modifiedTimestamp" : 1,
  "bucketIdentifier" : "bucketIdentifier",
  "type" : "Flow",
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VersionedFlow

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.

Buckets

Up 
post /buckets
Create bucket (createBucket)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Bucket (required)
Body Parameter — The bucket to create

Query parameters

preserveSourceProperties (optional)
Query Parameter — Whether source properties like identifier should be kept

Return type

Bucket

Example data

Content-Type: application/json
{
  "identifier" : "identifier",
  "allowBundleRedeploy" : true,
  "permissions" : {
    "canRead" : true,
    "canDelete" : true,
    "canWrite" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "name" : "name",
  "description" : "description",
  "allowPublicRead" : true,
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Bucket

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.
Up 
delete /buckets/{bucketId}
Delete bucket (deleteBucket)
Deletes the bucket with the given id, along with all objects stored in the bucket

Path parameters

bucketId (required)
Path Parameter — The bucket identifier

Query parameters

version (required)
Query Parameter — The version is used to verify the client is working with the latest version of the entity.
clientId (optional)
Query Parameter — If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

Return type

Bucket

Example data

Content-Type: application/json
{
  "identifier" : "identifier",
  "allowBundleRedeploy" : true,
  "permissions" : {
    "canRead" : true,
    "canDelete" : true,
    "canWrite" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "name" : "name",
  "description" : "description",
  "allowPublicRead" : true,
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Bucket

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.
Up 
get /buckets/fields
Get bucket fields (getAvailableBucketFields)
Retrieves bucket field names for searching or sorting on buckets.

Return type

Fields

Example data

Content-Type: application/json
{
  "fields" : [ "fields", "fields" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Fields
Up 
get /buckets/{bucketId}
Get bucket (getBucket)
Gets the bucket with the given id.

Path parameters

bucketId (required)
Path Parameter — The bucket identifier

Return type

Bucket

Example data

Content-Type: application/json
{
  "identifier" : "identifier",
  "allowBundleRedeploy" : true,
  "permissions" : {
    "canRead" : true,
    "canDelete" : true,
    "canWrite" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "name" : "name",
  "description" : "description",
  "allowPublicRead" : true,
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Bucket

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.
Up 
get /buckets
Get all buckets (getBuckets)
The returned list will include only buckets for which the user is authorized.If the user is not authorized for any buckets, this returns an empty list.

Return type

array[Bucket]

Example data

Content-Type: application/json
[ {
  "identifier" : "identifier",
  "allowBundleRedeploy" : true,
  "permissions" : {
    "canRead" : true,
    "canDelete" : true,
    "canWrite" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "name" : "name",
  "description" : "description",
  "allowPublicRead" : true,
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}, {
  "identifier" : "identifier",
  "allowBundleRedeploy" : true,
  "permissions" : {
    "canRead" : true,
    "canDelete" : true,
    "canWrite" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "name" : "name",
  "description" : "description",
  "allowPublicRead" : true,
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

401

Client could not be authenticated.
Up 
put /buckets/{bucketId}
Update bucket (updateBucket)
Updates the bucket with the given id.

Path parameters

bucketId (required)
Path Parameter — The bucket identifier

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Bucket (required)
Body Parameter — The updated bucket

Return type

Bucket

Example data

Content-Type: application/json
{
  "identifier" : "identifier",
  "allowBundleRedeploy" : true,
  "permissions" : {
    "canRead" : true,
    "canDelete" : true,
    "canWrite" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "name" : "name",
  "description" : "description",
  "allowPublicRead" : true,
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Bucket

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.

Bundles

Up 
delete /bundles/{bundleId}
Delete bundle (deleteBundle)

Deletes the given extension bundle and all of it's versions.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

bundleId (required)
Path Parameter — The extension bundle identifier

Return type

Bundle

Example data

Content-Type: application/json
{
  "artifact" : "artifact",
  "version" : "version",
  "group" : "group"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Bundle

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
delete /bundles/{bundleId}/versions/{version}
Delete bundle version (deleteBundleVersion)

Deletes the given extension bundle version and it's associated binary content.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

bundleId (required)
Path Parameter — The extension bundle identifier
version (required)
Path Parameter — The version of the bundle

Return type

BundleVersion

Example data

Content-Type: application/json
{
  "bucket" : {
    "identifier" : "identifier",
    "allowBundleRedeploy" : true,
    "permissions" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "name" : "name",
    "description" : "description",
    "allowPublicRead" : true,
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "filename" : "filename",
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "versionMetadata" : {
    "sha256" : "sha256",
    "buildInfo" : {
      "buildBranch" : "buildBranch",
      "builtBy" : "builtBy",
      "buildRevision" : "buildRevision",
      "buildTag" : "buildTag",
      "built" : 0,
      "buildTool" : "buildTool",
      "buildFlags" : "buildFlags"
    },
    "author" : "author",
    "groupId" : "groupId",
    "bundleId" : "bundleId",
    "description" : "description",
    "bucketId" : "bucketId",
    "version" : "version",
    "sha256Supplied" : true,
    "contentSize" : 0,
    "artifactId" : "artifactId",
    "id" : "id",
    "systemApiVersion" : "systemApiVersion",
    "timestamp" : 1
  },
  "bundle" : {
    "artifact" : "artifact",
    "version" : "version",
    "group" : "group"
  },
  "dependencies" : [ {
    "groupId" : "groupId",
    "artifactId" : "artifactId",
    "version" : "version"
  }, {
    "groupId" : "groupId",
    "artifactId" : "artifactId",
    "version" : "version"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

BundleVersion

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /bundles/{bundleId}
Get bundle (getBundle)

Gets the metadata about an extension bundle.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

bundleId (required)
Path Parameter — The extension bundle identifier

Return type

Bundle

Example data

Content-Type: application/json
{
  "artifact" : "artifact",
  "version" : "version",
  "group" : "group"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Bundle

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /bundles/{bundleId}/versions/{version}
Get bundle version (getBundleVersion)

Gets the descriptor for the given version of the given extension bundle.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

bundleId (required)
Path Parameter — The extension bundle identifier
version (required)
Path Parameter — The version of the bundle

Return type

BundleVersion

Example data

Content-Type: application/json
{
  "bucket" : {
    "identifier" : "identifier",
    "allowBundleRedeploy" : true,
    "permissions" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "name" : "name",
    "description" : "description",
    "allowPublicRead" : true,
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "filename" : "filename",
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "versionMetadata" : {
    "sha256" : "sha256",
    "buildInfo" : {
      "buildBranch" : "buildBranch",
      "builtBy" : "builtBy",
      "buildRevision" : "buildRevision",
      "buildTag" : "buildTag",
      "built" : 0,
      "buildTool" : "buildTool",
      "buildFlags" : "buildFlags"
    },
    "author" : "author",
    "groupId" : "groupId",
    "bundleId" : "bundleId",
    "description" : "description",
    "bucketId" : "bucketId",
    "version" : "version",
    "sha256Supplied" : true,
    "contentSize" : 0,
    "artifactId" : "artifactId",
    "id" : "id",
    "systemApiVersion" : "systemApiVersion",
    "timestamp" : 1
  },
  "bundle" : {
    "artifact" : "artifact",
    "version" : "version",
    "group" : "group"
  },
  "dependencies" : [ {
    "groupId" : "groupId",
    "artifactId" : "artifactId",
    "version" : "version"
  }, {
    "groupId" : "groupId",
    "artifactId" : "artifactId",
    "version" : "version"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

BundleVersion

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /bundles/{bundleId}/versions/{version}/content
Get bundle version content (getBundleVersionContent)

Gets the binary content for the given version of the given extension bundle.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

bundleId (required)
Path Parameter — The extension bundle identifier
version (required)
Path Parameter — The version of the bundle

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

byte[]

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /bundles/{bundleId}/versions/{version}/extensions/{name}
Get bundle version extension (getBundleVersionExtension)

Gets the metadata about the extension with the given name in the given extension bundle version.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

bundleId (required)
Path Parameter — The extension bundle identifier
version (required)
Path Parameter — The version of the bundle
name (required)
Path Parameter — The fully qualified name of the extension

Return type

array[Extension]

Example data

Content-Type: application/json
[ {
  "defaultSchedule" : {
    "period" : "period",
    "concurrentTasks" : "concurrentTasks",
    "strategy" : "strategy"
  },
  "dynamicProperties" : [ {
    "expressionLanguageScope" : "NONE",
    "name" : "name",
    "description" : "description",
    "expressionLanguageSupported" : true,
    "value" : "value"
  }, {
    "expressionLanguageScope" : "NONE",
    "name" : "name",
    "description" : "description",
    "expressionLanguageSupported" : true,
    "value" : "value"
  } ],
  "providedServiceAPIs" : [ {
    "groupId" : "groupId",
    "artifactId" : "artifactId",
    "className" : "className",
    "version" : "version"
  }, {
    "groupId" : "groupId",
    "artifactId" : "artifactId",
    "className" : "className",
    "version" : "version"
  } ],
  "writesAttributes" : [ null, null ],
  "description" : "description",
  "type" : "PROCESSOR",
  "inputRequirement" : "INPUT_REQUIRED",
  "seeAlso" : [ "seeAlso", "seeAlso" ],
  "primaryNodeOnly" : true,
  "relationships" : [ {
    "autoTerminated" : true,
    "name" : "name",
    "description" : "description"
  }, {
    "autoTerminated" : true,
    "name" : "name",
    "description" : "description"
  } ],
  "dynamicRelationship" : {
    "name" : "name",
    "description" : "description"
  },
  "systemResourceConsiderations" : [ {
    "resource" : "resource",
    "description" : "description"
  }, {
    "resource" : "resource",
    "description" : "description"
  } ],
  "supportsSensitiveDynamicProperties" : true,
  "sideEffectFree" : true,
  "stateful" : {
    "description" : "description",
    "scopes" : [ "CLUSTER", "CLUSTER" ]
  },
  "defaultSettings" : {
    "bulletinLevel" : "bulletinLevel",
    "penaltyDuration" : "penaltyDuration",
    "yieldDuration" : "yieldDuration"
  },
  "triggerWhenAnyDestinationAvailable" : true,
  "supportsBatching" : true,
  "deprecationNotice" : {
    "reason" : "reason",
    "alternatives" : [ "alternatives", "alternatives" ]
  },
  "triggerSerially" : true,
  "readsAttributes" : [ {
    "name" : "name",
    "description" : "description"
  }, {
    "name" : "name",
    "description" : "description"
  } ],
  "tags" : [ "tags", "tags" ],
  "triggerWhenEmpty" : true,
  "useCases" : [ {
    "notes" : "notes",
    "keywords" : [ "keywords", "keywords" ],
    "configuration" : "configuration",
    "description" : "description",
    "inputRequirement" : "INPUT_REQUIRED"
  }, {
    "notes" : "notes",
    "keywords" : [ "keywords", "keywords" ],
    "configuration" : "configuration",
    "description" : "description",
    "inputRequirement" : "INPUT_REQUIRED"
  } ],
  "configurationSteps" : [ {
    "name" : "name",
    "description" : "description",
    "stepDependencies" : [ {
      "dependentValues" : [ "dependentValues", "dependentValues" ],
      "propertyName" : "propertyName",
      "stepName" : "stepName"
    }, {
      "dependentValues" : [ "dependentValues", "dependentValues" ],
      "propertyName" : "propertyName",
      "stepName" : "stepName"
    } ],
    "propertyGroups" : [ {
      "name" : "name",
      "description" : "description",
      "properties" : [ {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      }, {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      } ]
    }, {
      "name" : "name",
      "description" : "description",
      "properties" : [ {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      }, {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      } ]
    } ]
  }, {
    "name" : "name",
    "description" : "description",
    "stepDependencies" : [ {
      "dependentValues" : [ "dependentValues", "dependentValues" ],
      "propertyName" : "propertyName",
      "stepName" : "stepName"
    }, {
      "dependentValues" : [ "dependentValues", "dependentValues" ],
      "propertyName" : "propertyName",
      "stepName" : "stepName"
    } ],
    "propertyGroups" : [ {
      "name" : "name",
      "description" : "description",
      "properties" : [ {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      }, {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      } ]
    }, {
      "name" : "name",
      "description" : "description",
      "properties" : [ {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      }, {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      } ]
    } ]
  } ],
  "restricted" : {
    "restrictions" : [ {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    }, {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    } ],
    "generalRestrictionExplanation" : "generalRestrictionExplanation"
  },
  "name" : "name",
  "multiProcessorUseCases" : [ {
    "processorConfigurations" : [ {
      "processorClassName" : "processorClassName",
      "configuration" : "configuration"
    }, {
      "processorClassName" : "processorClassName",
      "configuration" : "configuration"
    } ],
    "notes" : "notes",
    "keywords" : [ "keywords", "keywords" ],
    "description" : "description"
  }, {
    "processorConfigurations" : [ {
      "processorClassName" : "processorClassName",
      "configuration" : "configuration"
    }, {
      "processorClassName" : "processorClassName",
      "configuration" : "configuration"
    } ],
    "notes" : "notes",
    "keywords" : [ "keywords", "keywords" ],
    "description" : "description"
  } ],
  "properties" : [ {
    "resourceDefinition" : {
      "resourceTypes" : [ "FILE", "FILE" ],
      "cardinality" : "SINGLE"
    },
    "controllerServiceDefinition" : {
      "groupId" : "groupId",
      "artifactId" : "artifactId",
      "className" : "className",
      "version" : "version"
    },
    "defaultValue" : "defaultValue",
    "displayName" : "displayName",
    "dynamicallyModifiesClasspath" : true,
    "expressionLanguageScope" : "NONE",
    "description" : "description",
    "sensitive" : true,
    "required" : true,
    "dependencies" : [ {
      "propertyDisplayName" : "propertyDisplayName",
      "dependentValues" : {
        "values" : [ "values", "values" ]
      },
      "propertyName" : "propertyName"
    }, {
      "propertyDisplayName" : "propertyDisplayName",
      "dependentValues" : {
        "values" : [ "values", "values" ]
      },
      "propertyName" : "propertyName"
    } ],
    "listenPortDefinition" : {
      "applicationProtocols" : [ "applicationProtocols", "applicationProtocols" ],
      "transportProtocol" : "TCP"
    },
    "allowableValues" : [ null, null ],
    "name" : "name",
    "dynamic" : true,
    "expressionLanguageSupported" : true
  }, {
    "resourceDefinition" : {
      "resourceTypes" : [ "FILE", "FILE" ],
      "cardinality" : "SINGLE"
    },
    "controllerServiceDefinition" : {
      "groupId" : "groupId",
      "artifactId" : "artifactId",
      "className" : "className",
      "version" : "version"
    },
    "defaultValue" : "defaultValue",
    "displayName" : "displayName",
    "dynamicallyModifiesClasspath" : true,
    "expressionLanguageScope" : "NONE",
    "description" : "description",
    "sensitive" : true,
    "required" : true,
    "dependencies" : [ {
      "propertyDisplayName" : "propertyDisplayName",
      "dependentValues" : {
        "values" : [ "values", "values" ]
      },
      "propertyName" : "propertyName"
    }, {
      "propertyDisplayName" : "propertyDisplayName",
      "dependentValues" : {
        "values" : [ "values", "values" ]
      },
      "propertyName" : "propertyName"
    } ],
    "listenPortDefinition" : {
      "applicationProtocols" : [ "applicationProtocols", "applicationProtocols" ],
      "transportProtocol" : "TCP"
    },
    "allowableValues" : [ null, null ],
    "name" : "name",
    "dynamic" : true,
    "expressionLanguageSupported" : true
  } ]
}, {
  "defaultSchedule" : {
    "period" : "period",
    "concurrentTasks" : "concurrentTasks",
    "strategy" : "strategy"
  },
  "dynamicProperties" : [ {
    "expressionLanguageScope" : "NONE",
    "name" : "name",
    "description" : "description",
    "expressionLanguageSupported" : true,
    "value" : "value"
  }, {
    "expressionLanguageScope" : "NONE",
    "name" : "name",
    "description" : "description",
    "expressionLanguageSupported" : true,
    "value" : "value"
  } ],
  "providedServiceAPIs" : [ {
    "groupId" : "groupId",
    "artifactId" : "artifactId",
    "className" : "className",
    "version" : "version"
  }, {
    "groupId" : "groupId",
    "artifactId" : "artifactId",
    "className" : "className",
    "version" : "version"
  } ],
  "writesAttributes" : [ null, null ],
  "description" : "description",
  "type" : "PROCESSOR",
  "inputRequirement" : "INPUT_REQUIRED",
  "seeAlso" : [ "seeAlso", "seeAlso" ],
  "primaryNodeOnly" : true,
  "relationships" : [ {
    "autoTerminated" : true,
    "name" : "name",
    "description" : "description"
  }, {
    "autoTerminated" : true,
    "name" : "name",
    "description" : "description"
  } ],
  "dynamicRelationship" : {
    "name" : "name",
    "description" : "description"
  },
  "systemResourceConsiderations" : [ {
    "resource" : "resource",
    "description" : "description"
  }, {
    "resource" : "resource",
    "description" : "description"
  } ],
  "supportsSensitiveDynamicProperties" : true,
  "sideEffectFree" : true,
  "stateful" : {
    "description" : "description",
    "scopes" : [ "CLUSTER", "CLUSTER" ]
  },
  "defaultSettings" : {
    "bulletinLevel" : "bulletinLevel",
    "penaltyDuration" : "penaltyDuration",
    "yieldDuration" : "yieldDuration"
  },
  "triggerWhenAnyDestinationAvailable" : true,
  "supportsBatching" : true,
  "deprecationNotice" : {
    "reason" : "reason",
    "alternatives" : [ "alternatives", "alternatives" ]
  },
  "triggerSerially" : true,
  "readsAttributes" : [ {
    "name" : "name",
    "description" : "description"
  }, {
    "name" : "name",
    "description" : "description"
  } ],
  "tags" : [ "tags", "tags" ],
  "triggerWhenEmpty" : true,
  "useCases" : [ {
    "notes" : "notes",
    "keywords" : [ "keywords", "keywords" ],
    "configuration" : "configuration",
    "description" : "description",
    "inputRequirement" : "INPUT_REQUIRED"
  }, {
    "notes" : "notes",
    "keywords" : [ "keywords", "keywords" ],
    "configuration" : "configuration",
    "description" : "description",
    "inputRequirement" : "INPUT_REQUIRED"
  } ],
  "configurationSteps" : [ {
    "name" : "name",
    "description" : "description",
    "stepDependencies" : [ {
      "dependentValues" : [ "dependentValues", "dependentValues" ],
      "propertyName" : "propertyName",
      "stepName" : "stepName"
    }, {
      "dependentValues" : [ "dependentValues", "dependentValues" ],
      "propertyName" : "propertyName",
      "stepName" : "stepName"
    } ],
    "propertyGroups" : [ {
      "name" : "name",
      "description" : "description",
      "properties" : [ {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      }, {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      } ]
    }, {
      "name" : "name",
      "description" : "description",
      "properties" : [ {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      }, {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      } ]
    } ]
  }, {
    "name" : "name",
    "description" : "description",
    "stepDependencies" : [ {
      "dependentValues" : [ "dependentValues", "dependentValues" ],
      "propertyName" : "propertyName",
      "stepName" : "stepName"
    }, {
      "dependentValues" : [ "dependentValues", "dependentValues" ],
      "propertyName" : "propertyName",
      "stepName" : "stepName"
    } ],
    "propertyGroups" : [ {
      "name" : "name",
      "description" : "description",
      "properties" : [ {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      }, {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      } ]
    }, {
      "name" : "name",
      "description" : "description",
      "properties" : [ {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      }, {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      } ]
    } ]
  } ],
  "restricted" : {
    "restrictions" : [ {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    }, {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    } ],
    "generalRestrictionExplanation" : "generalRestrictionExplanation"
  },
  "name" : "name",
  "multiProcessorUseCases" : [ {
    "processorConfigurations" : [ {
      "processorClassName" : "processorClassName",
      "configuration" : "configuration"
    }, {
      "processorClassName" : "processorClassName",
      "configuration" : "configuration"
    } ],
    "notes" : "notes",
    "keywords" : [ "keywords", "keywords" ],
    "description" : "description"
  }, {
    "processorConfigurations" : [ {
      "processorClassName" : "processorClassName",
      "configuration" : "configuration"
    }, {
      "processorClassName" : "processorClassName",
      "configuration" : "configuration"
    } ],
    "notes" : "notes",
    "keywords" : [ "keywords", "keywords" ],
    "description" : "description"
  } ],
  "properties" : [ {
    "resourceDefinition" : {
      "resourceTypes" : [ "FILE", "FILE" ],
      "cardinality" : "SINGLE"
    },
    "controllerServiceDefinition" : {
      "groupId" : "groupId",
      "artifactId" : "artifactId",
      "className" : "className",
      "version" : "version"
    },
    "defaultValue" : "defaultValue",
    "displayName" : "displayName",
    "dynamicallyModifiesClasspath" : true,
    "expressionLanguageScope" : "NONE",
    "description" : "description",
    "sensitive" : true,
    "required" : true,
    "dependencies" : [ {
      "propertyDisplayName" : "propertyDisplayName",
      "dependentValues" : {
        "values" : [ "values", "values" ]
      },
      "propertyName" : "propertyName"
    }, {
      "propertyDisplayName" : "propertyDisplayName",
      "dependentValues" : {
        "values" : [ "values", "values" ]
      },
      "propertyName" : "propertyName"
    } ],
    "listenPortDefinition" : {
      "applicationProtocols" : [ "applicationProtocols", "applicationProtocols" ],
      "transportProtocol" : "TCP"
    },
    "allowableValues" : [ null, null ],
    "name" : "name",
    "dynamic" : true,
    "expressionLanguageSupported" : true
  }, {
    "resourceDefinition" : {
      "resourceTypes" : [ "FILE", "FILE" ],
      "cardinality" : "SINGLE"
    },
    "controllerServiceDefinition" : {
      "groupId" : "groupId",
      "artifactId" : "artifactId",
      "className" : "className",
      "version" : "version"
    },
    "defaultValue" : "defaultValue",
    "displayName" : "displayName",
    "dynamicallyModifiesClasspath" : true,
    "expressionLanguageScope" : "NONE",
    "description" : "description",
    "sensitive" : true,
    "required" : true,
    "dependencies" : [ {
      "propertyDisplayName" : "propertyDisplayName",
      "dependentValues" : {
        "values" : [ "values", "values" ]
      },
      "propertyName" : "propertyName"
    }, {
      "propertyDisplayName" : "propertyDisplayName",
      "dependentValues" : {
        "values" : [ "values", "values" ]
      },
      "propertyName" : "propertyName"
    } ],
    "listenPortDefinition" : {
      "applicationProtocols" : [ "applicationProtocols", "applicationProtocols" ],
      "transportProtocol" : "TCP"
    },
    "allowableValues" : [ null, null ],
    "name" : "name",
    "dynamic" : true,
    "expressionLanguageSupported" : true
  } ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /bundles/{bundleId}/versions/{version}/extensions/{name}/docs/additional-details
Get bundle version extension docs details (getBundleVersionExtensionAdditionalDetailsDocs)

Gets the additional details documentation for the given extension in the given extension bundle version.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

bundleId (required)
Path Parameter — The extension bundle identifier
version (required)
Path Parameter — The version of the bundle
name (required)
Path Parameter — The fully qualified name of the extension

Responses

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /bundles/{bundleId}/versions/{version}/extensions/{name}/docs
Get bundle version extension docs (getBundleVersionExtensionDocs)

Gets the documentation for the given extension in the given extension bundle version.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

bundleId (required)
Path Parameter — The extension bundle identifier
version (required)
Path Parameter — The version of the bundle
name (required)
Path Parameter — The fully qualified name of the extension

Responses

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /bundles/{bundleId}/versions/{version}/extensions
Get bundle version extensions (getBundleVersionExtensions)

Gets the metadata about the extensions in the given extension bundle version.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

bundleId (required)
Path Parameter — The extension bundle identifier
version (required)
Path Parameter — The version of the bundle

Return type

array[ExtensionMetadata]

Example data

Content-Type: application/json
[ {
  "bundleInfo" : {
    "bucketName" : "bucketName",
    "groupId" : "groupId",
    "bundleId" : "bundleId",
    "artifactId" : "artifactId",
    "bucketId" : "bucketId",
    "bundleType" : "NIFI_NAR",
    "version" : "version",
    "systemApiVersion" : "systemApiVersion"
  },
  "hasAdditionalDetails" : true,
  "deprecationNotice" : {
    "reason" : "reason",
    "alternatives" : [ "alternatives", "alternatives" ]
  },
  "displayName" : "displayName",
  "restricted" : {
    "restrictions" : [ {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    }, {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    } ],
    "generalRestrictionExplanation" : "generalRestrictionExplanation"
  },
  "providedServiceAPIs" : [ {
    "groupId" : "groupId",
    "artifactId" : "artifactId",
    "className" : "className",
    "version" : "version"
  }, {
    "groupId" : "groupId",
    "artifactId" : "artifactId",
    "className" : "className",
    "version" : "version"
  } ],
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "name" : "name",
  "description" : "description",
  "type" : "PROCESSOR",
  "tags" : [ "tags", "tags" ]
}, {
  "bundleInfo" : {
    "bucketName" : "bucketName",
    "groupId" : "groupId",
    "bundleId" : "bundleId",
    "artifactId" : "artifactId",
    "bucketId" : "bucketId",
    "bundleType" : "NIFI_NAR",
    "version" : "version",
    "systemApiVersion" : "systemApiVersion"
  },
  "hasAdditionalDetails" : true,
  "deprecationNotice" : {
    "reason" : "reason",
    "alternatives" : [ "alternatives", "alternatives" ]
  },
  "displayName" : "displayName",
  "restricted" : {
    "restrictions" : [ {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    }, {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    } ],
    "generalRestrictionExplanation" : "generalRestrictionExplanation"
  },
  "providedServiceAPIs" : [ {
    "groupId" : "groupId",
    "artifactId" : "artifactId",
    "className" : "className",
    "version" : "version"
  }, {
    "groupId" : "groupId",
    "artifactId" : "artifactId",
    "className" : "className",
    "version" : "version"
  } ],
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "name" : "name",
  "description" : "description",
  "type" : "PROCESSOR",
  "tags" : [ "tags", "tags" ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /bundles/{bundleId}/versions
Get bundle versions (getBundleVersions)

Gets the metadata for the versions of the given extension bundle.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

bundleId (required)
Path Parameter — The extension bundle identifier

Return type

array[BundleVersionMetadata]

Example data

Content-Type: application/json
[ {
  "sha256" : "sha256",
  "buildInfo" : {
    "buildBranch" : "buildBranch",
    "builtBy" : "builtBy",
    "buildRevision" : "buildRevision",
    "buildTag" : "buildTag",
    "built" : 0,
    "buildTool" : "buildTool",
    "buildFlags" : "buildFlags"
  },
  "author" : "author",
  "groupId" : "groupId",
  "bundleId" : "bundleId",
  "description" : "description",
  "bucketId" : "bucketId",
  "version" : "version",
  "sha256Supplied" : true,
  "contentSize" : 0,
  "artifactId" : "artifactId",
  "id" : "id",
  "systemApiVersion" : "systemApiVersion",
  "timestamp" : 1
}, {
  "sha256" : "sha256",
  "buildInfo" : {
    "buildBranch" : "buildBranch",
    "builtBy" : "builtBy",
    "buildRevision" : "buildRevision",
    "buildTag" : "buildTag",
    "built" : 0,
    "buildTool" : "buildTool",
    "buildFlags" : "buildFlags"
  },
  "author" : "author",
  "groupId" : "groupId",
  "bundleId" : "bundleId",
  "description" : "description",
  "bucketId" : "bucketId",
  "version" : "version",
  "sha256Supplied" : true,
  "contentSize" : 0,
  "artifactId" : "artifactId",
  "id" : "id",
  "systemApiVersion" : "systemApiVersion",
  "timestamp" : 1
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /bundles/versions
Get all bundle versions (getBundleVersions1)

Gets the metadata about extension bundle versions across all authorized buckets with optional filters applied. If the user is not authorized to any buckets, an empty list will be returned.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Query parameters

groupId (optional)
Query Parameter — Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundle versions where the groupId starts with 'com.'.
artifactId (optional)
Query Parameter — Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundle versions where the artifactId starts with 'nifi-'.
version (optional)
Query Parameter — Optional version to filter results. The value may be an exact match, or a wildcard, such as '1.0.%' to select all bundle versions where the version starts with '1.0.'.

Return type

array[BundleVersionMetadata]

Example data

Content-Type: application/json
[ {
  "sha256" : "sha256",
  "buildInfo" : {
    "buildBranch" : "buildBranch",
    "builtBy" : "builtBy",
    "buildRevision" : "buildRevision",
    "buildTag" : "buildTag",
    "built" : 0,
    "buildTool" : "buildTool",
    "buildFlags" : "buildFlags"
  },
  "author" : "author",
  "groupId" : "groupId",
  "bundleId" : "bundleId",
  "description" : "description",
  "bucketId" : "bucketId",
  "version" : "version",
  "sha256Supplied" : true,
  "contentSize" : 0,
  "artifactId" : "artifactId",
  "id" : "id",
  "systemApiVersion" : "systemApiVersion",
  "timestamp" : 1
}, {
  "sha256" : "sha256",
  "buildInfo" : {
    "buildBranch" : "buildBranch",
    "builtBy" : "builtBy",
    "buildRevision" : "buildRevision",
    "buildTag" : "buildTag",
    "built" : 0,
    "buildTool" : "buildTool",
    "buildFlags" : "buildFlags"
  },
  "author" : "author",
  "groupId" : "groupId",
  "bundleId" : "bundleId",
  "description" : "description",
  "bucketId" : "bucketId",
  "version" : "version",
  "sha256Supplied" : true,
  "contentSize" : 0,
  "artifactId" : "artifactId",
  "id" : "id",
  "systemApiVersion" : "systemApiVersion",
  "timestamp" : 1
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

401

Client could not be authenticated.
Up 
get /bundles
Get all bundles (getBundles)

Gets the metadata for all bundles across all authorized buckets with optional filters applied. The returned results will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Query parameters

bucketName (optional)
Query Parameter — Optional bucket name to filter results. The value may be an exact match, or a wildcard, such as 'My Bucket%' to select all bundles where the bucket name starts with 'My Bucket'.
groupId (optional)
Query Parameter — Optional groupId to filter results. The value may be an exact match, or a wildcard, such as 'com.%' to select all bundles where the groupId starts with 'com.'.
artifactId (optional)
Query Parameter — Optional artifactId to filter results. The value may be an exact match, or a wildcard, such as 'nifi-%' to select all bundles where the artifactId starts with 'nifi-'.

Return type

array[Bundle]

Example data

Content-Type: application/json
[ {
  "artifact" : "artifact",
  "version" : "version",
  "group" : "group"
}, {
  "artifact" : "artifact",
  "version" : "version",
  "group" : "group"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

401

Client could not be authenticated.

Config

Up 
get /config
Get configration (getConfiguration)
Gets the NiFi Registry configurations.

Return type

RegistryConfiguration

Example data

Content-Type: application/json
{
  "supportsConfigurableAuthorizer" : true,
  "supportsConfigurableUsersAndGroups" : true,
  "supportsManagedAuthorizer" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

RegistryConfiguration

401

Client could not be authenticated.

ExtensionRepository

Up 
get /extension-repository/{bucketName}/{groupId}
Get extension repo artifacts (getExtensionRepoArtifacts)

Gets the artifacts in the extension repository in the given bucket and group.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

bucketName (required)
Path Parameter — The bucket name
groupId (required)
Path Parameter — The group id

Return type

array[ExtensionRepoArtifact]

Example data

Content-Type: application/json
[ {
  "bucketName" : "bucketName",
  "groupId" : "groupId",
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "artifactId" : "artifactId"
}, {
  "bucketName" : "bucketName",
  "groupId" : "groupId",
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "artifactId" : "artifactId"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /extension-repository
Get extension repo buckets (getExtensionRepoBuckets)

Gets the names of the buckets the current user is authorized for in order to browse the repo by bucket.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Return type

array[ExtensionRepoBucket]

Example data

Content-Type: application/json
[ {
  "bucketName" : "bucketName",
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  }
}, {
  "bucketName" : "bucketName",
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /extension-repository/{bucketName}
Get extension repo groups (getExtensionRepoGroups)

Gets the groups in the extension repository in the given bucket.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

bucketName (required)
Path Parameter — The bucket name

Return type

array[ExtensionRepoGroup]

Example data

Content-Type: application/json
[ {
  "bucketName" : "bucketName",
  "groupId" : "groupId",
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  }
}, {
  "bucketName" : "bucketName",
  "groupId" : "groupId",
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}
Get extension repo version (getExtensionRepoVersion)

Gets information about the version in the given bucket, group, and artifact.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

bucketName (required)
Path Parameter — The bucket name
groupId (required)
Path Parameter — The group identifier
artifactId (required)
Path Parameter — The artifact identifier
version (required)
Path Parameter — The version

Return type

ExtensionRepoVersion

Example data

Content-Type: application/json
{
  "downloadLink" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "sha256Supplied" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

ExtensionRepoVersion

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/content
Get extension repo version content (getExtensionRepoVersionContent)

Gets the binary content of the bundle with the given bucket, group, artifact, and version.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

bucketName (required)
Path Parameter — The bucket name
groupId (required)
Path Parameter — The group identifier
artifactId (required)
Path Parameter — The artifact identifier
version (required)
Path Parameter — The version

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

byte[]

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}
Get extension repo extension (getExtensionRepoVersionExtension)

Gets information about the extension with the given name in the given bucket, group, artifact, and version.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

bucketName (required)
Path Parameter — The bucket name
groupId (required)
Path Parameter — The group identifier
artifactId (required)
Path Parameter — The artifact identifier
version (required)
Path Parameter — The version
name (required)
Path Parameter — The fully qualified name of the extension

Return type

Extension

Example data

Content-Type: application/json
{
  "defaultSchedule" : {
    "period" : "period",
    "concurrentTasks" : "concurrentTasks",
    "strategy" : "strategy"
  },
  "dynamicProperties" : [ {
    "expressionLanguageScope" : "NONE",
    "name" : "name",
    "description" : "description",
    "expressionLanguageSupported" : true,
    "value" : "value"
  }, {
    "expressionLanguageScope" : "NONE",
    "name" : "name",
    "description" : "description",
    "expressionLanguageSupported" : true,
    "value" : "value"
  } ],
  "providedServiceAPIs" : [ {
    "groupId" : "groupId",
    "artifactId" : "artifactId",
    "className" : "className",
    "version" : "version"
  }, {
    "groupId" : "groupId",
    "artifactId" : "artifactId",
    "className" : "className",
    "version" : "version"
  } ],
  "writesAttributes" : [ null, null ],
  "description" : "description",
  "type" : "PROCESSOR",
  "inputRequirement" : "INPUT_REQUIRED",
  "seeAlso" : [ "seeAlso", "seeAlso" ],
  "primaryNodeOnly" : true,
  "relationships" : [ {
    "autoTerminated" : true,
    "name" : "name",
    "description" : "description"
  }, {
    "autoTerminated" : true,
    "name" : "name",
    "description" : "description"
  } ],
  "dynamicRelationship" : {
    "name" : "name",
    "description" : "description"
  },
  "systemResourceConsiderations" : [ {
    "resource" : "resource",
    "description" : "description"
  }, {
    "resource" : "resource",
    "description" : "description"
  } ],
  "supportsSensitiveDynamicProperties" : true,
  "sideEffectFree" : true,
  "stateful" : {
    "description" : "description",
    "scopes" : [ "CLUSTER", "CLUSTER" ]
  },
  "defaultSettings" : {
    "bulletinLevel" : "bulletinLevel",
    "penaltyDuration" : "penaltyDuration",
    "yieldDuration" : "yieldDuration"
  },
  "triggerWhenAnyDestinationAvailable" : true,
  "supportsBatching" : true,
  "deprecationNotice" : {
    "reason" : "reason",
    "alternatives" : [ "alternatives", "alternatives" ]
  },
  "triggerSerially" : true,
  "readsAttributes" : [ {
    "name" : "name",
    "description" : "description"
  }, {
    "name" : "name",
    "description" : "description"
  } ],
  "tags" : [ "tags", "tags" ],
  "triggerWhenEmpty" : true,
  "useCases" : [ {
    "notes" : "notes",
    "keywords" : [ "keywords", "keywords" ],
    "configuration" : "configuration",
    "description" : "description",
    "inputRequirement" : "INPUT_REQUIRED"
  }, {
    "notes" : "notes",
    "keywords" : [ "keywords", "keywords" ],
    "configuration" : "configuration",
    "description" : "description",
    "inputRequirement" : "INPUT_REQUIRED"
  } ],
  "configurationSteps" : [ {
    "name" : "name",
    "description" : "description",
    "stepDependencies" : [ {
      "dependentValues" : [ "dependentValues", "dependentValues" ],
      "propertyName" : "propertyName",
      "stepName" : "stepName"
    }, {
      "dependentValues" : [ "dependentValues", "dependentValues" ],
      "propertyName" : "propertyName",
      "stepName" : "stepName"
    } ],
    "propertyGroups" : [ {
      "name" : "name",
      "description" : "description",
      "properties" : [ {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      }, {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      } ]
    }, {
      "name" : "name",
      "description" : "description",
      "properties" : [ {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      }, {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      } ]
    } ]
  }, {
    "name" : "name",
    "description" : "description",
    "stepDependencies" : [ {
      "dependentValues" : [ "dependentValues", "dependentValues" ],
      "propertyName" : "propertyName",
      "stepName" : "stepName"
    }, {
      "dependentValues" : [ "dependentValues", "dependentValues" ],
      "propertyName" : "propertyName",
      "stepName" : "stepName"
    } ],
    "propertyGroups" : [ {
      "name" : "name",
      "description" : "description",
      "properties" : [ {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      }, {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      } ]
    }, {
      "name" : "name",
      "description" : "description",
      "properties" : [ {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      }, {
        "allowableValuesFetchable" : true,
        "allowableValues" : [ {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        }, {
          "displayName" : "displayName",
          "description" : "description",
          "value" : "value"
        } ],
        "defaultValue" : "defaultValue",
        "propertyType" : "STRING",
        "name" : "name",
        "description" : "description",
        "required" : true,
        "dependencies" : [ {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        }, {
          "dependentValues" : [ "dependentValues", "dependentValues" ],
          "propertyName" : "propertyName"
        } ]
      } ]
    } ]
  } ],
  "restricted" : {
    "restrictions" : [ {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    }, {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    } ],
    "generalRestrictionExplanation" : "generalRestrictionExplanation"
  },
  "name" : "name",
  "multiProcessorUseCases" : [ {
    "processorConfigurations" : [ {
      "processorClassName" : "processorClassName",
      "configuration" : "configuration"
    }, {
      "processorClassName" : "processorClassName",
      "configuration" : "configuration"
    } ],
    "notes" : "notes",
    "keywords" : [ "keywords", "keywords" ],
    "description" : "description"
  }, {
    "processorConfigurations" : [ {
      "processorClassName" : "processorClassName",
      "configuration" : "configuration"
    }, {
      "processorClassName" : "processorClassName",
      "configuration" : "configuration"
    } ],
    "notes" : "notes",
    "keywords" : [ "keywords", "keywords" ],
    "description" : "description"
  } ],
  "properties" : [ {
    "resourceDefinition" : {
      "resourceTypes" : [ "FILE", "FILE" ],
      "cardinality" : "SINGLE"
    },
    "controllerServiceDefinition" : {
      "groupId" : "groupId",
      "artifactId" : "artifactId",
      "className" : "className",
      "version" : "version"
    },
    "defaultValue" : "defaultValue",
    "displayName" : "displayName",
    "dynamicallyModifiesClasspath" : true,
    "expressionLanguageScope" : "NONE",
    "description" : "description",
    "sensitive" : true,
    "required" : true,
    "dependencies" : [ {
      "propertyDisplayName" : "propertyDisplayName",
      "dependentValues" : {
        "values" : [ "values", "values" ]
      },
      "propertyName" : "propertyName"
    }, {
      "propertyDisplayName" : "propertyDisplayName",
      "dependentValues" : {
        "values" : [ "values", "values" ]
      },
      "propertyName" : "propertyName"
    } ],
    "listenPortDefinition" : {
      "applicationProtocols" : [ "applicationProtocols", "applicationProtocols" ],
      "transportProtocol" : "TCP"
    },
    "allowableValues" : [ null, null ],
    "name" : "name",
    "dynamic" : true,
    "expressionLanguageSupported" : true
  }, {
    "resourceDefinition" : {
      "resourceTypes" : [ "FILE", "FILE" ],
      "cardinality" : "SINGLE"
    },
    "controllerServiceDefinition" : {
      "groupId" : "groupId",
      "artifactId" : "artifactId",
      "className" : "className",
      "version" : "version"
    },
    "defaultValue" : "defaultValue",
    "displayName" : "displayName",
    "dynamicallyModifiesClasspath" : true,
    "expressionLanguageScope" : "NONE",
    "description" : "description",
    "sensitive" : true,
    "required" : true,
    "dependencies" : [ {
      "propertyDisplayName" : "propertyDisplayName",
      "dependentValues" : {
        "values" : [ "values", "values" ]
      },
      "propertyName" : "propertyName"
    }, {
      "propertyDisplayName" : "propertyDisplayName",
      "dependentValues" : {
        "values" : [ "values", "values" ]
      },
      "propertyName" : "propertyName"
    } ],
    "listenPortDefinition" : {
      "applicationProtocols" : [ "applicationProtocols", "applicationProtocols" ],
      "transportProtocol" : "TCP"
    },
    "allowableValues" : [ null, null ],
    "name" : "name",
    "dynamic" : true,
    "expressionLanguageSupported" : true
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Extension

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs/additional-details
Get extension repo extension details (getExtensionRepoVersionExtensionAdditionalDetailsDocs)

Gets the additional details documentation for the extension with the given name in the given bucket, group, artifact, and version.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

bucketName (required)
Path Parameter — The bucket name
groupId (required)
Path Parameter — The group identifier
artifactId (required)
Path Parameter — The artifact identifier
version (required)
Path Parameter — The version
name (required)
Path Parameter — The fully qualified name of the extension

Responses

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs
Get extension repo extension docs (getExtensionRepoVersionExtensionDocs)

Gets the documentation for the extension with the given name in the given bucket, group, artifact, and version.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

bucketName (required)
Path Parameter — The bucket name
groupId (required)
Path Parameter — The group identifier
artifactId (required)
Path Parameter — The artifact identifier
version (required)
Path Parameter — The version
name (required)
Path Parameter — The fully qualified name of the extension

Responses

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions
Get extension repo extensions (getExtensionRepoVersionExtensions)

Gets information about the extensions in the given bucket, group, artifact, and version.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

bucketName (required)
Path Parameter — The bucket name
groupId (required)
Path Parameter — The group identifier
artifactId (required)
Path Parameter — The artifact identifier
version (required)
Path Parameter — The version

Return type

array[ExtensionMetadata]

Example data

Content-Type: application/json
[ {
  "bundleInfo" : {
    "bucketName" : "bucketName",
    "groupId" : "groupId",
    "bundleId" : "bundleId",
    "artifactId" : "artifactId",
    "bucketId" : "bucketId",
    "bundleType" : "NIFI_NAR",
    "version" : "version",
    "systemApiVersion" : "systemApiVersion"
  },
  "hasAdditionalDetails" : true,
  "deprecationNotice" : {
    "reason" : "reason",
    "alternatives" : [ "alternatives", "alternatives" ]
  },
  "displayName" : "displayName",
  "restricted" : {
    "restrictions" : [ {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    }, {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    } ],
    "generalRestrictionExplanation" : "generalRestrictionExplanation"
  },
  "providedServiceAPIs" : [ {
    "groupId" : "groupId",
    "artifactId" : "artifactId",
    "className" : "className",
    "version" : "version"
  }, {
    "groupId" : "groupId",
    "artifactId" : "artifactId",
    "className" : "className",
    "version" : "version"
  } ],
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "name" : "name",
  "description" : "description",
  "type" : "PROCESSOR",
  "tags" : [ "tags", "tags" ]
}, {
  "bundleInfo" : {
    "bucketName" : "bucketName",
    "groupId" : "groupId",
    "bundleId" : "bundleId",
    "artifactId" : "artifactId",
    "bucketId" : "bucketId",
    "bundleType" : "NIFI_NAR",
    "version" : "version",
    "systemApiVersion" : "systemApiVersion"
  },
  "hasAdditionalDetails" : true,
  "deprecationNotice" : {
    "reason" : "reason",
    "alternatives" : [ "alternatives", "alternatives" ]
  },
  "displayName" : "displayName",
  "restricted" : {
    "restrictions" : [ {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    }, {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    } ],
    "generalRestrictionExplanation" : "generalRestrictionExplanation"
  },
  "providedServiceAPIs" : [ {
    "groupId" : "groupId",
    "artifactId" : "artifactId",
    "className" : "className",
    "version" : "version"
  }, {
    "groupId" : "groupId",
    "artifactId" : "artifactId",
    "className" : "className",
    "version" : "version"
  } ],
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "name" : "name",
  "description" : "description",
  "type" : "PROCESSOR",
  "tags" : [ "tags", "tags" ]
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/sha256
Get extension repo version checksum (getExtensionRepoVersionSha256)

Gets the hex representation of the SHA-256 digest for the binary content of the bundle with the given bucket, group, artifact, and version.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

bucketName (required)
Path Parameter — The bucket name
groupId (required)
Path Parameter — The group identifier
artifactId (required)
Path Parameter — The artifact identifier
version (required)
Path Parameter — The version

Responses

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /extension-repository/{bucketName}/{groupId}/{artifactId}
Get extension repo versions (getExtensionRepoVersions)

Gets the versions in the extension repository for the given bucket, group, and artifact.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

bucketName (required)
Path Parameter — The bucket name
groupId (required)
Path Parameter — The group identifier
artifactId (required)
Path Parameter — The artifact identifier

Return type

array[ExtensionRepoVersionSummary]

Example data

Content-Type: application/json
[ {
  "bucketName" : "bucketName",
  "author" : "author",
  "groupId" : "groupId",
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "artifactId" : "artifactId",
  "version" : "version",
  "timestamp" : 0
}, {
  "bucketName" : "bucketName",
  "author" : "author",
  "groupId" : "groupId",
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "artifactId" : "artifactId",
  "version" : "version",
  "timestamp" : 0
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /extension-repository/{groupId}/{artifactId}/{version}/sha256
Get global extension repo version checksum (getGlobalExtensionRepoVersionSha256)

Gets the hex representation of the SHA-256 digest for the binary content with the given bucket, group, artifact, and version. Since the same group-artifact-version can exist in multiple buckets, this will return the checksum of the first one returned. This will be consistent since the checksum must be the same when existing in multiple buckets.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

groupId (required)
Path Parameter — The group identifier
artifactId (required)
Path Parameter — The artifact identifier
version (required)
Path Parameter — The version

Responses

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.

Extensions

Up 
get /extensions
Get all extensions (getExtensions)

Gets the metadata for all extensions that match the filter params and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Query parameters

bundleType (optional)
Query Parameter — The type of bundles to return
extensionType (optional)
Query Parameter — The type of extensions to return
tag (optional)
Query Parameter — The tags to filter on, will be used in an OR statement

Return type

ExtensionMetadataContainer

Example data

Content-Type: application/json
{
  "extensions" : [ {
    "bundleInfo" : {
      "bucketName" : "bucketName",
      "groupId" : "groupId",
      "bundleId" : "bundleId",
      "artifactId" : "artifactId",
      "bucketId" : "bucketId",
      "bundleType" : "NIFI_NAR",
      "version" : "version",
      "systemApiVersion" : "systemApiVersion"
    },
    "hasAdditionalDetails" : true,
    "deprecationNotice" : {
      "reason" : "reason",
      "alternatives" : [ "alternatives", "alternatives" ]
    },
    "displayName" : "displayName",
    "restricted" : {
      "restrictions" : [ {
        "requiredPermission" : "requiredPermission",
        "explanation" : "explanation"
      }, {
        "requiredPermission" : "requiredPermission",
        "explanation" : "explanation"
      } ],
      "generalRestrictionExplanation" : "generalRestrictionExplanation"
    },
    "providedServiceAPIs" : [ {
      "groupId" : "groupId",
      "artifactId" : "artifactId",
      "className" : "className",
      "version" : "version"
    }, {
      "groupId" : "groupId",
      "artifactId" : "artifactId",
      "className" : "className",
      "version" : "version"
    } ],
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "name" : "name",
    "description" : "description",
    "type" : "PROCESSOR",
    "tags" : [ "tags", "tags" ]
  }, {
    "bundleInfo" : {
      "bucketName" : "bucketName",
      "groupId" : "groupId",
      "bundleId" : "bundleId",
      "artifactId" : "artifactId",
      "bucketId" : "bucketId",
      "bundleType" : "NIFI_NAR",
      "version" : "version",
      "systemApiVersion" : "systemApiVersion"
    },
    "hasAdditionalDetails" : true,
    "deprecationNotice" : {
      "reason" : "reason",
      "alternatives" : [ "alternatives", "alternatives" ]
    },
    "displayName" : "displayName",
    "restricted" : {
      "restrictions" : [ {
        "requiredPermission" : "requiredPermission",
        "explanation" : "explanation"
      }, {
        "requiredPermission" : "requiredPermission",
        "explanation" : "explanation"
      } ],
      "generalRestrictionExplanation" : "generalRestrictionExplanation"
    },
    "providedServiceAPIs" : [ {
      "groupId" : "groupId",
      "artifactId" : "artifactId",
      "className" : "className",
      "version" : "version"
    }, {
      "groupId" : "groupId",
      "artifactId" : "artifactId",
      "className" : "className",
      "version" : "version"
    } ],
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "name" : "name",
    "description" : "description",
    "type" : "PROCESSOR",
    "tags" : [ "tags", "tags" ]
  } ],
  "numResults" : 0,
  "filterParams" : {
    "extensionType" : "PROCESSOR",
    "bundleType" : "NIFI_NAR",
    "tags" : [ "tags", "tags" ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

ExtensionMetadataContainer

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /extensions/provided-service-api
Get extensions providing service API (getExtensionsProvidingServiceAPI)

Gets the metadata for extensions that provide the specified API and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Query parameters

className (required)
Query Parameter — The name of the service API class
groupId (required)
Query Parameter — The groupId of the bundle containing the service API class
artifactId (required)
Query Parameter — The artifactId of the bundle containing the service API class
version (required)
Query Parameter — The version of the bundle containing the service API class

Return type

ExtensionMetadataContainer

Example data

Content-Type: application/json
{
  "extensions" : [ {
    "bundleInfo" : {
      "bucketName" : "bucketName",
      "groupId" : "groupId",
      "bundleId" : "bundleId",
      "artifactId" : "artifactId",
      "bucketId" : "bucketId",
      "bundleType" : "NIFI_NAR",
      "version" : "version",
      "systemApiVersion" : "systemApiVersion"
    },
    "hasAdditionalDetails" : true,
    "deprecationNotice" : {
      "reason" : "reason",
      "alternatives" : [ "alternatives", "alternatives" ]
    },
    "displayName" : "displayName",
    "restricted" : {
      "restrictions" : [ {
        "requiredPermission" : "requiredPermission",
        "explanation" : "explanation"
      }, {
        "requiredPermission" : "requiredPermission",
        "explanation" : "explanation"
      } ],
      "generalRestrictionExplanation" : "generalRestrictionExplanation"
    },
    "providedServiceAPIs" : [ {
      "groupId" : "groupId",
      "artifactId" : "artifactId",
      "className" : "className",
      "version" : "version"
    }, {
      "groupId" : "groupId",
      "artifactId" : "artifactId",
      "className" : "className",
      "version" : "version"
    } ],
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "name" : "name",
    "description" : "description",
    "type" : "PROCESSOR",
    "tags" : [ "tags", "tags" ]
  }, {
    "bundleInfo" : {
      "bucketName" : "bucketName",
      "groupId" : "groupId",
      "bundleId" : "bundleId",
      "artifactId" : "artifactId",
      "bucketId" : "bucketId",
      "bundleType" : "NIFI_NAR",
      "version" : "version",
      "systemApiVersion" : "systemApiVersion"
    },
    "hasAdditionalDetails" : true,
    "deprecationNotice" : {
      "reason" : "reason",
      "alternatives" : [ "alternatives", "alternatives" ]
    },
    "displayName" : "displayName",
    "restricted" : {
      "restrictions" : [ {
        "requiredPermission" : "requiredPermission",
        "explanation" : "explanation"
      }, {
        "requiredPermission" : "requiredPermission",
        "explanation" : "explanation"
      } ],
      "generalRestrictionExplanation" : "generalRestrictionExplanation"
    },
    "providedServiceAPIs" : [ {
      "groupId" : "groupId",
      "artifactId" : "artifactId",
      "className" : "className",
      "version" : "version"
    }, {
      "groupId" : "groupId",
      "artifactId" : "artifactId",
      "className" : "className",
      "version" : "version"
    } ],
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "name" : "name",
    "description" : "description",
    "type" : "PROCESSOR",
    "tags" : [ "tags", "tags" ]
  } ],
  "numResults" : 0,
  "filterParams" : {
    "extensionType" : "PROCESSOR",
    "bundleType" : "NIFI_NAR",
    "tags" : [ "tags", "tags" ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

ExtensionMetadataContainer

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /extensions/tags
Get extension tags (getTags)

Gets all the extension tags known to this NiFi Registry instance, along with the number of extensions that have the given tag.

NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Return type

array[TagCount]

Example data

Content-Type: application/json
[ {
  "count" : 0,
  "tag" : "tag"
}, {
  "count" : 0,
  "tag" : "tag"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.

Flows

Up 
get /flows/fields
Get flow fields (getAvailableFlowFields)
Retrieves the flow field names that can be used for searching or sorting on flows.

Return type

Fields

Example data

Content-Type: application/json
{
  "fields" : [ "fields", "fields" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Fields
Up 
get /flows/{flowId}
Get flow (getFlow1)
Gets a flow by id.

Path parameters

flowId (required)
Path Parameter — The flow identifier

Return type

VersionedFlow

Example data

Content-Type: application/json
{
  "versionCount" : 0,
  "bucketName" : "bucketName",
  "identifier" : "identifier",
  "permissions" : {
    "canRead" : true,
    "canDelete" : true,
    "canWrite" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "name" : "name",
  "description" : "description",
  "modifiedTimestamp" : 1,
  "bucketIdentifier" : "bucketIdentifier",
  "type" : "Flow",
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VersionedFlow

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /flows/{flowId}/versions/{versionNumber}
Get flow version (getFlowVersion1)
Gets the given version of a flow, including metadata and flow content.

Path parameters

flowId (required)
Path Parameter — The flow identifier
versionNumber (required)
Path Parameter — The version number format: int32

Return type

VersionedFlowSnapshot

Example data

Content-Type: application/json
{
  "bucket" : {
    "identifier" : "identifier",
    "allowBundleRedeploy" : true,
    "permissions" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "name" : "name",
    "description" : "description",
    "allowPublicRead" : true,
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "externalControllerServices" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name"
    }
  },
  "snapshotMetadata" : {
    "flowIdentifier" : "flowIdentifier",
    "comments" : "comments",
    "author" : "author",
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "bucketIdentifier" : "bucketIdentifier",
    "version" : 0,
    "timestamp" : 1
  },
  "flowContents" : {
    "processors" : [ {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 1,
      "propertyDescriptors" : { },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 1,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "backoffMechanism",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "schedulingPeriod" : "schedulingPeriod",
      "style" : {
        "key" : "style"
      },
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    }, {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 1,
      "propertyDescriptors" : { },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 1,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "backoffMechanism",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "schedulingPeriod" : "schedulingPeriod",
      "style" : {
        "key" : "style"
      },
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    } ],
    "scheduledState" : "ENABLED",
    "processGroups" : [ null, null ],
    "outputPorts" : [ null, null ],
    "funnels" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    } ],
    "versionedFlowCoordinates" : {
      "registryId" : "registryId",
      "storageLocation" : "storageLocation",
      "bucketId" : "bucketId",
      "branch" : "branch",
      "flowId" : "flowId",
      "version" : "version",
      "latest" : true
    },
    "connections" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "loadBalanceCompression",
      "destination" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "loadBalanceStrategy",
      "labelIndex" : 5,
      "bends" : [ {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      }, {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      } ],
      "backPressureObjectThreshold" : 0,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 5
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "loadBalanceCompression",
      "destination" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "loadBalanceStrategy",
      "labelIndex" : 5,
      "bends" : [ {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      }, {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      } ],
      "backPressureObjectThreshold" : 0,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 5
    } ],
    "logFileSuffix" : "logFileSuffix",
    "parameterContextName" : "parameterContextName",
    "componentType" : "CONNECTION",
    "identifier" : "identifier",
    "defaultBackPressureObjectThreshold" : 2,
    "comments" : "comments",
    "executionEngine" : "STANDARD",
    "defaultBackPressureDataSizeThreshold" : "defaultBackPressureDataSizeThreshold",
    "labels" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "width" : 3.616076749251911,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "height" : 9.301444243932576,
      "zIndex" : 2
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "width" : 3.616076749251911,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "height" : 9.301444243932576,
      "zIndex" : 2
    } ],
    "controllerServices" : [ {
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "dynamic" : true,
          "sensitive" : true,
          "listenPortDefinition" : {
            "applicationProtocols" : [ "applicationProtocols", "applicationProtocols" ],
            "transportProtocol" : "TCP"
          }
        }
      },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "componentState" : {
        "localNodeStates" : [ {
          "state" : {
            "key" : "state"
          }
        }, {
          "state" : {
            "key" : "state"
          }
        } ],
        "clusterState" : {
          "key" : "clusterState"
        }
      },
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "properties" : {
        "key" : "properties"
      }
    }, {
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "dynamic" : true,
          "sensitive" : true,
          "listenPortDefinition" : {
            "applicationProtocols" : [ "applicationProtocols", "applicationProtocols" ],
            "transportProtocol" : "TCP"
          }
        }
      },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "componentState" : {
        "localNodeStates" : [ {
          "state" : {
            "key" : "state"
          }
        }, {
          "state" : {
            "key" : "state"
          }
        } ],
        "clusterState" : {
          "key" : "clusterState"
        }
      },
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "properties" : {
        "key" : "properties"
      }
    } ],
    "defaultFlowFileExpiration" : "defaultFlowFileExpiration",
    "flowFileConcurrency" : "flowFileConcurrency",
    "flowFileOutboundPolicy" : "flowFileOutboundPolicy",
    "name" : "name",
    "inputPorts" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "portFunction" : "STANDARD",
      "groupIdentifier" : "groupIdentifier",
      "type" : "INPUT_PORT",
      "scheduledState" : "ENABLED"
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "portFunction" : "STANDARD",
      "groupIdentifier" : "groupIdentifier",
      "type" : "INPUT_PORT",
      "scheduledState" : "ENABLED"
    } ],
    "instanceIdentifier" : "instanceIdentifier",
    "maxConcurrentTasks" : 4,
    "statelessFlowTimeout" : "statelessFlowTimeout",
    "groupIdentifier" : "groupIdentifier",
    "remoteProcessGroups" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 7,
      "outputPorts" : [ null, null ],
      "transportProtocol" : "transportProtocol",
      "name" : "name",
      "proxyUser" : "proxyUser",
      "inputPorts" : [ {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "targetUris" : "targetUris",
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 7,
      "outputPorts" : [ null, null ],
      "transportProtocol" : "transportProtocol",
      "name" : "name",
      "proxyUser" : "proxyUser",
      "inputPorts" : [ {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "targetUris" : "targetUris",
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    } ]
  },
  "parameterProviders" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name",
      "type" : "type"
    }
  },
  "flow" : {
    "versionCount" : 0,
    "bucketName" : "bucketName",
    "identifier" : "identifier",
    "permissions" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "name" : "name",
    "description" : "description",
    "modifiedTimestamp" : 1,
    "bucketIdentifier" : "bucketIdentifier",
    "type" : "Flow",
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "flowEncodingVersion" : "flowEncodingVersion",
  "latest" : true,
  "parameterContexts" : {
    "key" : {
      "parameterGroupName" : "parameterGroupName",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "synchronized" : true,
      "comments" : "comments",
      "description" : "description",
      "inheritedParameterContexts" : [ "inheritedParameterContexts", "inheritedParameterContexts" ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "parameterProvider" : "parameterProvider",
      "parameters" : [ {
        "referencedAssets" : [ {
          "identifier" : "identifier",
          "name" : "name"
        }, {
          "identifier" : "identifier",
          "name" : "name"
        } ],
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      }, {
        "referencedAssets" : [ {
          "identifier" : "identifier",
          "name" : "name"
        }, {
          "identifier" : "identifier",
          "name" : "name"
        } ],
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      } ]
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VersionedFlowSnapshot

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /flows/{flowId}/versions
Get flow versions (getFlowVersions1)
Gets summary information for all versions of a given flow. Versions are ordered newest->oldest.

Path parameters

flowId (required)
Path Parameter — The flow identifier

Return type

array[VersionedFlowSnapshotMetadata]

Example data

Content-Type: application/json
[ {
  "flowIdentifier" : "flowIdentifier",
  "comments" : "comments",
  "author" : "author",
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "bucketIdentifier" : "bucketIdentifier",
  "version" : 0,
  "timestamp" : 1
}, {
  "flowIdentifier" : "flowIdentifier",
  "comments" : "comments",
  "author" : "author",
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "bucketIdentifier" : "bucketIdentifier",
  "version" : 0,
  "timestamp" : 1
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /flows/{flowId}/versions/latest
Get latest flow version (getLatestFlowVersion1)
Gets the latest version of a flow, including metadata and flow content.

Path parameters

flowId (required)
Path Parameter — The flow identifier

Return type

VersionedFlowSnapshot

Example data

Content-Type: application/json
{
  "bucket" : {
    "identifier" : "identifier",
    "allowBundleRedeploy" : true,
    "permissions" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "name" : "name",
    "description" : "description",
    "allowPublicRead" : true,
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "externalControllerServices" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name"
    }
  },
  "snapshotMetadata" : {
    "flowIdentifier" : "flowIdentifier",
    "comments" : "comments",
    "author" : "author",
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "bucketIdentifier" : "bucketIdentifier",
    "version" : 0,
    "timestamp" : 1
  },
  "flowContents" : {
    "processors" : [ {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 1,
      "propertyDescriptors" : { },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 1,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "backoffMechanism",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "schedulingPeriod" : "schedulingPeriod",
      "style" : {
        "key" : "style"
      },
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    }, {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 1,
      "propertyDescriptors" : { },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 1,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "backoffMechanism",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "schedulingPeriod" : "schedulingPeriod",
      "style" : {
        "key" : "style"
      },
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    } ],
    "scheduledState" : "ENABLED",
    "processGroups" : [ null, null ],
    "outputPorts" : [ null, null ],
    "funnels" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    } ],
    "versionedFlowCoordinates" : {
      "registryId" : "registryId",
      "storageLocation" : "storageLocation",
      "bucketId" : "bucketId",
      "branch" : "branch",
      "flowId" : "flowId",
      "version" : "version",
      "latest" : true
    },
    "connections" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "loadBalanceCompression",
      "destination" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "loadBalanceStrategy",
      "labelIndex" : 5,
      "bends" : [ {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      }, {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      } ],
      "backPressureObjectThreshold" : 0,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 5
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "loadBalanceCompression",
      "destination" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "loadBalanceStrategy",
      "labelIndex" : 5,
      "bends" : [ {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      }, {
        "x" : 6.027456183070403,
        "y" : 1.4658129805029452
      } ],
      "backPressureObjectThreshold" : 0,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 5
    } ],
    "logFileSuffix" : "logFileSuffix",
    "parameterContextName" : "parameterContextName",
    "componentType" : "CONNECTION",
    "identifier" : "identifier",
    "defaultBackPressureObjectThreshold" : 2,
    "comments" : "comments",
    "executionEngine" : "STANDARD",
    "defaultBackPressureDataSizeThreshold" : "defaultBackPressureDataSizeThreshold",
    "labels" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "width" : 3.616076749251911,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "height" : 9.301444243932576,
      "zIndex" : 2
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "name" : "name",
      "width" : 3.616076749251911,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "height" : 9.301444243932576,
      "zIndex" : 2
    } ],
    "controllerServices" : [ {
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "dynamic" : true,
          "sensitive" : true,
          "listenPortDefinition" : {
            "applicationProtocols" : [ "applicationProtocols", "applicationProtocols" ],
            "transportProtocol" : "TCP"
          }
        }
      },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "componentState" : {
        "localNodeStates" : [ {
          "state" : {
            "key" : "state"
          }
        }, {
          "state" : {
            "key" : "state"
          }
        } ],
        "clusterState" : {
          "key" : "clusterState"
        }
      },
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "properties" : {
        "key" : "properties"
      }
    }, {
      "annotationData" : "annotationData",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "dynamic" : true,
          "sensitive" : true,
          "listenPortDefinition" : {
            "applicationProtocols" : [ "applicationProtocols", "applicationProtocols" ],
            "transportProtocol" : "TCP"
          }
        }
      },
      "type" : "type",
      "scheduledState" : "ENABLED",
      "componentState" : {
        "localNodeStates" : [ {
          "state" : {
            "key" : "state"
          }
        }, {
          "state" : {
            "key" : "state"
          }
        } ],
        "clusterState" : {
          "key" : "clusterState"
        }
      },
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "properties" : {
        "key" : "properties"
      }
    } ],
    "defaultFlowFileExpiration" : "defaultFlowFileExpiration",
    "flowFileConcurrency" : "flowFileConcurrency",
    "flowFileOutboundPolicy" : "flowFileOutboundPolicy",
    "name" : "name",
    "inputPorts" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "portFunction" : "STANDARD",
      "groupIdentifier" : "groupIdentifier",
      "type" : "INPUT_PORT",
      "scheduledState" : "ENABLED"
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "portFunction" : "STANDARD",
      "groupIdentifier" : "groupIdentifier",
      "type" : "INPUT_PORT",
      "scheduledState" : "ENABLED"
    } ],
    "instanceIdentifier" : "instanceIdentifier",
    "maxConcurrentTasks" : 4,
    "statelessFlowTimeout" : "statelessFlowTimeout",
    "groupIdentifier" : "groupIdentifier",
    "remoteProcessGroups" : [ {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 7,
      "outputPorts" : [ null, null ],
      "transportProtocol" : "transportProtocol",
      "name" : "name",
      "proxyUser" : "proxyUser",
      "inputPorts" : [ {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "targetUris" : "targetUris",
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    }, {
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 7,
      "outputPorts" : [ null, null ],
      "transportProtocol" : "transportProtocol",
      "name" : "name",
      "proxyUser" : "proxyUser",
      "inputPorts" : [ {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "componentType" : "CONNECTION",
        "identifier" : "identifier",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 6,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 1
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "targetUris" : "targetUris",
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    } ]
  },
  "parameterProviders" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name",
      "type" : "type"
    }
  },
  "flow" : {
    "versionCount" : 0,
    "bucketName" : "bucketName",
    "identifier" : "identifier",
    "permissions" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "rel" : "rel",
      "params" : {
        "key" : "params"
      },
      "title" : "title",
      "type" : "type",
      "uri" : "http://example.com/aeiou",
      "uriBuilder" : { },
      "rels" : [ "rels", "rels" ]
    },
    "name" : "name",
    "description" : "description",
    "modifiedTimestamp" : 1,
    "bucketIdentifier" : "bucketIdentifier",
    "type" : "Flow",
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "flowEncodingVersion" : "flowEncodingVersion",
  "latest" : true,
  "parameterContexts" : {
    "key" : {
      "parameterGroupName" : "parameterGroupName",
      "componentType" : "CONNECTION",
      "identifier" : "identifier",
      "synchronized" : true,
      "comments" : "comments",
      "description" : "description",
      "inheritedParameterContexts" : [ "inheritedParameterContexts", "inheritedParameterContexts" ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "parameterProvider" : "parameterProvider",
      "parameters" : [ {
        "referencedAssets" : [ {
          "identifier" : "identifier",
          "name" : "name"
        }, {
          "identifier" : "identifier",
          "name" : "name"
        } ],
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      }, {
        "referencedAssets" : [ {
          "identifier" : "identifier",
          "name" : "name"
        }, {
          "identifier" : "identifier",
          "name" : "name"
        } ],
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      } ]
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VersionedFlowSnapshot

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /flows/{flowId}/versions/latest/metadata
Get latest flow version metadata (getLatestFlowVersionMetadata1)
Gets the metadata for the latest version of a flow.

Path parameters

flowId (required)
Path Parameter — The flow identifier

Return type

VersionedFlowSnapshotMetadata

Example data

Content-Type: application/json
{
  "flowIdentifier" : "flowIdentifier",
  "comments" : "comments",
  "author" : "author",
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "bucketIdentifier" : "bucketIdentifier",
  "version" : 0,
  "timestamp" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

VersionedFlowSnapshotMetadata

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.

Items

Up 
get /items/fields
Get item fields (getAvailableBucketItemFields)
Retrieves the item field names for searching or sorting on bucket items.

Return type

Fields

Example data

Content-Type: application/json
{
  "fields" : [ "fields", "fields" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

default

Fields
Up 
get /items
Get all items (getItems)
Get items across all buckets. The returned items will include only items from buckets for which the user is authorized. If the user is not authorized to any buckets, an empty list will be returned.

Return type

array[BucketItem]

Example data

Content-Type: application/json
[ {
  "bucketName" : "bucketName",
  "identifier" : "identifier",
  "permissions" : {
    "canRead" : true,
    "canDelete" : true,
    "canWrite" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "name" : "name",
  "description" : "description",
  "modifiedTimestamp" : 1,
  "bucketIdentifier" : "bucketIdentifier",
  "type" : "Flow"
}, {
  "bucketName" : "bucketName",
  "identifier" : "identifier",
  "permissions" : {
    "canRead" : true,
    "canDelete" : true,
    "canWrite" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "name" : "name",
  "description" : "description",
  "modifiedTimestamp" : 1,
  "bucketIdentifier" : "bucketIdentifier",
  "type" : "Flow"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

401

Client could not be authenticated.
Up 
get /items/{bucketId}
Get bucket items (getItems1)
Gets the items located in the given bucket.

Path parameters

bucketId (required)
Path Parameter — The bucket identifier

Return type

array[BucketItem]

Example data

Content-Type: application/json
[ {
  "bucketName" : "bucketName",
  "identifier" : "identifier",
  "permissions" : {
    "canRead" : true,
    "canDelete" : true,
    "canWrite" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "name" : "name",
  "description" : "description",
  "modifiedTimestamp" : 1,
  "bucketIdentifier" : "bucketIdentifier",
  "type" : "Flow"
}, {
  "bucketName" : "bucketName",
  "identifier" : "identifier",
  "permissions" : {
    "canRead" : true,
    "canDelete" : true,
    "canWrite" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "rel" : "rel",
    "params" : {
      "key" : "params"
    },
    "title" : "title",
    "type" : "type",
    "uri" : "http://example.com/aeiou",
    "uriBuilder" : { },
    "rels" : [ "rels", "rels" ]
  },
  "name" : "name",
  "description" : "description",
  "modifiedTimestamp" : 1,
  "bucketIdentifier" : "bucketIdentifier",
  "type" : "Flow"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

Policies

Up 
post /policies
Create access policy (createAccessPolicy)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AccessPolicy (required)
Body Parameter — The access policy configuration details.

Return type

AccessPolicy

Example data

Content-Type: application/json
{
  "identifier" : "identifier",
  "userGroups" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "resource" : "resource",
  "action" : "read",
  "configurable" : true,
  "users" : [ null, null ],
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider.

default

AccessPolicy
Up 
get /policies
Get all access policies (getAccessPolicies)

Return type

array[AccessPolicy]

Example data

Content-Type: application/json
[ {
  "identifier" : "identifier",
  "userGroups" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "resource" : "resource",
  "action" : "read",
  "configurable" : true,
  "users" : [ null, null ],
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}, {
  "identifier" : "identifier",
  "userGroups" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "resource" : "resource",
  "action" : "read",
  "configurable" : true,
  "users" : [ null, null ],
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

401

Client could not be authenticated.

403

Client is not authorized to make this request.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /policies/{id}
Get access policy (getAccessPolicy)

Path parameters

id (required)
Path Parameter — The access policy id.

Return type

AccessPolicy

Example data

Content-Type: application/json
{
  "identifier" : "identifier",
  "userGroups" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "resource" : "resource",
  "action" : "read",
  "configurable" : true,
  "users" : [ null, null ],
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

AccessPolicy

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /policies/{action}/{resource}
Get access policy for resource (getAccessPolicyForResource)
Gets an access policy for the specified action and resource

Path parameters

action (required)
Path Parameter — The request action.
resource (required)
Path Parameter — The resource of the policy.

Return type

AccessPolicy

Example data

Content-Type: application/json
{
  "identifier" : "identifier",
  "userGroups" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "resource" : "resource",
  "action" : "read",
  "configurable" : true,
  "users" : [ null, null ],
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

AccessPolicy

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /policies/resources
Get available resources (getResources)
Gets the available resources that support access/authorization policies

Return type

array[Resource]

Example data

Content-Type: application/json
[ {
  "identifier" : "identifier",
  "name" : "name"
}, {
  "identifier" : "identifier",
  "name" : "name"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

401

Client could not be authenticated.

403

Client is not authorized to make this request.
Up 
delete /policies/{id}
Delete access policy (removeAccessPolicy)

Path parameters

id (required)
Path Parameter — The access policy id.

Query parameters

version (required)
Query Parameter — The version is used to verify the client is working with the latest version of the entity.
clientId (optional)
Query Parameter — If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

Return type

AccessPolicy

Example data

Content-Type: application/json
{
  "identifier" : "identifier",
  "userGroups" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "resource" : "resource",
  "action" : "read",
  "configurable" : true,
  "users" : [ null, null ],
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

AccessPolicy

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider.
Up 
put /policies/{id}
Update access policy (updateAccessPolicy)

Path parameters

id (required)
Path Parameter — The access policy id.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body AccessPolicy (required)
Body Parameter — The access policy configuration details.

Return type

AccessPolicy

Example data

Content-Type: application/json
{
  "identifier" : "identifier",
  "userGroups" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "resource" : "resource",
  "action" : "read",
  "configurable" : true,
  "users" : [ null, null ],
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

AccessPolicy

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid. The NiFi Registry might not be configured to use a ConfigurableAccessPolicyProvider.

Tenants

Up 
post /tenants/users
Create user (createUser)
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body User (required)
Body Parameter — The user configuration details.

Return type

User

Example data

Content-Type: application/json
{
  "identifier" : "identifier",
  "userGroups" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "resourcePermissions" : {
    "anyTopLevelResource" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  } ],
  "identity" : "identity",
  "configurable" : true,
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

User

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
post /tenants/user-groups
Create user group (createUserGroup)
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body UserGroup (required)
Body Parameter — The user group configuration details.

Return type

UserGroup

Example data

Content-Type: application/json
{
  "identifier" : "identifier",
  "resourcePermissions" : {
    "anyTopLevelResource" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  } ],
  "identity" : "identity",
  "configurable" : true,
  "users" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

UserGroup

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /tenants/users/{id}
Get user (getUser)
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

id (required)
Path Parameter — The user id.

Return type

User

Example data

Content-Type: application/json
{
  "identifier" : "identifier",
  "userGroups" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "resourcePermissions" : {
    "anyTopLevelResource" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  } ],
  "identity" : "identity",
  "configurable" : true,
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

User

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /tenants/user-groups/{id}
Get user group (getUserGroup)
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

id (required)
Path Parameter — The user group id.

Return type

UserGroup

Example data

Content-Type: application/json
{
  "identifier" : "identifier",
  "resourcePermissions" : {
    "anyTopLevelResource" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  } ],
  "identity" : "identity",
  "configurable" : true,
  "users" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

UserGroup

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /tenants/user-groups
Get user groups (getUserGroups)
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Return type

array[UserGroup]

Example data

Content-Type: application/json
[ {
  "identifier" : "identifier",
  "resourcePermissions" : {
    "anyTopLevelResource" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  } ],
  "identity" : "identity",
  "configurable" : true,
  "users" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}, {
  "identifier" : "identifier",
  "resourcePermissions" : {
    "anyTopLevelResource" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  } ],
  "identity" : "identity",
  "configurable" : true,
  "users" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
get /tenants/users
Get all users (getUsers)
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Return type

array[User]

Example data

Content-Type: application/json
[ {
  "identifier" : "identifier",
  "userGroups" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "resourcePermissions" : {
    "anyTopLevelResource" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  } ],
  "identity" : "identity",
  "configurable" : true,
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}, {
  "identifier" : "identifier",
  "userGroups" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "resourcePermissions" : {
    "anyTopLevelResource" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  } ],
  "identity" : "identity",
  "configurable" : true,
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
delete /tenants/users/{id}
Delete user (removeUser)
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

id (required)
Path Parameter — The user id.

Query parameters

version (required)
Query Parameter — The version is used to verify the client is working with the latest version of the entity.
clientId (optional)
Query Parameter — If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

Return type

User

Example data

Content-Type: application/json
{
  "identifier" : "identifier",
  "userGroups" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "resourcePermissions" : {
    "anyTopLevelResource" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  } ],
  "identity" : "identity",
  "configurable" : true,
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

User

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
delete /tenants/user-groups/{id}
Delete user group (removeUserGroup)
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

id (required)
Path Parameter — The user group id.

Query parameters

version (required)
Query Parameter — The version is used to verify the client is working with the latest version of the entity.
clientId (optional)
Query Parameter — If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

Return type

UserGroup

Example data

Content-Type: application/json
{
  "identifier" : "identifier",
  "resourcePermissions" : {
    "anyTopLevelResource" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  } ],
  "identity" : "identity",
  "configurable" : true,
  "users" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

UserGroup

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
put /tenants/users/{id}
Update user (updateUser)
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

id (required)
Path Parameter — The user id.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body User (required)
Body Parameter — The user configuration details.

Return type

User

Example data

Content-Type: application/json
{
  "identifier" : "identifier",
  "userGroups" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "resourcePermissions" : {
    "anyTopLevelResource" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  } ],
  "identity" : "identity",
  "configurable" : true,
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

User

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.
Up 
put /tenants/user-groups/{id}
Update user group (updateUserGroup)
NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Path parameters

id (required)
Path Parameter — The user group id.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body UserGroup (required)
Body Parameter — The user group configuration details.

Return type

UserGroup

Example data

Content-Type: application/json
{
  "identifier" : "identifier",
  "resourcePermissions" : {
    "anyTopLevelResource" : {
      "canRead" : true,
      "canDelete" : true,
      "canWrite" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resource" : "resource",
    "action" : "read",
    "configurable" : true
  } ],
  "identity" : "identity",
  "configurable" : true,
  "users" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  }, {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "anyTopLevelResource" : {
        "canRead" : true,
        "canDelete" : true,
        "canWrite" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

UserGroup

400

NiFi Registry was unable to complete the request because it was invalid. The request should not be retried without modification.

401

Client could not be authenticated.

403

Client is not authorized to make this request.

404

The specified resource could not be found.

409

NiFi Registry was unable to complete the request because it assumes a server state that is not valid.

Models

[ Jump to Methods ]

Table of Contents

  1. AccessPolicy
  2. AccessPolicySummary
  3. AllowableValue
  4. Attribute
  5. BatchSize
  6. Bucket
  7. BucketItem
  8. BuildInfo
  9. Bundle
  10. BundleInfo
  11. BundleVersion
  12. BundleVersionDependency
  13. BundleVersionMetadata
  14. ClientIdParameter
  15. ComponentDifference
  16. ComponentDifferenceGroup
  17. ConfigurationStep
  18. ConfigurationStepDependency
  19. ConnectableComponent
  20. ConnectorProperty
  21. ConnectorPropertyDependency
  22. ConnectorPropertyGroup
  23. ControllerServiceAPI
  24. ControllerServiceDefinition
  25. CurrentUser
  26. DefaultSchedule
  27. DefaultSettings
  28. Dependency
  29. DependentValues
  30. DeprecationNotice
  31. DynamicProperty
  32. DynamicRelationship
  33. Extension
  34. ExtensionFilterParams
  35. ExtensionMetadata
  36. ExtensionMetadataContainer
  37. ExtensionRepoArtifact
  38. ExtensionRepoBucket
  39. ExtensionRepoGroup
  40. ExtensionRepoVersion
  41. ExtensionRepoVersionSummary
  42. ExternalControllerServiceReference
  43. Fields
  44. FormDataContentDisposition
  45. Link
  46. ListenPortDefinition
  47. LongParameter
  48. MultiProcessorUseCase
  49. ParameterProviderReference
  50. Permissions
  51. Position
  52. ProcessorConfiguration
  53. Property
  54. ProvidedServiceAPI
  55. RegistryAbout
  56. RegistryConfiguration
  57. Relationship
  58. Resource
  59. ResourceDefinition
  60. ResourcePermissions
  61. Restricted
  62. Restriction
  63. RevisionInfo
  64. Stateful
  65. SystemResourceConsideration
  66. TagCount
  67. Tenant
  68. UriBuilder
  69. UseCase
  70. User
  71. UserGroup
  72. VersionedAsset
  73. VersionedComponentState
  74. VersionedConnection
  75. VersionedControllerService
  76. VersionedFlow
  77. VersionedFlowCoordinates
  78. VersionedFlowDifference
  79. VersionedFlowSnapshot
  80. VersionedFlowSnapshotMetadata
  81. VersionedFunnel
  82. VersionedLabel
  83. VersionedListenPortDefinition
  84. VersionedNodeState
  85. VersionedParameter
  86. VersionedParameterContext
  87. VersionedPort
  88. VersionedProcessGroup
  89. VersionedProcessor
  90. VersionedPropertyDescriptor
  91. VersionedRemoteGroupPort
  92. VersionedRemoteProcessGroup
  93. VersionedResourceDefinition
  94. bundles_bundleType_body

AccessPolicy Up

action (optional)
String The action associated with this access policy.
Enum:
read
write
delete
configurable (optional)
Boolean Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.
identifier (optional)
String The id of the policy. Set by server at creation time.
resource (optional)
String The resource for this access policy.
revision (optional)
RevisionInfo
userGroups (optional)
array[Tenant] The set of user group IDs associated with this access policy.
users (optional)
array[Tenant] The set of user IDs associated with this access policy.

AccessPolicySummary Up

The access policies granted to this tenant.
action (optional)
String The action associated with this access policy.
Enum:
read
write
delete
configurable (optional)
Boolean Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.
identifier (optional)
String The id of the policy. Set by server at creation time.
resource (optional)
String The resource for this access policy.
revision (optional)
RevisionInfo

AllowableValue Up

The allowable values for this property
description (optional)
String The description of the allowable value
displayName (optional)
String The display name of the allowable value
value (optional)
String The value of the allowable value

Attribute Up

The attributes written to FlowFiles by the extension
description (optional)
String The description of the attribute
name (optional)
String The name of the attribute

BatchSize Up

The batch settings for data transmission.
count (optional)
Integer Preferred number of FlowFiles to include in a transaction. format: int32
duration (optional)
String Preferred amount of time that a transaction should span.
size (optional)
String Preferred number of bytes to include in a transaction.

Bucket Up

The bucket where the flow is located
allowBundleRedeploy (optional)
Boolean Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false.
allowPublicRead (optional)
Boolean Indicates if this bucket allows read access to unauthenticated anonymous users
createdTimestamp (optional)
Long The timestamp of when the bucket was first created. This is set by the server at creation time. format: int64
description (optional)
String A description of the bucket.
identifier
String An ID to uniquely identify this object.
link (optional)
Link
name
String The name of the bucket.
permissions (optional)
Permissions
revision (optional)
RevisionInfo

BucketItem Up

bucketIdentifier
String The identifier of the bucket this items belongs to. This cannot be changed after the item is created.
bucketName (optional)
String The name of the bucket this items belongs to.
createdTimestamp (optional)
Long The timestamp of when the item was created, as milliseconds since epoch. format: int64
description (optional)
String A description of the item.
identifier
String An ID to uniquely identify this object.
link (optional)
Link
modifiedTimestamp (optional)
Long The timestamp of when the item was last modified, as milliseconds since epoch. format: int64
name
String The name of the item.
permissions (optional)
Permissions
type
String The type of item.
Enum:
Flow
Bundle

BuildInfo Up

The build information about this version
buildBranch (optional)
String The branch used to build the version of the bundle
buildFlags (optional)
String The flags used to build the version of the bundle
buildRevision (optional)
String The revision used to build the version of the bundle
buildTag (optional)
String The tag used to build the version of the bundle
buildTool (optional)
String The tool used to build the version of the bundle
built (optional)
Long The timestamp the version of the bundle was built format: int64
builtBy (optional)
String The identity of the user that performed the build

Bundle Up

The details of the artifact that bundled this parameter provider.
artifact (optional)
String The artifact of the bundle
group (optional)
String The group of the bundle
version (optional)
String The version of the bundle

BundleInfo Up

The information for the bundle where this extension is located
artifactId (optional)
String The artifact id of the bundle
bucketId (optional)
String The id of the bucket where the bundle is located
bucketName (optional)
String The name of the bucket where the bundle is located
bundleId (optional)
String The id of the bundle
bundleType (optional)
String The type of bundle (i.e. a NiFi NAR vs MiNiFi CPP)
Enum:
NIFI_NAR
MINIFI_CPP
groupId (optional)
String The group id of the bundle
systemApiVersion (optional)
String The version of the system API the bundle was built against
version (optional)
String The version of the bundle

BundleVersion Up

bucket (optional)
Bucket
bundle (optional)
Bundle
dependencies (optional)
array[BundleVersionDependency] The set of other bundle versions that this version is dependent on
filename (optional)
String
link (optional)
Link
versionMetadata
BundleVersionMetadata

BundleVersionDependency Up

The set of other bundle versions that this version is dependent on
artifactId
String The artifact id of the bundle dependency
groupId
String The group id of the bundle dependency
version
String The version of the bundle dependency

BundleVersionMetadata Up

artifactId (optional)
String
author
String The identity that created this version
bucketId
String The id of the bucket the extension bundle belongs to
buildInfo
BuildInfo
bundleId
String The id of the extension bundle this version is for
contentSize
Long The size of the binary content for this version in bytes format: int64
description (optional)
String The description for this version
groupId (optional)
String
id
String The id of this version of the extension bundle
link (optional)
Link
sha256
String The hex representation of the SHA-256 digest of the binary content for this version
sha256Supplied
Boolean Whether or not the client supplied a SHA-256 when uploading the bundle
systemApiVersion
String The version of the system API that this bundle version was built against
timestamp (optional)
Long The timestamp of the create date of this version format: int64
version
String The version of the extension bundle

ClientIdParameter Up

clientId (optional)
String

ComponentDifference Up

The list of changes related to this component between the 2 versions.
changeDescription (optional)
String The description of the change.
differenceType (optional)
String The key to the difference.
differenceTypeDescription (optional)
String The description of the change type.
valueA (optional)
String The earlier value from the difference.
valueB (optional)
String The newer value from the difference.

ComponentDifferenceGroup Up

componentId (optional)
String The id of the component whose changes are grouped together.
componentName (optional)
String The name of the component whose changes are grouped together.
componentType (optional)
String The type of component these changes relate to.
differences (optional)
array[ComponentDifference] The list of changes related to this component between the 2 versions.
processGroupId (optional)
String The process group id for this component.

ConfigurationStep Up

The configuration steps for a Connector extension
description (optional)
String The description of the configuration step
name (optional)
String The name of the configuration step
propertyGroups (optional)
array[ConnectorPropertyGroup] The property groups in this configuration step
stepDependencies (optional)
array[ConfigurationStepDependency] The dependencies that this step has on other steps

ConfigurationStepDependency Up

The dependencies that this step has on other steps
dependentValues (optional)
array[String] The values of the dependent property that enable this step
propertyName (optional)
String The name of the property within the step that this step depends on
stepName (optional)
String The name of the step that this step depends on

ConnectableComponent Up

The destination of the connection.
comments (optional)
String The comments for the connectable component.
groupId (optional)
String The id of the group that the connectable component resides in
id (optional)
String The id of the connectable component.
instanceIdentifier (optional)
String 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 (optional)
String The name of the connectable component
type (optional)
String The type of component the connectable is.
Enum:
PROCESSOR
REMOTE_INPUT_PORT
REMOTE_OUTPUT_PORT
INPUT_PORT
OUTPUT_PORT
FUNNEL

ConnectorProperty Up

The properties in this group
allowableValues (optional)
array[AllowableValue] The allowable values for this property
allowableValuesFetchable (optional)
Boolean Whether or not the allowable values can be fetched dynamically
defaultValue (optional)
String The default value of the property
dependencies (optional)
array[ConnectorPropertyDependency] The properties that this property depends on
description (optional)
String The description of the property
name (optional)
String The name of the property
propertyType (optional)
String The type of the property
Enum:
STRING
INTEGER
BOOLEAN
FLOAT
DOUBLE
STRING_LIST
SECRET
ASSET
ASSET_LIST
required (optional)
Boolean Whether or not the property is required

ConnectorPropertyDependency Up

The properties that this property depends on
dependentValues (optional)
array[String] The values of the dependent property that enable this property
propertyName (optional)
String The name of the property that this property depends on

ConnectorPropertyGroup Up

The property groups in this configuration step
description (optional)
String The description of the property group
name (optional)
String The name of the property group
properties (optional)
array[ConnectorProperty] The properties in this group

ControllerServiceAPI Up

Lists the APIs this Controller Service implements.
bundle (optional)
Bundle
type (optional)
String The fully qualified name of the service interface.

ControllerServiceDefinition Up

The controller service required by this property, or null if none is required
artifactId (optional)
String The artifact id of the service API
className (optional)
String The class name of the service API
groupId (optional)
String The group id of the service API
version (optional)
String The version of the service API

CurrentUser Up

anonymous (optional)
Boolean Indicates if the current user is anonymous
identity (optional)
String The identity of the current user
loginSupported (optional)
Boolean Indicates if the NiFi Registry instance supports logging in
oidcloginSupported (optional)
Boolean Indicates if the NiFi Registry instance supports logging in with an OIDC provider
resourcePermissions (optional)
ResourcePermissions

DefaultSchedule Up

The default schedule for a processor reporting task
concurrentTasks (optional)
String The default concurrent tasks
period (optional)
String The default scheduling period
strategy (optional)
String The default scheduling strategy

DefaultSettings Up

The default settings for a processor
bulletinLevel (optional)
String The default bulletin level
penaltyDuration (optional)
String The default penalty duration
yieldDuration (optional)
String The default yield duration

Dependency Up

The properties that this property depends on
dependentValues (optional)
DependentValues
propertyDisplayName (optional)
String The display name of the dependent property
propertyName (optional)
String The name of the dependent property

DependentValues Up

The values of the dependent property that enable the depending property
values (optional)
array[String] The dependent values

DeprecationNotice Up

The deprecation notice of the extension
alternatives (optional)
array[String] The alternatives to use
reason (optional)
String The reason for the deprecation

DynamicProperty Up

The dynamic properties of the extension
description (optional)
String The description of the dynamic property
expressionLanguageScope (optional)
String The scope of the expression language support
Enum:
NONE
ENVIRONMENT
FLOWFILE_ATTRIBUTES
expressionLanguageSupported (optional)
Boolean Whether or not expression language is supported
name (optional)
String The description of the dynamic property name
value (optional)
String The description of the dynamic property value

DynamicRelationship Up

The dynamic relationships of the extension
description (optional)
String The description of the dynamic relationship
name (optional)
String The description of the dynamic relationship name

Extension Up

configurationSteps (optional)
array[ConfigurationStep] The configuration steps for a Connector extension
defaultSchedule (optional)
DefaultSchedule
defaultSettings (optional)
DefaultSettings
deprecationNotice (optional)
DeprecationNotice
description (optional)
String The description of the extension
dynamicProperties (optional)
array[DynamicProperty] The dynamic properties of the extension
dynamicRelationship (optional)
DynamicRelationship
inputRequirement (optional)
String The input requirement of the extension
Enum:
INPUT_REQUIRED
INPUT_ALLOWED
INPUT_FORBIDDEN
multiProcessorUseCases (optional)
array[MultiProcessorUseCase] Zero or more documented use cases for how the processor may be used in conjunction with other processors
name
String The name of the extension
primaryNodeOnly (optional)
Boolean Indicates that a processor should be scheduled only on the primary node
properties (optional)
array[Property] The properties of the extension
providedServiceAPIs (optional)
array[ProvidedServiceAPI] The service APIs provided by this extension
readsAttributes (optional)
array[Attribute] The attributes read from FlowFiles by the extension
relationships (optional)
array[Relationship] The relationships of the extension
restricted (optional)
Restricted
seeAlso (optional)
array[String] The names of other extensions to see
sideEffectFree (optional)
Boolean Indicates that a processor is side effect free
stateful (optional)
Stateful
supportsBatching (optional)
Boolean Indicates that a processor supports batching
supportsSensitiveDynamicProperties (optional)
Boolean
systemResourceConsiderations (optional)
array[SystemResourceConsideration] The resource considerations of the extension
tags (optional)
array[String] The tags of the extension
triggerSerially (optional)
Boolean Indicates that a processor should be triggered serially
triggerWhenAnyDestinationAvailable (optional)
Boolean Indicates that a processor should be triggered when any destinations have space for FlowFiles
triggerWhenEmpty (optional)
Boolean Indicates that a processor should be triggered when the incoming queues are empty
type
String The type of the extension
Enum:
PROCESSOR
CONTROLLER_SERVICE
REPORTING_TASK
FLOW_ANALYSIS_RULE
PARAMETER_PROVIDER
FLOW_REGISTRY_CLIENT
CONNECTOR
useCases (optional)
array[UseCase] Zero or more documented use cases for how the extension may be used
writesAttributes (optional)
array[Attribute] The attributes written to FlowFiles by the extension

ExtensionFilterParams Up

The filter parameters submitted for the request
bundleType (optional)
String The type of bundle
Enum:
NIFI_NAR
MINIFI_CPP
extensionType (optional)
String The type of extension
Enum:
PROCESSOR
CONTROLLER_SERVICE
REPORTING_TASK
FLOW_ANALYSIS_RULE
PARAMETER_PROVIDER
FLOW_REGISTRY_CLIENT
CONNECTOR
tags (optional)
array[String] The tags

ExtensionMetadata Up

The metadata for the extensions
bundleInfo (optional)
BundleInfo
deprecationNotice (optional)
DeprecationNotice
description (optional)
String The description of the extension
displayName (optional)
String The display name of the extension
hasAdditionalDetails (optional)
Boolean Whether or not the extension has additional detail documentation
link (optional)
Link
linkDocs (optional)
Link
name (optional)
String The name of the extension
providedServiceAPIs (optional)
array[ProvidedServiceAPI] The service APIs provided by the extension
restricted (optional)
Restricted
tags (optional)
array[String] The tags of the extension
type (optional)
String The type of the extension
Enum:
PROCESSOR
CONTROLLER_SERVICE
REPORTING_TASK
FLOW_ANALYSIS_RULE
PARAMETER_PROVIDER
FLOW_REGISTRY_CLIENT
CONNECTOR

ExtensionMetadataContainer Up

extensions (optional)
array[ExtensionMetadata] The metadata for the extensions
filterParams (optional)
ExtensionFilterParams
numResults (optional)
Integer The number of extensions in the response format: int32

ExtensionRepoArtifact Up

artifactId (optional)
String The artifact id
bucketName (optional)
String The bucket name
groupId (optional)
String The group id
link (optional)
Link

ExtensionRepoBucket Up

bucketName (optional)
String The name of the bucket
link (optional)
Link

ExtensionRepoGroup Up

bucketName (optional)
String The bucket name
groupId (optional)
String The group id
link (optional)
Link

ExtensionRepoVersion Up

downloadLink (optional)
Link
extensionsLink (optional)
Link
sha256Link (optional)
Link
sha256Supplied (optional)
Boolean Indicates if the client supplied a SHA-256 when uploading this version of the extension bundle.

ExtensionRepoVersionSummary Up

artifactId (optional)
String The artifact id
author (optional)
String The identity of the user that created this version
bucketName (optional)
String The bucket name
groupId (optional)
String The group id
link (optional)
Link
timestamp (optional)
Long The timestamp of when this version was created format: int64
version (optional)
String The version

ExternalControllerServiceReference Up

The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.
identifier (optional)
String The identifier of the controller service
name (optional)
String The name of the controller service

Fields Up

fields (optional)
array[String]

FormDataContentDisposition Up

creationDate (optional)
Date format: date-time
fileName (optional)
String
modificationDate (optional)
Date format: date-time
name (optional)
String
parameters (optional)
map[String, String]
readDate (optional)
Date format: date-time
size (optional)
Long format: int64
type (optional)
String

Link Up

An WebLink to this entity.
params (optional)
map[String, String]
rel (optional)
String
rels (optional)
array[String]
title (optional)
String
type (optional)
String
uri (optional)
String format: uri
uriBuilder (optional)
UriBuilder

ListenPortDefinition Up

The optional listen port definition
applicationProtocols (optional)
array[String] The application protocols that this listen port could support (if any)
transportProtocol (optional)
String The transport protocol used by this listen port
Enum:
TCP
UDP

LongParameter Up

long (optional)
Long format: int64

MultiProcessorUseCase Up

Zero or more documented use cases for how the processor may be used in conjunction with other processors
description (optional)
String
keywords (optional)
array[String]
notes (optional)
String
processorConfigurations (optional)
array[ProcessorConfiguration]

ParameterProviderReference Up

Contains basic information about parameter providers referenced in the versioned flow.
bundle (optional)
Bundle
identifier (optional)
String The identifier of the parameter provider
name (optional)
String The name of the parameter provider
type (optional)
String The fully qualified name of the parameter provider class.

Permissions Up

The access that the current user has to any top level resources (a logical 'OR' of all other values)
canDelete (optional)
Boolean Indicates whether the user can delete a given resource.
canRead (optional)
Boolean Indicates whether the user can read a given resource.
canWrite (optional)
Boolean Indicates whether the user can write a given resource.

Position Up

The position of a component on the graph
x (optional)
Double The x coordinate. format: double
y (optional)
Double The y coordinate. format: double

ProcessorConfiguration Up

configuration (optional)
String
processorClassName (optional)
String

Property Up

The properties of the extension
allowableValues (optional)
array[AllowableValue] The allowable values for this property
controllerServiceDefinition (optional)
ControllerServiceDefinition
defaultValue (optional)
String The default value
dependencies (optional)
array[Dependency] The properties that this property depends on
description (optional)
String The description
displayName (optional)
String The display name
dynamic (optional)
Boolean Whether or not the processor is dynamic
dynamicallyModifiesClasspath (optional)
Boolean Whether or not the processor dynamically modifies the classpath
expressionLanguageScope (optional)
String The scope of expression language support
Enum:
NONE
ENVIRONMENT
FLOWFILE_ATTRIBUTES
expressionLanguageSupported (optional)
Boolean Whether or not expression language is supported
listenPortDefinition (optional)
ListenPortDefinition
name (optional)
String The name of the property
required (optional)
Boolean Whether or not the property is required
resourceDefinition (optional)
ResourceDefinition
sensitive (optional)
Boolean Whether or not the property is sensitive

ProvidedServiceAPI Up

The service APIs provided by the extension
artifactId
String The artifact id of the service API being provided
className
String The class name of the service API being provided
groupId
String The group id of the service API being provided
version
String The version of the service API being provided

RegistryAbout Up

registryAboutVersion (optional)
String The version string for this Nifi Registry

RegistryConfiguration Up

supportsConfigurableAuthorizer (optional)
Boolean Whether this NiFi Registry supports a configurable authorizer.
supportsConfigurableUsersAndGroups (optional)
Boolean Whether this NiFi Registry supports configurable users and groups.
supportsManagedAuthorizer (optional)
Boolean Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.

Relationship Up

The relationships of the extension
autoTerminated (optional)
Boolean Whether or not the relationship is auto-terminated by default
description (optional)
String The description of the relationship
name (optional)
String The name of the relationship

Resource Up

identifier (optional)
String The identifier of the resource.
name (optional)
String The name of the resource.

ResourceDefinition Up

The optional resource definition
cardinality (optional)
String The cardinality of the resource definition
Enum:
SINGLE
MULTIPLE
resourceTypes (optional)
array[String] The types of resources
Enum:

ResourcePermissions Up

A summary top-level resource access policies granted to this tenant.
anyTopLevelResource (optional)
Permissions
buckets (optional)
Permissions
policies (optional)
Permissions
proxy (optional)
Permissions
tenants (optional)
Permissions

Restricted Up

The restrictions of the extension
generalRestrictionExplanation (optional)
String The general restriction for the extension, or null if only specific restrictions exist
restrictions (optional)
array[Restriction] The specific restrictions

Restriction Up

The specific restrictions
explanation
String The explanation of this restriction
requiredPermission
String The permission required for this restriction

RevisionInfo Up

The revision information for an entity managed through the REST API.
clientId (optional)
String 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.
lastModifier (optional)
String The user that last modified the entity.
version (optional)
Long NiFi Registry 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. format: int64

Stateful Up

The information about how the extension stores state
description (optional)
String The description for how the extension stores state
scopes (optional)
array[String] The scopes used to store state
Enum:

SystemResourceConsideration Up

The resource considerations of the extension
description (optional)
String The description of how the resource is affected
resource (optional)
String The resource to consider

TagCount Up

count (optional)
Integer The number of occurrences of the given tag format: int32
tag (optional)
String The tag label

Tenant Up

The users that belong to this user group. This can only be changed if this group is configurable.
accessPolicies (optional)
array[AccessPolicySummary] The access policies granted to this tenant.
configurable (optional)
Boolean Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.
identifier (optional)
String The computer-generated identifier of the tenant.
identity (optional)
String The human-facing identity of the tenant. This can only be changed if the tenant is configurable.
resourcePermissions (optional)
ResourcePermissions
revision (optional)
RevisionInfo

UriBuilder Up

UseCase Up

Zero or more documented use cases for how the extension may be used
configuration (optional)
String
description (optional)
String
inputRequirement (optional)
String
Enum:
INPUT_REQUIRED
INPUT_ALLOWED
INPUT_FORBIDDEN
keywords (optional)
array[String]
notes (optional)
String

User Up

accessPolicies (optional)
array[AccessPolicySummary] The access policies granted to this tenant.
configurable (optional)
Boolean Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.
identifier (optional)
String The computer-generated identifier of the tenant.
identity (optional)
String The human-facing identity of the tenant. This can only be changed if the tenant is configurable.
resourcePermissions (optional)
ResourcePermissions
revision (optional)
RevisionInfo
userGroups (optional)
array[Tenant] The groups to which the user belongs.

UserGroup Up

accessPolicies (optional)
array[AccessPolicySummary] The access policies granted to this tenant.
configurable (optional)
Boolean Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.
identifier (optional)
String The computer-generated identifier of the tenant.
identity (optional)
String The human-facing identity of the tenant. This can only be changed if the tenant is configurable.
resourcePermissions (optional)
ResourcePermissions
revision (optional)
RevisionInfo
users (optional)
array[Tenant] The users that belong to this user group. This can only be changed if this group is configurable.

VersionedAsset Up

The assets that are referenced by this parameter
identifier (optional)
String The identifier of the asset
name (optional)
String The name of the asset

VersionedComponentState Up

The state of the component, if exported with state
clusterState (optional)
map[String, String] The cluster-scoped state of the component, or null if not exported
localNodeStates (optional)
array[VersionedNodeState] The local-scoped state of the component ordered by node ordinal index, or null if not exported

VersionedConnection Up

The Connections
backPressureDataSizeThreshold (optional)
String 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.
backPressureObjectThreshold (optional)
Long 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. format: int64
bends (optional)
array[Position] The bend points on the connection.
comments (optional)
String The user-supplied comments for the component
componentType (optional)
String
Enum:
CONNECTION
PROCESSOR
PROCESS_GROUP
REMOTE_PROCESS_GROUP
INPUT_PORT
OUTPUT_PORT
REMOTE_INPUT_PORT
REMOTE_OUTPUT_PORT
FUNNEL
LABEL
CONTROLLER_SERVICE
REPORTING_TASK
FLOW_ANALYSIS_RULE
PARAMETER_CONTEXT
PARAMETER_PROVIDER
FLOW_REGISTRY_CLIENT
CONNECTOR
destination (optional)
ConnectableComponent
flowFileExpiration (optional)
String The amount of time a FlowFile may be in the flow before it will be automatically aged out of the flow. Once a FlowFile reaches this age it will be terminated from the flow the next time a processor attempts to start work on it.
groupIdentifier (optional)
String The ID of the Process Group that this component belongs to
identifier (optional)
String The component's unique identifier
instanceIdentifier (optional)
String The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component
labelIndex (optional)
Integer The index of the bend point where to place the connection label. format: int32
loadBalanceCompression (optional)
String Whether or not compression should be used when transferring FlowFiles between nodes Possible returned values: DO_NOT_COMPRESS, COMPRESS_ATTRIBUTES_ONLY, COMPRESS_ATTRIBUTES_AND_CONTENT. See LoadBalanceCompression.class for more details.
loadBalanceStrategy (optional)
String The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified. Possible returned values: DO_NOT_LOAD_BALANCE, PARTITION_BY_ATTRIBUTE, ROUND_ROBIN, SINGLE_NODE. See LoadBalanceStrategy.class for more details.
name (optional)
String The component's name
partitioningAttribute (optional)
String 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.
position (optional)
Position
prioritizers (optional)
array[String] The comparators used to prioritize the queue.
selectedRelationships (optional)
array[String] The selected relationship that comprise the connection.
source (optional)
ConnectableComponent
zIndex (optional)
Long The z index of the connection. format: int64

VersionedControllerService Up

The Controller Services
annotationData (optional)
String The annotation for the controller service. This is how the custom UI relays configuration to the controller service.
bulletinLevel (optional)
String The level at which the controller service will report bulletins.
bundle (optional)
Bundle
comments (optional)
String The user-supplied comments for the component
componentState (optional)
VersionedComponentState
componentType (optional)
String
Enum:
CONNECTION
PROCESSOR
PROCESS_GROUP
REMOTE_PROCESS_GROUP
INPUT_PORT
OUTPUT_PORT
REMOTE_INPUT_PORT
REMOTE_OUTPUT_PORT
FUNNEL
LABEL
CONTROLLER_SERVICE
REPORTING_TASK
FLOW_ANALYSIS_RULE
PARAMETER_CONTEXT
PARAMETER_PROVIDER
FLOW_REGISTRY_CLIENT
CONNECTOR
controllerServiceApis (optional)
array[ControllerServiceAPI] Lists the APIs this Controller Service implements.
groupIdentifier (optional)
String The ID of the Process Group that this component belongs to
identifier (optional)
String The component's unique identifier
instanceIdentifier (optional)
String 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 (optional)
String The component's name
position (optional)
Position
properties (optional)
map[String, String] The properties for the component. Properties whose value is not set will only contain the property name.
propertyDescriptors (optional)
map[String, VersionedPropertyDescriptor] The property descriptors for the component.
scheduledState (optional)
String The ScheduledState denoting whether the Controller Service is ENABLED or DISABLED
Enum:
ENABLED
DISABLED
RUNNING
type (optional)
String The type of the extension component

VersionedFlow Up

The flow this snapshot is for
bucketIdentifier
String The identifier of the bucket this items belongs to. This cannot be changed after the item is created.
bucketName (optional)
String The name of the bucket this items belongs to.
createdTimestamp (optional)
Long The timestamp of when the item was created, as milliseconds since epoch. format: int64
description (optional)
String A description of the item.
identifier
String An ID to uniquely identify this object.
link (optional)
Link
modifiedTimestamp (optional)
Long The timestamp of when the item was last modified, as milliseconds since epoch. format: int64
name
String The name of the item.
permissions (optional)
Permissions
revision (optional)
RevisionInfo
type
String The type of item.
Enum:
Flow
Bundle
versionCount (optional)
Long The number of versions of this flow. format: int64

VersionedFlowCoordinates Up

The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control
branch (optional)
String The name of the branch that the flow resides in
bucketId (optional)
String The UUID of the bucket that the flow resides in
flowId (optional)
String The UUID of the flow
latest (optional)
Boolean Whether or not these coordinates point to the latest version of the flow
registryId (optional)
String The identifier of the Flow Registry that contains the flow
storageLocation (optional)
String The location of the Flow Registry that stores the flow
version (optional)
String The version of the flow

VersionedFlowDifference Up

bucketId (optional)
String The id of the bucket that the flow is stored in.
componentDifferenceGroups (optional)
array[ComponentDifferenceGroup]
flowId (optional)
String The id of the flow that is being examined.
versionA (optional)
Integer The earlier version from the diff operation. format: int32
versionB (optional)
Integer The latter version from the diff operation. format: int32

VersionedFlowSnapshot Up

bucket (optional)
Bucket
externalControllerServices (optional)
map[String, ExternalControllerServiceReference] The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.
flow (optional)
VersionedFlow
flowContents
VersionedProcessGroup
flowEncodingVersion (optional)
String The optional encoding version of the flow contents.
latest (optional)
Boolean
parameterContexts (optional)
map[String, VersionedParameterContext] The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.
parameterProviders (optional)
map[String, ParameterProviderReference] Contains basic information about parameter providers referenced in the versioned flow.
snapshotMetadata
VersionedFlowSnapshotMetadata

VersionedFlowSnapshotMetadata Up

author
String The user that created this snapshot of the flow.
bucketIdentifier
String The identifier of the bucket this snapshot belongs to.
comments (optional)
String The comments provided by the user when creating the snapshot.
flowIdentifier
String The identifier of the flow this snapshot belongs to.
link (optional)
Link
timestamp (optional)
Long The timestamp when the flow was saved, as milliseconds since epoch. format: int64
version (optional)
Integer The version of this snapshot of the flow. format: int32

VersionedFunnel Up

The Funnels
comments (optional)
String The user-supplied comments for the component
componentType (optional)
String
Enum:
CONNECTION
PROCESSOR
PROCESS_GROUP
REMOTE_PROCESS_GROUP
INPUT_PORT
OUTPUT_PORT
REMOTE_INPUT_PORT
REMOTE_OUTPUT_PORT
FUNNEL
LABEL
CONTROLLER_SERVICE
REPORTING_TASK
FLOW_ANALYSIS_RULE
PARAMETER_CONTEXT
PARAMETER_PROVIDER
FLOW_REGISTRY_CLIENT
CONNECTOR
groupIdentifier (optional)
String The ID of the Process Group that this component belongs to
identifier (optional)
String The component's unique identifier
instanceIdentifier (optional)
String 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 (optional)
String The component's name
position (optional)
Position

VersionedLabel Up

The Labels
comments (optional)
String The user-supplied comments for the component
componentType (optional)
String
Enum:
CONNECTION
PROCESSOR
PROCESS_GROUP
REMOTE_PROCESS_GROUP
INPUT_PORT
OUTPUT_PORT
REMOTE_INPUT_PORT
REMOTE_OUTPUT_PORT
FUNNEL
LABEL
CONTROLLER_SERVICE
REPORTING_TASK
FLOW_ANALYSIS_RULE
PARAMETER_CONTEXT
PARAMETER_PROVIDER
FLOW_REGISTRY_CLIENT
CONNECTOR
groupIdentifier (optional)
String The ID of the Process Group that this component belongs to
height (optional)
Double The height of the label in pixels when at a 1:1 scale. format: double
identifier (optional)
String The component's unique identifier
instanceIdentifier (optional)
String The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component
label (optional)
String The text that appears in the label.
name (optional)
String The component's name
position (optional)
Position
style (optional)
map[String, String] The styles for this label (font-size : 12px, background-color : #eee, etc).
width (optional)
Double The width of the label in pixels when at a 1:1 scale. format: double
zIndex (optional)
Long The z index of the connection. format: int64

VersionedListenPortDefinition Up

Returns the Listen Port Definition for the port this property specifies, if applicable
applicationProtocols (optional)
array[String] The application protocol(s) that the listen port could support (if any)
transportProtocol (optional)
String The transport protocol used by the listen port
Enum:
TCP
UDP

VersionedNodeState Up

The state entries for a single node
state (optional)
map[String, String] The state key-value pairs for this node

VersionedParameter Up

The parameters in the context
description (optional)
String The description of the param
name (optional)
String The name of the parameter
provided (optional)
Boolean Whether or not the parameter value is provided by a ParameterProvider
referencedAssets (optional)
array[VersionedAsset] The assets that are referenced by this parameter
sensitive (optional)
Boolean Whether or not the parameter value is sensitive
value (optional)
String The value of the parameter

VersionedParameterContext Up

The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.
comments (optional)
String The user-supplied comments for the component
componentType (optional)
String
Enum:
CONNECTION
PROCESSOR
PROCESS_GROUP
REMOTE_PROCESS_GROUP
INPUT_PORT
OUTPUT_PORT
REMOTE_INPUT_PORT
REMOTE_OUTPUT_PORT
FUNNEL
LABEL
CONTROLLER_SERVICE
REPORTING_TASK
FLOW_ANALYSIS_RULE
PARAMETER_CONTEXT
PARAMETER_PROVIDER
FLOW_REGISTRY_CLIENT
CONNECTOR
description (optional)
String The description of the parameter context
groupIdentifier (optional)
String The ID of the Process Group that this component belongs to
identifier (optional)
String The component's unique identifier
inheritedParameterContexts (optional)
array[String] The names of additional parameter contexts from which to inherit parameters
instanceIdentifier (optional)
String 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 (optional)
String The component's name
parameterGroupName (optional)
String The corresponding parameter group name fetched from the parameter provider, if applicable
parameterProvider (optional)
String The identifier of an optional parameter provider
parameters (optional)
array[VersionedParameter] The parameters in the context
position (optional)
Position
synchronized (optional)
Boolean True if the parameter provider is set and the context should receive updates when its parameters are next fetched

VersionedPort Up

The Output Ports
allowRemoteAccess (optional)
Boolean Whether or not this port allows remote access for site-to-site
comments (optional)
String The user-supplied comments for the component
componentType (optional)
String
Enum:
CONNECTION
PROCESSOR
PROCESS_GROUP
REMOTE_PROCESS_GROUP
INPUT_PORT
OUTPUT_PORT
REMOTE_INPUT_PORT
REMOTE_OUTPUT_PORT
FUNNEL
LABEL
CONTROLLER_SERVICE
REPORTING_TASK
FLOW_ANALYSIS_RULE
PARAMETER_CONTEXT
PARAMETER_PROVIDER
FLOW_REGISTRY_CLIENT
CONNECTOR
concurrentlySchedulableTaskCount (optional)
Integer The number of tasks that should be concurrently scheduled for the port. format: int32
groupIdentifier (optional)
String The ID of the Process Group that this component belongs to
identifier (optional)
String The component's unique identifier
instanceIdentifier (optional)
String 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 (optional)
String The component's name
portFunction (optional)
String Specifies how the Port should function
Enum:
STANDARD
FAILURE
position (optional)
Position
scheduledState (optional)
String The scheduled state of the component
Enum:
ENABLED
DISABLED
RUNNING
type (optional)
String The type of port.
Enum:
INPUT_PORT
OUTPUT_PORT

VersionedProcessGroup Up

The contents of the versioned flow
comments (optional)
String The user-supplied comments for the component
componentType (optional)
String
Enum:
CONNECTION
PROCESSOR
PROCESS_GROUP
REMOTE_PROCESS_GROUP
INPUT_PORT
OUTPUT_PORT
REMOTE_INPUT_PORT
REMOTE_OUTPUT_PORT
FUNNEL
LABEL
CONTROLLER_SERVICE
REPORTING_TASK
FLOW_ANALYSIS_RULE
PARAMETER_CONTEXT
PARAMETER_PROVIDER
FLOW_REGISTRY_CLIENT
CONNECTOR
connections (optional)
array[VersionedConnection] The Connections
controllerServices (optional)
array[VersionedControllerService] The Controller Services
defaultBackPressureDataSizeThreshold (optional)
String Default value used in this Process Group for the maximum data size of objects that can be queued before back pressure is applied.
defaultBackPressureObjectThreshold (optional)
Long Default value used in this Process Group for the maximum number of objects that can be queued before back pressure is applied. format: int64
defaultFlowFileExpiration (optional)
String The default FlowFile Expiration for this Process Group.
executionEngine (optional)
String The Execution Engine that should be used to run the components within the group.
Enum:
STANDARD
STATELESS
INHERITED
flowFileConcurrency (optional)
String The configured FlowFile Concurrency for the Process Group
flowFileOutboundPolicy (optional)
String The FlowFile Outbound Policy for the Process Group
funnels (optional)
array[VersionedFunnel] The Funnels
groupIdentifier (optional)
String The ID of the Process Group that this component belongs to
identifier (optional)
String The component's unique identifier
inputPorts (optional)
array[VersionedPort] The Input Ports
instanceIdentifier (optional)
String The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component
labels (optional)
array[VersionedLabel] The Labels
logFileSuffix (optional)
String The log file suffix for this Process Group for dedicated logging.
maxConcurrentTasks (optional)
Integer The maximum number of concurrent tasks that should be scheduled for this Process Group when using the Stateless Engine format: int32
name (optional)
String The component's name
outputPorts (optional)
array[VersionedPort] The Output Ports
parameterContextName (optional)
String The name of the parameter context used by this process group
position (optional)
Position
processGroups (optional)
array[VersionedProcessGroup] The child Process Groups
processors (optional)
array[VersionedProcessor] The Processors
remoteProcessGroups (optional)
array[VersionedRemoteProcessGroup] The Remote Process Groups
scheduledState (optional)
String The Scheduled State of the Process Group, if the group is configured to use the Stateless Execution Engine. Otherwise, this value has no relevance.
Enum:
ENABLED
DISABLED
RUNNING
statelessFlowTimeout (optional)
String The maximum amount of time that the flow is allows to run using the Stateless engine before it times out and is considered a failure
versionedFlowCoordinates (optional)
VersionedFlowCoordinates

VersionedProcessor Up

The Processors
annotationData (optional)
String The annotation data for the processor used to relay configuration between a custom UI and the processor.
autoTerminatedRelationships (optional)
array[String] The names of all relationships that cause a FlowFile 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.
backoffMechanism (optional)
String Determines whether the FlowFile should be penalized or the processor should be yielded between retries. Possible returned values: PENALIZE_FLOWFILE, YIELD_PROCESSOR.
bulletinLevel (optional)
String The level at which the processor will report bulletins.
bundle (optional)
Bundle
comments (optional)
String The user-supplied comments for the component
componentState (optional)
VersionedComponentState
componentType (optional)
String
Enum:
CONNECTION
PROCESSOR
PROCESS_GROUP
REMOTE_PROCESS_GROUP
INPUT_PORT
OUTPUT_PORT
REMOTE_INPUT_PORT
REMOTE_OUTPUT_PORT
FUNNEL
LABEL
CONTROLLER_SERVICE
REPORTING_TASK
FLOW_ANALYSIS_RULE
PARAMETER_CONTEXT
PARAMETER_PROVIDER
FLOW_REGISTRY_CLIENT
CONNECTOR
concurrentlySchedulableTaskCount (optional)
Integer The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallel processing then any positive input will be ignored. format: int32
executionNode (optional)
String Indicates the node where the process will execute.
groupIdentifier (optional)
String The ID of the Process Group that this component belongs to
identifier (optional)
String The component's unique identifier
instanceIdentifier (optional)
String The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component
maxBackoffPeriod (optional)
String Maximum amount of time to be waited during a retry period.
name (optional)
String The component's name
penaltyDuration (optional)
String The amount of time that is used when the process penalizes a FlowFile.
position (optional)
Position
properties (optional)
map[String, String] The properties for the component. Properties whose value is not set will only contain the property name.
propertyDescriptors (optional)
map[String, VersionedPropertyDescriptor] The property descriptors for the component.
retriedRelationships (optional)
array[String] All the relationships should be retried.
retryCount (optional)
Integer Overall number of retries. format: int32
runDurationMillis (optional)
Long The run duration for the processor in milliseconds. format: int64
scheduledState (optional)
String The scheduled state of the component
Enum:
ENABLED
DISABLED
RUNNING
schedulingPeriod (optional)
String The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy.
schedulingStrategy (optional)
String Indicates how the processor should be scheduled to run.
style (optional)
map[String, String] Stylistic data for rendering in a UI
type (optional)
String The type of the extension component
yieldDuration (optional)
String The amount of time that must elapse before this processor is scheduled again after yielding.

VersionedPropertyDescriptor Up

The property descriptors for the component.
displayName (optional)
String The display name of the property
dynamic (optional)
Boolean Whether or not the property is user-defined
identifiesControllerService (optional)
Boolean Whether or not the property provides the identifier of a Controller Service
listenPortDefinition (optional)
VersionedListenPortDefinition
name (optional)
String The name of the property
resourceDefinition (optional)
VersionedResourceDefinition
sensitive (optional)
Boolean Whether or not the property is considered sensitive

VersionedRemoteGroupPort Up

A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance
batchSize (optional)
BatchSize
comments (optional)
String The user-supplied comments for the component
componentType (optional)
String
Enum:
CONNECTION
PROCESSOR
PROCESS_GROUP
REMOTE_PROCESS_GROUP
INPUT_PORT
OUTPUT_PORT
REMOTE_INPUT_PORT
REMOTE_OUTPUT_PORT
FUNNEL
LABEL
CONTROLLER_SERVICE
REPORTING_TASK
FLOW_ANALYSIS_RULE
PARAMETER_CONTEXT
PARAMETER_PROVIDER
FLOW_REGISTRY_CLIENT
CONNECTOR
concurrentlySchedulableTaskCount (optional)
Integer The number of task that may transmit FlowFiles to the target port concurrently. format: int32
groupIdentifier (optional)
String The ID of the Process Group that this component belongs to
identifier (optional)
String The component's unique identifier
instanceIdentifier (optional)
String 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 (optional)
String The component's name
position (optional)
Position
remoteGroupId (optional)
String The id of the remote process group that the port resides in.
scheduledState (optional)
String The scheduled state of the component
Enum:
ENABLED
DISABLED
RUNNING
targetId (optional)
String The ID of the port on the target NiFi instance
useCompression (optional)
Boolean Whether the FlowFiles are compressed when sent to the target port.

VersionedRemoteProcessGroup Up

The Remote Process Groups
comments (optional)
String The user-supplied comments for the component
communicationsTimeout (optional)
String The time period used for the timeout when communicating with the target.
componentType (optional)
String
Enum:
CONNECTION
PROCESSOR
PROCESS_GROUP
REMOTE_PROCESS_GROUP
INPUT_PORT
OUTPUT_PORT
REMOTE_INPUT_PORT
REMOTE_OUTPUT_PORT
FUNNEL
LABEL
CONTROLLER_SERVICE
REPORTING_TASK
FLOW_ANALYSIS_RULE
PARAMETER_CONTEXT
PARAMETER_PROVIDER
FLOW_REGISTRY_CLIENT
CONNECTOR
groupIdentifier (optional)
String The ID of the Process Group that this component belongs to
identifier (optional)
String The component's unique identifier
inputPorts (optional)
array[VersionedRemoteGroupPort] A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance
instanceIdentifier (optional)
String The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component
localNetworkInterface (optional)
String 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.
name (optional)
String The component's name
outputPorts (optional)
array[VersionedRemoteGroupPort] A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance
position (optional)
Position
proxyHost (optional)
String
proxyPassword (optional)
String
proxyPort (optional)
Integer format: int32
proxyUser (optional)
String
targetUris (optional)
String 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.
transportProtocol (optional)
String The Transport Protocol that is used for Site-to-Site communications. Possible returned values: RAW, HTTP.
yieldDuration (optional)
String When yielding, this amount of time must elapse before the remote process group is scheduled again.

VersionedResourceDefinition Up

Returns the Resource Definition that defines which type(s) of resource(s) this property references, if any
cardinality (optional)
String The cardinality of the resource
Enum:
SINGLE
MULTIPLE
resourceTypes (optional)
array[String] The types of resource that the Property Descriptor is allowed to reference
Enum:

bundles_bundleType_body Up

file (optional)
FormDataContentDisposition
sha256 (optional)
String