Apache NiFi Registry REST API

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.
More information: https://nifi.apache.org
Contact Info: dev@nifi.apache.org
Version: 1.23.2
Apache 2.0 License
https://www.apache.org/licenses/LICENSE-2.0.html

Access

  1. APIKey KeyParamName:Authorization KeyInQuery:false KeyInHeader:true
  2. HTTP Basic Authentication

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

200

successful operation 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

200

successful operation 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

200

successful operation 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

200

successful operation 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

200

successful operation 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" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : 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

successful operation 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

successful operation 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.

Responses

default

successful operation
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.

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

successful operation String
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.

Responses

default

successful operation
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.

Responses

default

successful operation
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.

Responses

default

successful operation
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

successful operation 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

Return type

BundleVersion

Example data

Content-Type: application/json
{
  "bucket" : {
    "identifier" : "identifier",
    "allowBundleRedeploy" : true,
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "name" : "name",
    "description" : "description",
    "allowPublicRead" : true,
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "filename" : "filename",
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "versionMetadata" : {
    "sha256" : "sha256",
    "buildInfo" : {
      "buildBranch" : "buildBranch",
      "builtBy" : "builtBy",
      "buildTag" : "buildTag",
      "buildRevision" : "buildRevision",
      "built" : 1,
      "buildTool" : "buildTool",
      "buildFlags" : "buildFlags"
    },
    "author" : "author",
    "groupId" : "groupId",
    "bundleId" : "bundleId",
    "description" : "description",
    "bucketId" : "bucketId",
    "version" : "version",
    "sha256Supplied" : true,
    "contentSize" : 0,
    "artifactId" : "artifactId",
    "id" : "id",
    "timestamp" : 1,
    "systemApiVersion" : "systemApiVersion"
  },
  "bundle" : {
    "versionCount" : 0,
    "identifier" : "identifier",
    "bucketName" : "bucketName",
    "createdTimestamp" : 1,
    "groupId" : "groupId",
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "description" : "description",
    "bucketIdentifier" : "bucketIdentifier",
    "bundleType" : "NIFI_NAR",
    "type" : "Flow",
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "name" : "name",
    "modifiedTimestamp" : 1,
    "artifactId" : "artifactId"
  },
  "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

successful operation 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[ExtensionBundle]

Example data

Content-Type: application/json
[ {
  "versionCount" : 0,
  "identifier" : "identifier",
  "bucketName" : "bucketName",
  "createdTimestamp" : 1,
  "groupId" : "groupId",
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "description" : "description",
  "bucketIdentifier" : "bucketIdentifier",
  "bundleType" : "NIFI_NAR",
  "type" : "Flow",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "name" : "name",
  "modifiedTimestamp" : 1,
  "artifactId" : "artifactId"
}, {
  "versionCount" : 0,
  "identifier" : "identifier",
  "bucketName" : "bucketName",
  "createdTimestamp" : 1,
  "groupId" : "groupId",
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "description" : "description",
  "bucketIdentifier" : "bucketIdentifier",
  "bundleType" : "NIFI_NAR",
  "type" : "Flow",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "name" : "name",
  "modifiedTimestamp" : 1,
  "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

successful operation

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,
  "identifier" : "identifier",
  "bucketName" : "bucketName",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "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

successful operation 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,
      "canWrite" : true,
      "canDelete" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "name" : "name",
    "description" : "description",
    "allowPublicRead" : true,
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "snapshotMetadata" : {
    "flowIdentifier" : "flowIdentifier",
    "comments" : "comments",
    "author" : "author",
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "bucketIdentifier" : "bucketIdentifier",
    "version" : 0,
    "timestamp" : 1
  },
  "externalControllerServices" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name"
    }
  },
  "flowContents" : {
    "processors" : [ {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 2,
      "type" : "type",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "sensitive" : true
        }
      },
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 9,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "PENALIZE_FLOWFILE",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "schedulingPeriod" : "schedulingPeriod",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    }, {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 2,
      "type" : "type",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "sensitive" : true
        }
      },
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 9,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "PENALIZE_FLOWFILE",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "schedulingPeriod" : "schedulingPeriod",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    } ],
    "processGroups" : [ null, null ],
    "outputPorts" : [ null, null ],
    "funnels" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    } ],
    "versionedFlowCoordinates" : {
      "registryUrl" : "registryUrl",
      "registryId" : "registryId",
      "storageLocation" : "storageLocation",
      "bucketId" : "bucketId",
      "flowId" : "flowId",
      "version" : 6,
      "latest" : true
    },
    "connections" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "DO_NOT_COMPRESS",
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "DO_NOT_LOAD_BALANCE",
      "source" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "labelIndex" : 2,
      "bends" : [ null, null ],
      "backPressureObjectThreshold" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 4
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "DO_NOT_COMPRESS",
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "DO_NOT_LOAD_BALANCE",
      "source" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "labelIndex" : 2,
      "bends" : [ null, null ],
      "backPressureObjectThreshold" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 4
    } ],
    "logFileSuffix" : "logFileSuffix",
    "parameterContextName" : "parameterContextName",
    "identifier" : "identifier",
    "componentType" : "CONNECTION",
    "variables" : {
      "key" : "variables"
    },
    "defaultBackPressureObjectThreshold" : 7,
    "comments" : "comments",
    "labels" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "width" : 1.0246457001441578,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "zIndex" : 1,
      "height" : 1.4894159098541704
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "width" : 1.0246457001441578,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "zIndex" : 1,
      "height" : 1.4894159098541704
    } ],
    "defaultBackPressureDataSizeThreshold" : "defaultBackPressureDataSizeThreshold",
    "controllerServices" : [ {
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "type" : "type",
      "propertyDescriptors" : { },
      "scheduledState" : "ENABLED",
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    }, {
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "type" : "type",
      "propertyDescriptors" : { },
      "scheduledState" : "ENABLED",
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    } ],
    "defaultFlowFileExpiration" : "defaultFlowFileExpiration",
    "flowFileConcurrency" : "flowFileConcurrency",
    "flowFileOutboundPolicy" : "flowFileOutboundPolicy",
    "name" : "name",
    "inputPorts" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 3,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "type" : "INPUT_PORT",
      "groupIdentifier" : "groupIdentifier",
      "scheduledState" : "ENABLED"
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 3,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "type" : "INPUT_PORT",
      "groupIdentifier" : "groupIdentifier",
      "scheduledState" : "ENABLED"
    } ],
    "instanceIdentifier" : "instanceIdentifier",
    "position" : {
      "x" : 0.8008281904610115,
      "y" : 6.027456183070403
    },
    "remoteProcessGroups" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 1,
      "transportProtocol" : "RAW",
      "outputPorts" : [ null, null ],
      "name" : "name",
      "targetUri" : "targetUri",
      "proxyUser" : "proxyUser",
      "targetUris" : "targetUris",
      "inputPorts" : [ {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 1,
      "transportProtocol" : "RAW",
      "outputPorts" : [ null, null ],
      "name" : "name",
      "targetUri" : "targetUri",
      "proxyUser" : "proxyUser",
      "targetUris" : "targetUris",
      "inputPorts" : [ {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    } ],
    "groupIdentifier" : "groupIdentifier"
  },
  "parameterProviders" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name",
      "type" : "type"
    }
  },
  "flowEncodingVersion" : "flowEncodingVersion",
  "flow" : {
    "versionCount" : 0,
    "identifier" : "identifier",
    "bucketName" : "bucketName",
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "name" : "name",
    "description" : "description",
    "modifiedTimestamp" : 1,
    "bucketIdentifier" : "bucketIdentifier",
    "type" : "Flow",
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "parameterContexts" : {
    "key" : {
      "parameterGroupName" : "parameterGroupName",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "synchronized" : true,
      "comments" : "comments",
      "description" : "description",
      "inheritedParameterContexts" : [ "inheritedParameterContexts", "inheritedParameterContexts" ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "parameters" : [ {
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      }, {
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      } ],
      "parameterProvider" : "parameterProvider"
    }
  },
  "latest" : 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

successful operation 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,
  "identifier" : "identifier",
  "bucketName" : "bucketName",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "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

successful operation 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,
      "canWrite" : true,
      "canDelete" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "name" : "name",
    "description" : "description",
    "allowPublicRead" : true,
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "snapshotMetadata" : {
    "flowIdentifier" : "flowIdentifier",
    "comments" : "comments",
    "author" : "author",
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "bucketIdentifier" : "bucketIdentifier",
    "version" : 0,
    "timestamp" : 1
  },
  "externalControllerServices" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name"
    }
  },
  "flowContents" : {
    "processors" : [ {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 2,
      "type" : "type",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "sensitive" : true
        }
      },
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 9,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "PENALIZE_FLOWFILE",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "schedulingPeriod" : "schedulingPeriod",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    }, {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 2,
      "type" : "type",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "sensitive" : true
        }
      },
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 9,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "PENALIZE_FLOWFILE",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "schedulingPeriod" : "schedulingPeriod",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    } ],
    "processGroups" : [ null, null ],
    "outputPorts" : [ null, null ],
    "funnels" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    } ],
    "versionedFlowCoordinates" : {
      "registryUrl" : "registryUrl",
      "registryId" : "registryId",
      "storageLocation" : "storageLocation",
      "bucketId" : "bucketId",
      "flowId" : "flowId",
      "version" : 6,
      "latest" : true
    },
    "connections" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "DO_NOT_COMPRESS",
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "DO_NOT_LOAD_BALANCE",
      "source" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "labelIndex" : 2,
      "bends" : [ null, null ],
      "backPressureObjectThreshold" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 4
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "DO_NOT_COMPRESS",
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "DO_NOT_LOAD_BALANCE",
      "source" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "labelIndex" : 2,
      "bends" : [ null, null ],
      "backPressureObjectThreshold" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 4
    } ],
    "logFileSuffix" : "logFileSuffix",
    "parameterContextName" : "parameterContextName",
    "identifier" : "identifier",
    "componentType" : "CONNECTION",
    "variables" : {
      "key" : "variables"
    },
    "defaultBackPressureObjectThreshold" : 7,
    "comments" : "comments",
    "labels" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "width" : 1.0246457001441578,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "zIndex" : 1,
      "height" : 1.4894159098541704
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "width" : 1.0246457001441578,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "zIndex" : 1,
      "height" : 1.4894159098541704
    } ],
    "defaultBackPressureDataSizeThreshold" : "defaultBackPressureDataSizeThreshold",
    "controllerServices" : [ {
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "type" : "type",
      "propertyDescriptors" : { },
      "scheduledState" : "ENABLED",
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    }, {
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "type" : "type",
      "propertyDescriptors" : { },
      "scheduledState" : "ENABLED",
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    } ],
    "defaultFlowFileExpiration" : "defaultFlowFileExpiration",
    "flowFileConcurrency" : "flowFileConcurrency",
    "flowFileOutboundPolicy" : "flowFileOutboundPolicy",
    "name" : "name",
    "inputPorts" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 3,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "type" : "INPUT_PORT",
      "groupIdentifier" : "groupIdentifier",
      "scheduledState" : "ENABLED"
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 3,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "type" : "INPUT_PORT",
      "groupIdentifier" : "groupIdentifier",
      "scheduledState" : "ENABLED"
    } ],
    "instanceIdentifier" : "instanceIdentifier",
    "position" : {
      "x" : 0.8008281904610115,
      "y" : 6.027456183070403
    },
    "remoteProcessGroups" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 1,
      "transportProtocol" : "RAW",
      "outputPorts" : [ null, null ],
      "name" : "name",
      "targetUri" : "targetUri",
      "proxyUser" : "proxyUser",
      "targetUris" : "targetUris",
      "inputPorts" : [ {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 1,
      "transportProtocol" : "RAW",
      "outputPorts" : [ null, null ],
      "name" : "name",
      "targetUri" : "targetUri",
      "proxyUser" : "proxyUser",
      "targetUris" : "targetUris",
      "inputPorts" : [ {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    } ],
    "groupIdentifier" : "groupIdentifier"
  },
  "parameterProviders" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name",
      "type" : "type"
    }
  },
  "flowEncodingVersion" : "flowEncodingVersion",
  "flow" : {
    "versionCount" : 0,
    "identifier" : "identifier",
    "bucketName" : "bucketName",
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "name" : "name",
    "description" : "description",
    "modifiedTimestamp" : 1,
    "bucketIdentifier" : "bucketIdentifier",
    "type" : "Flow",
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "parameterContexts" : {
    "key" : {
      "parameterGroupName" : "parameterGroupName",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "synchronized" : true,
      "comments" : "comments",
      "description" : "description",
      "inheritedParameterContexts" : [ "inheritedParameterContexts", "inheritedParameterContexts" ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "parameters" : [ {
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      }, {
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      } ],
      "parameterProvider" : "parameterProvider"
    }
  },
  "latest" : 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

successful operation 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,
  "identifier" : "identifier",
  "bucketName" : "bucketName",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "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

successful operation 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",
  "flowId" : "flowId",
  "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"
  } ]
}

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

successful operation 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,
      "canWrite" : true,
      "canDelete" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "name" : "name",
    "description" : "description",
    "allowPublicRead" : true,
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "snapshotMetadata" : {
    "flowIdentifier" : "flowIdentifier",
    "comments" : "comments",
    "author" : "author",
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "bucketIdentifier" : "bucketIdentifier",
    "version" : 0,
    "timestamp" : 1
  },
  "externalControllerServices" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name"
    }
  },
  "flowContents" : {
    "processors" : [ {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 2,
      "type" : "type",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "sensitive" : true
        }
      },
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 9,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "PENALIZE_FLOWFILE",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "schedulingPeriod" : "schedulingPeriod",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    }, {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 2,
      "type" : "type",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "sensitive" : true
        }
      },
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 9,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "PENALIZE_FLOWFILE",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "schedulingPeriod" : "schedulingPeriod",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    } ],
    "processGroups" : [ null, null ],
    "outputPorts" : [ null, null ],
    "funnels" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    } ],
    "versionedFlowCoordinates" : {
      "registryUrl" : "registryUrl",
      "registryId" : "registryId",
      "storageLocation" : "storageLocation",
      "bucketId" : "bucketId",
      "flowId" : "flowId",
      "version" : 6,
      "latest" : true
    },
    "connections" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "DO_NOT_COMPRESS",
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "DO_NOT_LOAD_BALANCE",
      "source" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "labelIndex" : 2,
      "bends" : [ null, null ],
      "backPressureObjectThreshold" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 4
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "DO_NOT_COMPRESS",
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "DO_NOT_LOAD_BALANCE",
      "source" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "labelIndex" : 2,
      "bends" : [ null, null ],
      "backPressureObjectThreshold" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 4
    } ],
    "logFileSuffix" : "logFileSuffix",
    "parameterContextName" : "parameterContextName",
    "identifier" : "identifier",
    "componentType" : "CONNECTION",
    "variables" : {
      "key" : "variables"
    },
    "defaultBackPressureObjectThreshold" : 7,
    "comments" : "comments",
    "labels" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "width" : 1.0246457001441578,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "zIndex" : 1,
      "height" : 1.4894159098541704
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "width" : 1.0246457001441578,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "zIndex" : 1,
      "height" : 1.4894159098541704
    } ],
    "defaultBackPressureDataSizeThreshold" : "defaultBackPressureDataSizeThreshold",
    "controllerServices" : [ {
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "type" : "type",
      "propertyDescriptors" : { },
      "scheduledState" : "ENABLED",
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    }, {
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "type" : "type",
      "propertyDescriptors" : { },
      "scheduledState" : "ENABLED",
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    } ],
    "defaultFlowFileExpiration" : "defaultFlowFileExpiration",
    "flowFileConcurrency" : "flowFileConcurrency",
    "flowFileOutboundPolicy" : "flowFileOutboundPolicy",
    "name" : "name",
    "inputPorts" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 3,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "type" : "INPUT_PORT",
      "groupIdentifier" : "groupIdentifier",
      "scheduledState" : "ENABLED"
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 3,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "type" : "INPUT_PORT",
      "groupIdentifier" : "groupIdentifier",
      "scheduledState" : "ENABLED"
    } ],
    "instanceIdentifier" : "instanceIdentifier",
    "position" : {
      "x" : 0.8008281904610115,
      "y" : 6.027456183070403
    },
    "remoteProcessGroups" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 1,
      "transportProtocol" : "RAW",
      "outputPorts" : [ null, null ],
      "name" : "name",
      "targetUri" : "targetUri",
      "proxyUser" : "proxyUser",
      "targetUris" : "targetUris",
      "inputPorts" : [ {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 1,
      "transportProtocol" : "RAW",
      "outputPorts" : [ null, null ],
      "name" : "name",
      "targetUri" : "targetUri",
      "proxyUser" : "proxyUser",
      "targetUris" : "targetUris",
      "inputPorts" : [ {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    } ],
    "groupIdentifier" : "groupIdentifier"
  },
  "parameterProviders" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name",
      "type" : "type"
    }
  },
  "flowEncodingVersion" : "flowEncodingVersion",
  "flow" : {
    "versionCount" : 0,
    "identifier" : "identifier",
    "bucketName" : "bucketName",
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "name" : "name",
    "description" : "description",
    "modifiedTimestamp" : 1,
    "bucketIdentifier" : "bucketIdentifier",
    "type" : "Flow",
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "parameterContexts" : {
    "key" : {
      "parameterGroupName" : "parameterGroupName",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "synchronized" : true,
      "comments" : "comments",
      "description" : "description",
      "inheritedParameterContexts" : [ "inheritedParameterContexts", "inheritedParameterContexts" ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "parameters" : [ {
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      }, {
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      } ],
      "parameterProvider" : "parameterProvider"
    }
  },
  "latest" : 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

successful operation 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" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "bucketIdentifier" : "bucketIdentifier",
  "version" : 0,
  "timestamp" : 1
}, {
  "flowIdentifier" : "flowIdentifier",
  "comments" : "comments",
  "author" : "author",
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "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

successful operation

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,
  "identifier" : "identifier",
  "bucketName" : "bucketName",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "name" : "name",
  "description" : "description",
  "modifiedTimestamp" : 1,
  "bucketIdentifier" : "bucketIdentifier",
  "type" : "Flow",
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}, {
  "versionCount" : 0,
  "identifier" : "identifier",
  "bucketName" : "bucketName",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "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

successful operation

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,
      "canWrite" : true,
      "canDelete" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "name" : "name",
    "description" : "description",
    "allowPublicRead" : true,
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "snapshotMetadata" : {
    "flowIdentifier" : "flowIdentifier",
    "comments" : "comments",
    "author" : "author",
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "bucketIdentifier" : "bucketIdentifier",
    "version" : 0,
    "timestamp" : 1
  },
  "externalControllerServices" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name"
    }
  },
  "flowContents" : {
    "processors" : [ {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 2,
      "type" : "type",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "sensitive" : true
        }
      },
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 9,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "PENALIZE_FLOWFILE",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "schedulingPeriod" : "schedulingPeriod",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    }, {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 2,
      "type" : "type",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "sensitive" : true
        }
      },
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 9,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "PENALIZE_FLOWFILE",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "schedulingPeriod" : "schedulingPeriod",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    } ],
    "processGroups" : [ null, null ],
    "outputPorts" : [ null, null ],
    "funnels" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    } ],
    "versionedFlowCoordinates" : {
      "registryUrl" : "registryUrl",
      "registryId" : "registryId",
      "storageLocation" : "storageLocation",
      "bucketId" : "bucketId",
      "flowId" : "flowId",
      "version" : 6,
      "latest" : true
    },
    "connections" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "DO_NOT_COMPRESS",
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "DO_NOT_LOAD_BALANCE",
      "source" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "labelIndex" : 2,
      "bends" : [ null, null ],
      "backPressureObjectThreshold" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 4
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "DO_NOT_COMPRESS",
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "DO_NOT_LOAD_BALANCE",
      "source" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "labelIndex" : 2,
      "bends" : [ null, null ],
      "backPressureObjectThreshold" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 4
    } ],
    "logFileSuffix" : "logFileSuffix",
    "parameterContextName" : "parameterContextName",
    "identifier" : "identifier",
    "componentType" : "CONNECTION",
    "variables" : {
      "key" : "variables"
    },
    "defaultBackPressureObjectThreshold" : 7,
    "comments" : "comments",
    "labels" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "width" : 1.0246457001441578,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "zIndex" : 1,
      "height" : 1.4894159098541704
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "width" : 1.0246457001441578,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "zIndex" : 1,
      "height" : 1.4894159098541704
    } ],
    "defaultBackPressureDataSizeThreshold" : "defaultBackPressureDataSizeThreshold",
    "controllerServices" : [ {
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "type" : "type",
      "propertyDescriptors" : { },
      "scheduledState" : "ENABLED",
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    }, {
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "type" : "type",
      "propertyDescriptors" : { },
      "scheduledState" : "ENABLED",
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    } ],
    "defaultFlowFileExpiration" : "defaultFlowFileExpiration",
    "flowFileConcurrency" : "flowFileConcurrency",
    "flowFileOutboundPolicy" : "flowFileOutboundPolicy",
    "name" : "name",
    "inputPorts" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 3,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "type" : "INPUT_PORT",
      "groupIdentifier" : "groupIdentifier",
      "scheduledState" : "ENABLED"
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 3,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "type" : "INPUT_PORT",
      "groupIdentifier" : "groupIdentifier",
      "scheduledState" : "ENABLED"
    } ],
    "instanceIdentifier" : "instanceIdentifier",
    "position" : {
      "x" : 0.8008281904610115,
      "y" : 6.027456183070403
    },
    "remoteProcessGroups" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 1,
      "transportProtocol" : "RAW",
      "outputPorts" : [ null, null ],
      "name" : "name",
      "targetUri" : "targetUri",
      "proxyUser" : "proxyUser",
      "targetUris" : "targetUris",
      "inputPorts" : [ {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 1,
      "transportProtocol" : "RAW",
      "outputPorts" : [ null, null ],
      "name" : "name",
      "targetUri" : "targetUri",
      "proxyUser" : "proxyUser",
      "targetUris" : "targetUris",
      "inputPorts" : [ {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    } ],
    "groupIdentifier" : "groupIdentifier"
  },
  "parameterProviders" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name",
      "type" : "type"
    }
  },
  "flowEncodingVersion" : "flowEncodingVersion",
  "flow" : {
    "versionCount" : 0,
    "identifier" : "identifier",
    "bucketName" : "bucketName",
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "name" : "name",
    "description" : "description",
    "modifiedTimestamp" : 1,
    "bucketIdentifier" : "bucketIdentifier",
    "type" : "Flow",
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "parameterContexts" : {
    "key" : {
      "parameterGroupName" : "parameterGroupName",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "synchronized" : true,
      "comments" : "comments",
      "description" : "description",
      "inheritedParameterContexts" : [ "inheritedParameterContexts", "inheritedParameterContexts" ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "parameters" : [ {
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      }, {
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      } ],
      "parameterProvider" : "parameterProvider"
    }
  },
  "latest" : 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

successful operation 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" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "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

successful operation 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,
      "canWrite" : true,
      "canDelete" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "name" : "name",
    "description" : "description",
    "allowPublicRead" : true,
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "snapshotMetadata" : {
    "flowIdentifier" : "flowIdentifier",
    "comments" : "comments",
    "author" : "author",
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "bucketIdentifier" : "bucketIdentifier",
    "version" : 0,
    "timestamp" : 1
  },
  "externalControllerServices" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name"
    }
  },
  "flowContents" : {
    "processors" : [ {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 2,
      "type" : "type",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "sensitive" : true
        }
      },
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 9,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "PENALIZE_FLOWFILE",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "schedulingPeriod" : "schedulingPeriod",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    }, {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 2,
      "type" : "type",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "sensitive" : true
        }
      },
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 9,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "PENALIZE_FLOWFILE",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "schedulingPeriod" : "schedulingPeriod",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    } ],
    "processGroups" : [ null, null ],
    "outputPorts" : [ null, null ],
    "funnels" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    } ],
    "versionedFlowCoordinates" : {
      "registryUrl" : "registryUrl",
      "registryId" : "registryId",
      "storageLocation" : "storageLocation",
      "bucketId" : "bucketId",
      "flowId" : "flowId",
      "version" : 6,
      "latest" : true
    },
    "connections" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "DO_NOT_COMPRESS",
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "DO_NOT_LOAD_BALANCE",
      "source" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "labelIndex" : 2,
      "bends" : [ null, null ],
      "backPressureObjectThreshold" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 4
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "DO_NOT_COMPRESS",
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "DO_NOT_LOAD_BALANCE",
      "source" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "labelIndex" : 2,
      "bends" : [ null, null ],
      "backPressureObjectThreshold" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 4
    } ],
    "logFileSuffix" : "logFileSuffix",
    "parameterContextName" : "parameterContextName",
    "identifier" : "identifier",
    "componentType" : "CONNECTION",
    "variables" : {
      "key" : "variables"
    },
    "defaultBackPressureObjectThreshold" : 7,
    "comments" : "comments",
    "labels" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "width" : 1.0246457001441578,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "zIndex" : 1,
      "height" : 1.4894159098541704
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "width" : 1.0246457001441578,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "zIndex" : 1,
      "height" : 1.4894159098541704
    } ],
    "defaultBackPressureDataSizeThreshold" : "defaultBackPressureDataSizeThreshold",
    "controllerServices" : [ {
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "type" : "type",
      "propertyDescriptors" : { },
      "scheduledState" : "ENABLED",
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    }, {
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "type" : "type",
      "propertyDescriptors" : { },
      "scheduledState" : "ENABLED",
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    } ],
    "defaultFlowFileExpiration" : "defaultFlowFileExpiration",
    "flowFileConcurrency" : "flowFileConcurrency",
    "flowFileOutboundPolicy" : "flowFileOutboundPolicy",
    "name" : "name",
    "inputPorts" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 3,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "type" : "INPUT_PORT",
      "groupIdentifier" : "groupIdentifier",
      "scheduledState" : "ENABLED"
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 3,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "type" : "INPUT_PORT",
      "groupIdentifier" : "groupIdentifier",
      "scheduledState" : "ENABLED"
    } ],
    "instanceIdentifier" : "instanceIdentifier",
    "position" : {
      "x" : 0.8008281904610115,
      "y" : 6.027456183070403
    },
    "remoteProcessGroups" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 1,
      "transportProtocol" : "RAW",
      "outputPorts" : [ null, null ],
      "name" : "name",
      "targetUri" : "targetUri",
      "proxyUser" : "proxyUser",
      "targetUris" : "targetUris",
      "inputPorts" : [ {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 1,
      "transportProtocol" : "RAW",
      "outputPorts" : [ null, null ],
      "name" : "name",
      "targetUri" : "targetUri",
      "proxyUser" : "proxyUser",
      "targetUris" : "targetUris",
      "inputPorts" : [ {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    } ],
    "groupIdentifier" : "groupIdentifier"
  },
  "parameterProviders" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name",
      "type" : "type"
    }
  },
  "flowEncodingVersion" : "flowEncodingVersion",
  "flow" : {
    "versionCount" : 0,
    "identifier" : "identifier",
    "bucketName" : "bucketName",
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "name" : "name",
    "description" : "description",
    "modifiedTimestamp" : 1,
    "bucketIdentifier" : "bucketIdentifier",
    "type" : "Flow",
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "parameterContexts" : {
    "key" : {
      "parameterGroupName" : "parameterGroupName",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "synchronized" : true,
      "comments" : "comments",
      "description" : "description",
      "inheritedParameterContexts" : [ "inheritedParameterContexts", "inheritedParameterContexts" ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "parameters" : [ {
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      }, {
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      } ],
      "parameterProvider" : "parameterProvider"
    }
  },
  "latest" : 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

successful operation VersionedFlowSnapshot

201

The resource has been successfully created.

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,
  "identifier" : "identifier",
  "bucketName" : "bucketName",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "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

successful operation 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,
    "canWrite" : true,
    "canDelete" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "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

successful operation 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,
    "canWrite" : true,
    "canDelete" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "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

successful operation 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

200

successful operation 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,
    "canWrite" : true,
    "canDelete" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "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

successful operation 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,
    "canWrite" : true,
    "canDelete" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "name" : "name",
  "description" : "description",
  "allowPublicRead" : true,
  "revision" : {
    "clientId" : "clientId",
    "lastModifier" : "lastModifier",
    "version" : 6
  }
}, {
  "identifier" : "identifier",
  "allowBundleRedeploy" : true,
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "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

successful operation

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,
    "canWrite" : true,
    "canDelete" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "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

successful operation 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 
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

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

successful operation 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.

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

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

successful operation 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.

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 (getBundleVersions)

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 maye 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",
    "buildTag" : "buildTag",
    "buildRevision" : "buildRevision",
    "built" : 1,
    "buildTool" : "buildTool",
    "buildFlags" : "buildFlags"
  },
  "author" : "author",
  "groupId" : "groupId",
  "bundleId" : "bundleId",
  "description" : "description",
  "bucketId" : "bucketId",
  "version" : "version",
  "sha256Supplied" : true,
  "contentSize" : 0,
  "artifactId" : "artifactId",
  "id" : "id",
  "timestamp" : 1,
  "systemApiVersion" : "systemApiVersion"
}, {
  "sha256" : "sha256",
  "buildInfo" : {
    "buildBranch" : "buildBranch",
    "builtBy" : "builtBy",
    "buildTag" : "buildTag",
    "buildRevision" : "buildRevision",
    "built" : 1,
    "buildTool" : "buildTool",
    "buildFlags" : "buildFlags"
  },
  "author" : "author",
  "groupId" : "groupId",
  "bundleId" : "bundleId",
  "description" : "description",
  "bucketId" : "bucketId",
  "version" : "version",
  "sha256Supplied" : true,
  "contentSize" : 0,
  "artifactId" : "artifactId",
  "id" : "id",
  "timestamp" : 1,
  "systemApiVersion" : "systemApiVersion"
} ]

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

successful operation

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[ExtensionBundle]

Example data

Content-Type: application/json
[ {
  "versionCount" : 0,
  "identifier" : "identifier",
  "bucketName" : "bucketName",
  "createdTimestamp" : 1,
  "groupId" : "groupId",
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "description" : "description",
  "bucketIdentifier" : "bucketIdentifier",
  "bundleType" : "NIFI_NAR",
  "type" : "Flow",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "name" : "name",
  "modifiedTimestamp" : 1,
  "artifactId" : "artifactId"
}, {
  "versionCount" : 0,
  "identifier" : "identifier",
  "bucketName" : "bucketName",
  "createdTimestamp" : 1,
  "groupId" : "groupId",
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "description" : "description",
  "bucketIdentifier" : "bucketIdentifier",
  "bundleType" : "NIFI_NAR",
  "type" : "Flow",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "name" : "name",
  "modifiedTimestamp" : 1,
  "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

successful operation

401

Client could not be authenticated.
Up 
delete /bundles/{bundleId}/versions/{version}
Delete bundle version (globalDeleteBundleVersion)

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,
      "canWrite" : true,
      "canDelete" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "name" : "name",
    "description" : "description",
    "allowPublicRead" : true,
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "filename" : "filename",
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "versionMetadata" : {
    "sha256" : "sha256",
    "buildInfo" : {
      "buildBranch" : "buildBranch",
      "builtBy" : "builtBy",
      "buildTag" : "buildTag",
      "buildRevision" : "buildRevision",
      "built" : 1,
      "buildTool" : "buildTool",
      "buildFlags" : "buildFlags"
    },
    "author" : "author",
    "groupId" : "groupId",
    "bundleId" : "bundleId",
    "description" : "description",
    "bucketId" : "bucketId",
    "version" : "version",
    "sha256Supplied" : true,
    "contentSize" : 0,
    "artifactId" : "artifactId",
    "id" : "id",
    "timestamp" : 1,
    "systemApiVersion" : "systemApiVersion"
  },
  "bundle" : {
    "versionCount" : 0,
    "identifier" : "identifier",
    "bucketName" : "bucketName",
    "createdTimestamp" : 1,
    "groupId" : "groupId",
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "description" : "description",
    "bucketIdentifier" : "bucketIdentifier",
    "bundleType" : "NIFI_NAR",
    "type" : "Flow",
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "name" : "name",
    "modifiedTimestamp" : 1,
    "artifactId" : "artifactId"
  },
  "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

successful operation 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 
delete /bundles/{bundleId}
Delete bundle (globalDeleteExtensionBundle)

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

ExtensionBundle

Example data

Content-Type: application/json
{
  "versionCount" : 0,
  "identifier" : "identifier",
  "bucketName" : "bucketName",
  "createdTimestamp" : 1,
  "groupId" : "groupId",
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "description" : "description",
  "bucketIdentifier" : "bucketIdentifier",
  "bundleType" : "NIFI_NAR",
  "type" : "Flow",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "name" : "name",
  "modifiedTimestamp" : 1,
  "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

successful operation ExtensionBundle

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 (globalGetBundleVersion)

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,
      "canWrite" : true,
      "canDelete" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "name" : "name",
    "description" : "description",
    "allowPublicRead" : true,
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "filename" : "filename",
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "versionMetadata" : {
    "sha256" : "sha256",
    "buildInfo" : {
      "buildBranch" : "buildBranch",
      "builtBy" : "builtBy",
      "buildTag" : "buildTag",
      "buildRevision" : "buildRevision",
      "built" : 1,
      "buildTool" : "buildTool",
      "buildFlags" : "buildFlags"
    },
    "author" : "author",
    "groupId" : "groupId",
    "bundleId" : "bundleId",
    "description" : "description",
    "bucketId" : "bucketId",
    "version" : "version",
    "sha256Supplied" : true,
    "contentSize" : 0,
    "artifactId" : "artifactId",
    "id" : "id",
    "timestamp" : 1,
    "systemApiVersion" : "systemApiVersion"
  },
  "bundle" : {
    "versionCount" : 0,
    "identifier" : "identifier",
    "bucketName" : "bucketName",
    "createdTimestamp" : 1,
    "groupId" : "groupId",
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "description" : "description",
    "bucketIdentifier" : "bucketIdentifier",
    "bundleType" : "NIFI_NAR",
    "type" : "Flow",
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "name" : "name",
    "modifiedTimestamp" : 1,
    "artifactId" : "artifactId"
  },
  "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

successful operation 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 (globalGetBundleVersionContent)

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

array[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

successful operation

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 (globalGetBundleVersionExtension)

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
[ {
  "dynamicProperties" : [ {
    "name" : "name",
    "expressionLanguageScope" : "NONE",
    "description" : "description",
    "expressionLanguageSupported" : true,
    "value" : "value"
  }, {
    "name" : "name",
    "expressionLanguageScope" : "NONE",
    "description" : "description",
    "expressionLanguageSupported" : true,
    "value" : "value"
  } ],
  "defaultSchedule" : {
    "period" : "period",
    "strategy" : "strategy",
    "concurrentTasks" : "concurrentTasks"
  },
  "writesAttributes" : [ null, null ],
  "providedServiceAPIs" : [ {
    "groupId" : "groupId",
    "className" : "className",
    "artifactId" : "artifactId",
    "version" : "version"
  }, {
    "groupId" : "groupId",
    "className" : "className",
    "artifactId" : "artifactId",
    "version" : "version"
  } ],
  "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,
  "tags" : [ "tags", "tags" ],
  "readsAttributes" : [ {
    "name" : "name",
    "description" : "description"
  }, {
    "name" : "name",
    "description" : "description"
  } ],
  "triggerWhenEmpty" : true,
  "eventDriven" : true,
  "restricted" : {
    "restrictions" : [ {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    }, {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    } ],
    "generalRestrictionExplanation" : "generalRestrictionExplanation"
  },
  "name" : "name",
  "properties" : [ {
    "resourceDefinition" : {
      "resourceTypes" : [ "FILE", "FILE" ],
      "cardinality" : "SINGLE"
    },
    "controllerServiceDefinition" : {
      "groupId" : "groupId",
      "className" : "className",
      "artifactId" : "artifactId",
      "version" : "version"
    },
    "displayName" : "displayName",
    "defaultValue" : "defaultValue",
    "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"
    } ],
    "allowableValues" : [ {
      "displayName" : "displayName",
      "description" : "description",
      "value" : "value"
    }, {
      "displayName" : "displayName",
      "description" : "description",
      "value" : "value"
    } ],
    "name" : "name",
    "dynamic" : true,
    "expressionLanguageSupported" : true
  }, {
    "resourceDefinition" : {
      "resourceTypes" : [ "FILE", "FILE" ],
      "cardinality" : "SINGLE"
    },
    "controllerServiceDefinition" : {
      "groupId" : "groupId",
      "className" : "className",
      "artifactId" : "artifactId",
      "version" : "version"
    },
    "displayName" : "displayName",
    "defaultValue" : "defaultValue",
    "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"
    } ],
    "allowableValues" : [ {
      "displayName" : "displayName",
      "description" : "description",
      "value" : "value"
    }, {
      "displayName" : "displayName",
      "description" : "description",
      "value" : "value"
    } ],
    "name" : "name",
    "dynamic" : true,
    "expressionLanguageSupported" : true
  } ]
}, {
  "dynamicProperties" : [ {
    "name" : "name",
    "expressionLanguageScope" : "NONE",
    "description" : "description",
    "expressionLanguageSupported" : true,
    "value" : "value"
  }, {
    "name" : "name",
    "expressionLanguageScope" : "NONE",
    "description" : "description",
    "expressionLanguageSupported" : true,
    "value" : "value"
  } ],
  "defaultSchedule" : {
    "period" : "period",
    "strategy" : "strategy",
    "concurrentTasks" : "concurrentTasks"
  },
  "writesAttributes" : [ null, null ],
  "providedServiceAPIs" : [ {
    "groupId" : "groupId",
    "className" : "className",
    "artifactId" : "artifactId",
    "version" : "version"
  }, {
    "groupId" : "groupId",
    "className" : "className",
    "artifactId" : "artifactId",
    "version" : "version"
  } ],
  "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,
  "tags" : [ "tags", "tags" ],
  "readsAttributes" : [ {
    "name" : "name",
    "description" : "description"
  }, {
    "name" : "name",
    "description" : "description"
  } ],
  "triggerWhenEmpty" : true,
  "eventDriven" : true,
  "restricted" : {
    "restrictions" : [ {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    }, {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    } ],
    "generalRestrictionExplanation" : "generalRestrictionExplanation"
  },
  "name" : "name",
  "properties" : [ {
    "resourceDefinition" : {
      "resourceTypes" : [ "FILE", "FILE" ],
      "cardinality" : "SINGLE"
    },
    "controllerServiceDefinition" : {
      "groupId" : "groupId",
      "className" : "className",
      "artifactId" : "artifactId",
      "version" : "version"
    },
    "displayName" : "displayName",
    "defaultValue" : "defaultValue",
    "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"
    } ],
    "allowableValues" : [ {
      "displayName" : "displayName",
      "description" : "description",
      "value" : "value"
    }, {
      "displayName" : "displayName",
      "description" : "description",
      "value" : "value"
    } ],
    "name" : "name",
    "dynamic" : true,
    "expressionLanguageSupported" : true
  }, {
    "resourceDefinition" : {
      "resourceTypes" : [ "FILE", "FILE" ],
      "cardinality" : "SINGLE"
    },
    "controllerServiceDefinition" : {
      "groupId" : "groupId",
      "className" : "className",
      "artifactId" : "artifactId",
      "version" : "version"
    },
    "displayName" : "displayName",
    "defaultValue" : "defaultValue",
    "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"
    } ],
    "allowableValues" : [ {
      "displayName" : "displayName",
      "description" : "description",
      "value" : "value"
    }, {
      "displayName" : "displayName",
      "description" : "description",
      "value" : "value"
    } ],
    "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

successful operation

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 (globalGetBundleVersionExtensions)

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",
    "bucketId" : "bucketId",
    "artifactId" : "artifactId",
    "bundleType" : "NIFI_NAR",
    "version" : "version",
    "systemApiVersion" : "systemApiVersion"
  },
  "hasAdditionalDetails" : true,
  "displayName" : "displayName",
  "deprecationNotice" : {
    "reason" : "reason",
    "alternatives" : [ "alternatives", "alternatives" ]
  },
  "restricted" : {
    "restrictions" : [ {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    }, {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    } ],
    "generalRestrictionExplanation" : "generalRestrictionExplanation"
  },
  "providedServiceAPIs" : [ {
    "groupId" : "groupId",
    "className" : "className",
    "artifactId" : "artifactId",
    "version" : "version"
  }, {
    "groupId" : "groupId",
    "className" : "className",
    "artifactId" : "artifactId",
    "version" : "version"
  } ],
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "name" : "name",
  "description" : "description",
  "type" : "PROCESSOR",
  "tags" : [ "tags", "tags" ]
}, {
  "bundleInfo" : {
    "bucketName" : "bucketName",
    "groupId" : "groupId",
    "bundleId" : "bundleId",
    "bucketId" : "bucketId",
    "artifactId" : "artifactId",
    "bundleType" : "NIFI_NAR",
    "version" : "version",
    "systemApiVersion" : "systemApiVersion"
  },
  "hasAdditionalDetails" : true,
  "displayName" : "displayName",
  "deprecationNotice" : {
    "reason" : "reason",
    "alternatives" : [ "alternatives", "alternatives" ]
  },
  "restricted" : {
    "restrictions" : [ {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    }, {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    } ],
    "generalRestrictionExplanation" : "generalRestrictionExplanation"
  },
  "providedServiceAPIs" : [ {
    "groupId" : "groupId",
    "className" : "className",
    "artifactId" : "artifactId",
    "version" : "version"
  }, {
    "groupId" : "groupId",
    "className" : "className",
    "artifactId" : "artifactId",
    "version" : "version"
  } ],
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "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

successful operation

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 (globalGetBundleVersions)

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",
    "buildTag" : "buildTag",
    "buildRevision" : "buildRevision",
    "built" : 1,
    "buildTool" : "buildTool",
    "buildFlags" : "buildFlags"
  },
  "author" : "author",
  "groupId" : "groupId",
  "bundleId" : "bundleId",
  "description" : "description",
  "bucketId" : "bucketId",
  "version" : "version",
  "sha256Supplied" : true,
  "contentSize" : 0,
  "artifactId" : "artifactId",
  "id" : "id",
  "timestamp" : 1,
  "systemApiVersion" : "systemApiVersion"
}, {
  "sha256" : "sha256",
  "buildInfo" : {
    "buildBranch" : "buildBranch",
    "builtBy" : "builtBy",
    "buildTag" : "buildTag",
    "buildRevision" : "buildRevision",
    "built" : 1,
    "buildTool" : "buildTool",
    "buildFlags" : "buildFlags"
  },
  "author" : "author",
  "groupId" : "groupId",
  "bundleId" : "bundleId",
  "description" : "description",
  "bucketId" : "bucketId",
  "version" : "version",
  "sha256Supplied" : true,
  "contentSize" : 0,
  "artifactId" : "artifactId",
  "id" : "id",
  "timestamp" : 1,
  "systemApiVersion" : "systemApiVersion"
} ]

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

successful operation

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 (globalGetExtensionBundle)

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

ExtensionBundle

Example data

Content-Type: application/json
{
  "versionCount" : 0,
  "identifier" : "identifier",
  "bucketName" : "bucketName",
  "createdTimestamp" : 1,
  "groupId" : "groupId",
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "description" : "description",
  "bucketIdentifier" : "bucketIdentifier",
  "bundleType" : "NIFI_NAR",
  "type" : "Flow",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "name" : "name",
  "modifiedTimestamp" : 1,
  "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

successful operation ExtensionBundle

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.

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

successful operation 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" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "artifactId" : "artifactId"
}, {
  "bucketName" : "bucketName",
  "groupId" : "groupId",
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "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

successful operation

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" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  }
}, {
  "bucketName" : "bucketName",
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  }
} ]

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

successful operation

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" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  }
}, {
  "bucketName" : "bucketName",
  "groupId" : "groupId",
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  }
} ]

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

successful operation

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
{
  "extensionsLink" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  }
}

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

successful operation 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

array[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

successful operation

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
{
  "dynamicProperties" : [ {
    "name" : "name",
    "expressionLanguageScope" : "NONE",
    "description" : "description",
    "expressionLanguageSupported" : true,
    "value" : "value"
  }, {
    "name" : "name",
    "expressionLanguageScope" : "NONE",
    "description" : "description",
    "expressionLanguageSupported" : true,
    "value" : "value"
  } ],
  "defaultSchedule" : {
    "period" : "period",
    "strategy" : "strategy",
    "concurrentTasks" : "concurrentTasks"
  },
  "writesAttributes" : [ null, null ],
  "providedServiceAPIs" : [ {
    "groupId" : "groupId",
    "className" : "className",
    "artifactId" : "artifactId",
    "version" : "version"
  }, {
    "groupId" : "groupId",
    "className" : "className",
    "artifactId" : "artifactId",
    "version" : "version"
  } ],
  "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,
  "tags" : [ "tags", "tags" ],
  "readsAttributes" : [ {
    "name" : "name",
    "description" : "description"
  }, {
    "name" : "name",
    "description" : "description"
  } ],
  "triggerWhenEmpty" : true,
  "eventDriven" : true,
  "restricted" : {
    "restrictions" : [ {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    }, {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    } ],
    "generalRestrictionExplanation" : "generalRestrictionExplanation"
  },
  "name" : "name",
  "properties" : [ {
    "resourceDefinition" : {
      "resourceTypes" : [ "FILE", "FILE" ],
      "cardinality" : "SINGLE"
    },
    "controllerServiceDefinition" : {
      "groupId" : "groupId",
      "className" : "className",
      "artifactId" : "artifactId",
      "version" : "version"
    },
    "displayName" : "displayName",
    "defaultValue" : "defaultValue",
    "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"
    } ],
    "allowableValues" : [ {
      "displayName" : "displayName",
      "description" : "description",
      "value" : "value"
    }, {
      "displayName" : "displayName",
      "description" : "description",
      "value" : "value"
    } ],
    "name" : "name",
    "dynamic" : true,
    "expressionLanguageSupported" : true
  }, {
    "resourceDefinition" : {
      "resourceTypes" : [ "FILE", "FILE" ],
      "cardinality" : "SINGLE"
    },
    "controllerServiceDefinition" : {
      "groupId" : "groupId",
      "className" : "className",
      "artifactId" : "artifactId",
      "version" : "version"
    },
    "displayName" : "displayName",
    "defaultValue" : "defaultValue",
    "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"
    } ],
    "allowableValues" : [ {
      "displayName" : "displayName",
      "description" : "description",
      "value" : "value"
    }, {
      "displayName" : "displayName",
      "description" : "description",
      "value" : "value"
    } ],
    "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

successful operation 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

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

successful operation 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.

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

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

successful operation 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.

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",
    "bucketId" : "bucketId",
    "artifactId" : "artifactId",
    "bundleType" : "NIFI_NAR",
    "version" : "version",
    "systemApiVersion" : "systemApiVersion"
  },
  "hasAdditionalDetails" : true,
  "displayName" : "displayName",
  "deprecationNotice" : {
    "reason" : "reason",
    "alternatives" : [ "alternatives", "alternatives" ]
  },
  "restricted" : {
    "restrictions" : [ {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    }, {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    } ],
    "generalRestrictionExplanation" : "generalRestrictionExplanation"
  },
  "providedServiceAPIs" : [ {
    "groupId" : "groupId",
    "className" : "className",
    "artifactId" : "artifactId",
    "version" : "version"
  }, {
    "groupId" : "groupId",
    "className" : "className",
    "artifactId" : "artifactId",
    "version" : "version"
  } ],
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "name" : "name",
  "description" : "description",
  "type" : "PROCESSOR",
  "tags" : [ "tags", "tags" ]
}, {
  "bundleInfo" : {
    "bucketName" : "bucketName",
    "groupId" : "groupId",
    "bundleId" : "bundleId",
    "bucketId" : "bucketId",
    "artifactId" : "artifactId",
    "bundleType" : "NIFI_NAR",
    "version" : "version",
    "systemApiVersion" : "systemApiVersion"
  },
  "hasAdditionalDetails" : true,
  "displayName" : "displayName",
  "deprecationNotice" : {
    "reason" : "reason",
    "alternatives" : [ "alternatives", "alternatives" ]
  },
  "restricted" : {
    "restrictions" : [ {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    }, {
      "requiredPermission" : "requiredPermission",
      "explanation" : "explanation"
    } ],
    "generalRestrictionExplanation" : "generalRestrictionExplanation"
  },
  "providedServiceAPIs" : [ {
    "groupId" : "groupId",
    "className" : "className",
    "artifactId" : "artifactId",
    "version" : "version"
  }, {
    "groupId" : "groupId",
    "className" : "className",
    "artifactId" : "artifactId",
    "version" : "version"
  } ],
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "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

successful operation

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

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

successful operation 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.

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" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "artifactId" : "artifactId",
  "version" : "version",
  "timestamp" : 0
}, {
  "bucketName" : "bucketName",
  "author" : "author",
  "groupId" : "groupId",
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "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

successful operation

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

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

successful operation 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.

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",
      "bucketId" : "bucketId",
      "artifactId" : "artifactId",
      "bundleType" : "NIFI_NAR",
      "version" : "version",
      "systemApiVersion" : "systemApiVersion"
    },
    "hasAdditionalDetails" : true,
    "displayName" : "displayName",
    "deprecationNotice" : {
      "reason" : "reason",
      "alternatives" : [ "alternatives", "alternatives" ]
    },
    "restricted" : {
      "restrictions" : [ {
        "requiredPermission" : "requiredPermission",
        "explanation" : "explanation"
      }, {
        "requiredPermission" : "requiredPermission",
        "explanation" : "explanation"
      } ],
      "generalRestrictionExplanation" : "generalRestrictionExplanation"
    },
    "providedServiceAPIs" : [ {
      "groupId" : "groupId",
      "className" : "className",
      "artifactId" : "artifactId",
      "version" : "version"
    }, {
      "groupId" : "groupId",
      "className" : "className",
      "artifactId" : "artifactId",
      "version" : "version"
    } ],
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "name" : "name",
    "description" : "description",
    "type" : "PROCESSOR",
    "tags" : [ "tags", "tags" ]
  }, {
    "bundleInfo" : {
      "bucketName" : "bucketName",
      "groupId" : "groupId",
      "bundleId" : "bundleId",
      "bucketId" : "bucketId",
      "artifactId" : "artifactId",
      "bundleType" : "NIFI_NAR",
      "version" : "version",
      "systemApiVersion" : "systemApiVersion"
    },
    "hasAdditionalDetails" : true,
    "displayName" : "displayName",
    "deprecationNotice" : {
      "reason" : "reason",
      "alternatives" : [ "alternatives", "alternatives" ]
    },
    "restricted" : {
      "restrictions" : [ {
        "requiredPermission" : "requiredPermission",
        "explanation" : "explanation"
      }, {
        "requiredPermission" : "requiredPermission",
        "explanation" : "explanation"
      } ],
      "generalRestrictionExplanation" : "generalRestrictionExplanation"
    },
    "providedServiceAPIs" : [ {
      "groupId" : "groupId",
      "className" : "className",
      "artifactId" : "artifactId",
      "version" : "version"
    }, {
      "groupId" : "groupId",
      "className" : "className",
      "artifactId" : "artifactId",
      "version" : "version"
    } ],
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "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

successful operation 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",
      "bucketId" : "bucketId",
      "artifactId" : "artifactId",
      "bundleType" : "NIFI_NAR",
      "version" : "version",
      "systemApiVersion" : "systemApiVersion"
    },
    "hasAdditionalDetails" : true,
    "displayName" : "displayName",
    "deprecationNotice" : {
      "reason" : "reason",
      "alternatives" : [ "alternatives", "alternatives" ]
    },
    "restricted" : {
      "restrictions" : [ {
        "requiredPermission" : "requiredPermission",
        "explanation" : "explanation"
      }, {
        "requiredPermission" : "requiredPermission",
        "explanation" : "explanation"
      } ],
      "generalRestrictionExplanation" : "generalRestrictionExplanation"
    },
    "providedServiceAPIs" : [ {
      "groupId" : "groupId",
      "className" : "className",
      "artifactId" : "artifactId",
      "version" : "version"
    }, {
      "groupId" : "groupId",
      "className" : "className",
      "artifactId" : "artifactId",
      "version" : "version"
    } ],
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "name" : "name",
    "description" : "description",
    "type" : "PROCESSOR",
    "tags" : [ "tags", "tags" ]
  }, {
    "bundleInfo" : {
      "bucketName" : "bucketName",
      "groupId" : "groupId",
      "bundleId" : "bundleId",
      "bucketId" : "bucketId",
      "artifactId" : "artifactId",
      "bundleType" : "NIFI_NAR",
      "version" : "version",
      "systemApiVersion" : "systemApiVersion"
    },
    "hasAdditionalDetails" : true,
    "displayName" : "displayName",
    "deprecationNotice" : {
      "reason" : "reason",
      "alternatives" : [ "alternatives", "alternatives" ]
    },
    "restricted" : {
      "restrictions" : [ {
        "requiredPermission" : "requiredPermission",
        "explanation" : "explanation"
      }, {
        "requiredPermission" : "requiredPermission",
        "explanation" : "explanation"
      } ],
      "generalRestrictionExplanation" : "generalRestrictionExplanation"
    },
    "providedServiceAPIs" : [ {
      "groupId" : "groupId",
      "className" : "className",
      "artifactId" : "artifactId",
      "version" : "version"
    }, {
      "groupId" : "groupId",
      "className" : "className",
      "artifactId" : "artifactId",
      "version" : "version"
    } ],
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "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

successful operation 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

successful operation

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

200

successful operation Fields
Up 
get /flows/{flowId}
Get flow (globalGetFlow)
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,
  "identifier" : "identifier",
  "bucketName" : "bucketName",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "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

successful operation 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 (globalGetFlowVersion)
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,
      "canWrite" : true,
      "canDelete" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "name" : "name",
    "description" : "description",
    "allowPublicRead" : true,
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "snapshotMetadata" : {
    "flowIdentifier" : "flowIdentifier",
    "comments" : "comments",
    "author" : "author",
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "bucketIdentifier" : "bucketIdentifier",
    "version" : 0,
    "timestamp" : 1
  },
  "externalControllerServices" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name"
    }
  },
  "flowContents" : {
    "processors" : [ {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 2,
      "type" : "type",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "sensitive" : true
        }
      },
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 9,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "PENALIZE_FLOWFILE",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "schedulingPeriod" : "schedulingPeriod",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    }, {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 2,
      "type" : "type",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "sensitive" : true
        }
      },
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 9,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "PENALIZE_FLOWFILE",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "schedulingPeriod" : "schedulingPeriod",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    } ],
    "processGroups" : [ null, null ],
    "outputPorts" : [ null, null ],
    "funnels" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    } ],
    "versionedFlowCoordinates" : {
      "registryUrl" : "registryUrl",
      "registryId" : "registryId",
      "storageLocation" : "storageLocation",
      "bucketId" : "bucketId",
      "flowId" : "flowId",
      "version" : 6,
      "latest" : true
    },
    "connections" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "DO_NOT_COMPRESS",
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "DO_NOT_LOAD_BALANCE",
      "source" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "labelIndex" : 2,
      "bends" : [ null, null ],
      "backPressureObjectThreshold" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 4
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "DO_NOT_COMPRESS",
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "DO_NOT_LOAD_BALANCE",
      "source" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "labelIndex" : 2,
      "bends" : [ null, null ],
      "backPressureObjectThreshold" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 4
    } ],
    "logFileSuffix" : "logFileSuffix",
    "parameterContextName" : "parameterContextName",
    "identifier" : "identifier",
    "componentType" : "CONNECTION",
    "variables" : {
      "key" : "variables"
    },
    "defaultBackPressureObjectThreshold" : 7,
    "comments" : "comments",
    "labels" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "width" : 1.0246457001441578,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "zIndex" : 1,
      "height" : 1.4894159098541704
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "width" : 1.0246457001441578,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "zIndex" : 1,
      "height" : 1.4894159098541704
    } ],
    "defaultBackPressureDataSizeThreshold" : "defaultBackPressureDataSizeThreshold",
    "controllerServices" : [ {
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "type" : "type",
      "propertyDescriptors" : { },
      "scheduledState" : "ENABLED",
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    }, {
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "type" : "type",
      "propertyDescriptors" : { },
      "scheduledState" : "ENABLED",
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    } ],
    "defaultFlowFileExpiration" : "defaultFlowFileExpiration",
    "flowFileConcurrency" : "flowFileConcurrency",
    "flowFileOutboundPolicy" : "flowFileOutboundPolicy",
    "name" : "name",
    "inputPorts" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 3,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "type" : "INPUT_PORT",
      "groupIdentifier" : "groupIdentifier",
      "scheduledState" : "ENABLED"
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 3,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "type" : "INPUT_PORT",
      "groupIdentifier" : "groupIdentifier",
      "scheduledState" : "ENABLED"
    } ],
    "instanceIdentifier" : "instanceIdentifier",
    "position" : {
      "x" : 0.8008281904610115,
      "y" : 6.027456183070403
    },
    "remoteProcessGroups" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 1,
      "transportProtocol" : "RAW",
      "outputPorts" : [ null, null ],
      "name" : "name",
      "targetUri" : "targetUri",
      "proxyUser" : "proxyUser",
      "targetUris" : "targetUris",
      "inputPorts" : [ {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 1,
      "transportProtocol" : "RAW",
      "outputPorts" : [ null, null ],
      "name" : "name",
      "targetUri" : "targetUri",
      "proxyUser" : "proxyUser",
      "targetUris" : "targetUris",
      "inputPorts" : [ {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    } ],
    "groupIdentifier" : "groupIdentifier"
  },
  "parameterProviders" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name",
      "type" : "type"
    }
  },
  "flowEncodingVersion" : "flowEncodingVersion",
  "flow" : {
    "versionCount" : 0,
    "identifier" : "identifier",
    "bucketName" : "bucketName",
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "name" : "name",
    "description" : "description",
    "modifiedTimestamp" : 1,
    "bucketIdentifier" : "bucketIdentifier",
    "type" : "Flow",
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "parameterContexts" : {
    "key" : {
      "parameterGroupName" : "parameterGroupName",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "synchronized" : true,
      "comments" : "comments",
      "description" : "description",
      "inheritedParameterContexts" : [ "inheritedParameterContexts", "inheritedParameterContexts" ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "parameters" : [ {
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      }, {
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      } ],
      "parameterProvider" : "parameterProvider"
    }
  },
  "latest" : 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

successful operation 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 (globalGetFlowVersions)
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" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "bucketIdentifier" : "bucketIdentifier",
  "version" : 0,
  "timestamp" : 1
}, {
  "flowIdentifier" : "flowIdentifier",
  "comments" : "comments",
  "author" : "author",
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "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

successful operation

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 (globalGetLatestFlowVersion)
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,
      "canWrite" : true,
      "canDelete" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "name" : "name",
    "description" : "description",
    "allowPublicRead" : true,
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "snapshotMetadata" : {
    "flowIdentifier" : "flowIdentifier",
    "comments" : "comments",
    "author" : "author",
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "bucketIdentifier" : "bucketIdentifier",
    "version" : 0,
    "timestamp" : 1
  },
  "externalControllerServices" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name"
    }
  },
  "flowContents" : {
    "processors" : [ {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 2,
      "type" : "type",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "sensitive" : true
        }
      },
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 9,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "PENALIZE_FLOWFILE",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "schedulingPeriod" : "schedulingPeriod",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    }, {
      "autoTerminatedRelationships" : [ "autoTerminatedRelationships", "autoTerminatedRelationships" ],
      "bulletinLevel" : "bulletinLevel",
      "executionNode" : "executionNode",
      "runDurationMillis" : 2,
      "type" : "type",
      "propertyDescriptors" : {
        "key" : {
          "resourceDefinition" : {
            "resourceTypes" : [ "FILE", "FILE" ],
            "cardinality" : "SINGLE"
          },
          "displayName" : "displayName",
          "identifiesControllerService" : true,
          "name" : "name",
          "sensitive" : true
        }
      },
      "scheduledState" : "ENABLED",
      "maxBackoffPeriod" : "maxBackoffPeriod",
      "yieldDuration" : "yieldDuration",
      "bundle" : {
        "artifact" : "artifact",
        "version" : "version",
        "group" : "group"
      },
      "retriedRelationships" : [ "retriedRelationships", "retriedRelationships" ],
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "concurrentlySchedulableTaskCount" : 7,
      "retryCount" : 9,
      "penaltyDuration" : "penaltyDuration",
      "backoffMechanism" : "PENALIZE_FLOWFILE",
      "schedulingStrategy" : "schedulingStrategy",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "schedulingPeriod" : "schedulingPeriod",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    } ],
    "processGroups" : [ null, null ],
    "outputPorts" : [ null, null ],
    "funnels" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier"
    } ],
    "versionedFlowCoordinates" : {
      "registryUrl" : "registryUrl",
      "registryId" : "registryId",
      "storageLocation" : "storageLocation",
      "bucketId" : "bucketId",
      "flowId" : "flowId",
      "version" : 6,
      "latest" : true
    },
    "connections" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "DO_NOT_COMPRESS",
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "DO_NOT_LOAD_BALANCE",
      "source" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "labelIndex" : 2,
      "bends" : [ null, null ],
      "backPressureObjectThreshold" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 4
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "prioritizers" : [ "prioritizers", "prioritizers" ],
      "comments" : "comments",
      "flowFileExpiration" : "flowFileExpiration",
      "selectedRelationships" : [ "selectedRelationships", "selectedRelationships" ],
      "loadBalanceCompression" : "DO_NOT_COMPRESS",
      "backPressureDataSizeThreshold" : "backPressureDataSizeThreshold",
      "loadBalanceStrategy" : "DO_NOT_LOAD_BALANCE",
      "source" : {
        "comments" : "comments",
        "groupId" : "groupId",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "id" : "id",
        "type" : "PROCESSOR"
      },
      "labelIndex" : 2,
      "bends" : [ null, null ],
      "backPressureObjectThreshold" : 7,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "partitioningAttribute" : "partitioningAttribute",
      "zIndex" : 4
    } ],
    "logFileSuffix" : "logFileSuffix",
    "parameterContextName" : "parameterContextName",
    "identifier" : "identifier",
    "componentType" : "CONNECTION",
    "variables" : {
      "key" : "variables"
    },
    "defaultBackPressureObjectThreshold" : 7,
    "comments" : "comments",
    "labels" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "width" : 1.0246457001441578,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "zIndex" : 1,
      "height" : 1.4894159098541704
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "name" : "name",
      "width" : 1.0246457001441578,
      "instanceIdentifier" : "instanceIdentifier",
      "style" : {
        "key" : "style"
      },
      "label" : "label",
      "groupIdentifier" : "groupIdentifier",
      "zIndex" : 1,
      "height" : 1.4894159098541704
    } ],
    "defaultBackPressureDataSizeThreshold" : "defaultBackPressureDataSizeThreshold",
    "controllerServices" : [ {
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "type" : "type",
      "propertyDescriptors" : { },
      "scheduledState" : "ENABLED",
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    }, {
      "annotationData" : "annotationData",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "bulletinLevel" : "bulletinLevel",
      "type" : "type",
      "propertyDescriptors" : { },
      "scheduledState" : "ENABLED",
      "controllerServiceApis" : [ {
        "type" : "type"
      }, {
        "type" : "type"
      } ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "properties" : {
        "key" : "properties"
      }
    } ],
    "defaultFlowFileExpiration" : "defaultFlowFileExpiration",
    "flowFileConcurrency" : "flowFileConcurrency",
    "flowFileOutboundPolicy" : "flowFileOutboundPolicy",
    "name" : "name",
    "inputPorts" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 3,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "type" : "INPUT_PORT",
      "groupIdentifier" : "groupIdentifier",
      "scheduledState" : "ENABLED"
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "allowRemoteAccess" : true,
      "concurrentlySchedulableTaskCount" : 3,
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "type" : "INPUT_PORT",
      "groupIdentifier" : "groupIdentifier",
      "scheduledState" : "ENABLED"
    } ],
    "instanceIdentifier" : "instanceIdentifier",
    "position" : {
      "x" : 0.8008281904610115,
      "y" : 6.027456183070403
    },
    "remoteProcessGroups" : [ {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 1,
      "transportProtocol" : "RAW",
      "outputPorts" : [ null, null ],
      "name" : "name",
      "targetUri" : "targetUri",
      "proxyUser" : "proxyUser",
      "targetUris" : "targetUris",
      "inputPorts" : [ {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    }, {
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "comments" : "comments",
      "proxyPassword" : "proxyPassword",
      "communicationsTimeout" : "communicationsTimeout",
      "proxyHost" : "proxyHost",
      "proxyPort" : 1,
      "transportProtocol" : "RAW",
      "outputPorts" : [ null, null ],
      "name" : "name",
      "targetUri" : "targetUri",
      "proxyUser" : "proxyUser",
      "targetUris" : "targetUris",
      "inputPorts" : [ {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      }, {
        "identifier" : "identifier",
        "componentType" : "CONNECTION",
        "remoteGroupId" : "remoteGroupId",
        "comments" : "comments",
        "targetId" : "targetId",
        "concurrentlySchedulableTaskCount" : 5,
        "useCompression" : true,
        "scheduledState" : "ENABLED",
        "name" : "name",
        "instanceIdentifier" : "instanceIdentifier",
        "batchSize" : {
          "duration" : "duration",
          "size" : "size",
          "count" : 5
        },
        "groupIdentifier" : "groupIdentifier"
      } ],
      "instanceIdentifier" : "instanceIdentifier",
      "yieldDuration" : "yieldDuration",
      "groupIdentifier" : "groupIdentifier",
      "localNetworkInterface" : "localNetworkInterface"
    } ],
    "groupIdentifier" : "groupIdentifier"
  },
  "parameterProviders" : {
    "key" : {
      "identifier" : "identifier",
      "name" : "name",
      "type" : "type"
    }
  },
  "flowEncodingVersion" : "flowEncodingVersion",
  "flow" : {
    "versionCount" : 0,
    "identifier" : "identifier",
    "bucketName" : "bucketName",
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "createdTimestamp" : 1,
    "link" : {
      "href" : "http://example.com/aeiou",
      "params" : {
        "key" : "params"
      }
    },
    "name" : "name",
    "description" : "description",
    "modifiedTimestamp" : 1,
    "bucketIdentifier" : "bucketIdentifier",
    "type" : "Flow",
    "revision" : {
      "clientId" : "clientId",
      "lastModifier" : "lastModifier",
      "version" : 6
    }
  },
  "parameterContexts" : {
    "key" : {
      "parameterGroupName" : "parameterGroupName",
      "identifier" : "identifier",
      "componentType" : "CONNECTION",
      "synchronized" : true,
      "comments" : "comments",
      "description" : "description",
      "inheritedParameterContexts" : [ "inheritedParameterContexts", "inheritedParameterContexts" ],
      "name" : "name",
      "instanceIdentifier" : "instanceIdentifier",
      "groupIdentifier" : "groupIdentifier",
      "parameters" : [ {
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      }, {
        "provided" : true,
        "name" : "name",
        "description" : "description",
        "sensitive" : true,
        "value" : "value"
      } ],
      "parameterProvider" : "parameterProvider"
    }
  },
  "latest" : 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

successful operation 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 (globalGetLatestFlowVersionMetadata)
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" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "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

successful operation 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

200

successful operation 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
[ {
  "identifier" : "identifier",
  "bucketName" : "bucketName",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "name" : "name",
  "description" : "description",
  "modifiedTimestamp" : 1,
  "bucketIdentifier" : "bucketIdentifier",
  "type" : "Flow"
}, {
  "identifier" : "identifier",
  "bucketName" : "bucketName",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "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

successful operation

401

Client could not be authenticated.
Up 
get /items/{bucketId}
Get bucket items (getItemsInBucket)
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
[ {
  "identifier" : "identifier",
  "bucketName" : "bucketName",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "name" : "name",
  "description" : "description",
  "modifiedTimestamp" : 1,
  "bucketIdentifier" : "bucketIdentifier",
  "type" : "Flow"
}, {
  "identifier" : "identifier",
  "bucketName" : "bucketName",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "createdTimestamp" : 1,
  "link" : {
    "href" : "http://example.com/aeiou",
    "params" : {
      "key" : "params"
    }
  },
  "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

successful operation

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" : [ null, null ],
  "resource" : "resource",
  "action" : "read",
  "configurable" : true,
  "users" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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

successful operation 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.

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 
get /policies
Get all access policies (getAccessPolicies)

Return type

array[AccessPolicy]

Example data

Content-Type: application/json
[ {
  "identifier" : "identifier",
  "userGroups" : [ null, null ],
  "resource" : "resource",
  "action" : "read",
  "configurable" : true,
  "users" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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" : [ null, null ],
  "resource" : "resource",
  "action" : "read",
  "configurable" : true,
  "users" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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

successful operation

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" : [ null, null ],
  "resource" : "resource",
  "action" : "read",
  "configurable" : true,
  "users" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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

successful operation 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" : [ null, null ],
  "resource" : "resource",
  "action" : "read",
  "configurable" : true,
  "users" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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

successful operation 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

successful operation

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" : [ null, null ],
  "resource" : "resource",
  "action" : "read",
  "configurable" : true,
  "users" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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

successful operation 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" : [ null, null ],
  "resource" : "resource",
  "action" : "read",
  "configurable" : true,
  "users" : [ {
    "identifier" : "identifier",
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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

successful operation 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "resourcePermissions" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : 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

successful operation 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" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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

successful operation 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "resourcePermissions" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : 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

successful operation 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" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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

successful operation 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" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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

successful operation

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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "resourcePermissions" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "resourcePermissions" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : 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

successful operation

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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "resourcePermissions" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : 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

successful operation 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" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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

successful operation 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    }, {
      "identifier" : "identifier",
      "resource" : "resource",
      "action" : "read",
      "configurable" : true
    } ],
    "identity" : "identity",
    "configurable" : true
  } ],
  "resourcePermissions" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : 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

successful operation 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" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : 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

successful operation 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. ComponentDifference
  15. ComponentDifferenceGroup
  16. ConnectableComponent
  17. ControllerServiceAPI
  18. ControllerServiceDefinition
  19. CurrentUser
  20. DefaultSchedule
  21. DefaultSettings
  22. Dependency
  23. DependentValues
  24. DeprecationNotice
  25. DynamicProperty
  26. DynamicRelationship
  27. Extension
  28. ExtensionBundle
  29. ExtensionFilterParams
  30. ExtensionMetadata
  31. ExtensionMetadataContainer
  32. ExtensionRepoArtifact
  33. ExtensionRepoBucket
  34. ExtensionRepoGroup
  35. ExtensionRepoVersion
  36. ExtensionRepoVersionSummary
  37. ExternalControllerServiceReference
  38. Fields
  39. JaxbLink
  40. ParameterProviderReference
  41. Permissions
  42. Position
  43. Property
  44. ProvidedServiceAPI
  45. RegistryAbout
  46. RegistryConfiguration
  47. Relationship
  48. Resource
  49. ResourceDefinition
  50. ResourcePermissions
  51. Restricted
  52. Restriction
  53. RevisionInfo
  54. Stateful
  55. SystemResourceConsideration
  56. TagCount
  57. Tenant
  58. User
  59. UserGroup
  60. VersionedConnection
  61. VersionedControllerService
  62. VersionedFlow
  63. VersionedFlowCoordinates
  64. VersionedFlowDifference
  65. VersionedFlowSnapshot
  66. VersionedFlowSnapshotMetadata
  67. VersionedFunnel
  68. VersionedLabel
  69. VersionedParameter
  70. VersionedParameterContext
  71. VersionedPort
  72. VersionedProcessGroup
  73. VersionedProcessor
  74. VersionedPropertyDescriptor
  75. VersionedRemoteGroupPort
  76. VersionedRemoteProcessGroup
  77. VersionedResourceDefinition

AccessPolicy Up

identifier (optional)
String The id of the policy. Set by server at creation time.
resource
String The resource for this access policy.
action
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.
revision (optional)
RevisionInfo
users (optional)
array[Tenant] The set of user IDs associated with this access policy.
userGroups (optional)
array[Tenant] The set of user group IDs associated with this access policy.

AccessPolicySummary Up

identifier (optional)
String The id of the policy. Set by server at creation time.
resource
String The resource for this access policy.
action
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.
revision (optional)
RevisionInfo

AllowableValue Up

value (optional)
String The value of the allowable value
displayName (optional)
String The display name of the allowable value
description (optional)
String The description of the allowable value

Attribute Up

name (optional)
String The name of the attribute
description (optional)
String The description of the attribute

BatchSize Up

count (optional)
Integer Preferred number of flow files to include in a transaction. format: int32
size (optional)
String Preferred number of bytes to include in a transaction.
duration (optional)
String Preferred amount of time that a transaction should span.

Bucket Up

link (optional)
JaxbLink
identifier (optional)
String An ID to uniquely identify this object.
name
String The name of the bucket.
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.
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
permissions (optional)
Permissions
revision (optional)
RevisionInfo

BucketItem Up

link (optional)
JaxbLink
identifier (optional)
String An ID to uniquely identify this object.
name
String The name of the item.
description (optional)
String A description of the item.
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
modifiedTimestamp (optional)
Long The timestamp of when the item was last modified, as milliseconds since epoch. format: int64
type
String The type of item.
Enum:
Flow
Bundle
permissions (optional)
Permissions

BuildInfo Up

buildTool (optional)
String The tool used to build the version of the bundle
buildFlags (optional)
String The flags used to build the version of the bundle
buildBranch (optional)
String The branch used to build the version of the bundle
buildTag (optional)
String The tag used to build the version of the bundle
buildRevision (optional)
String The revision 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

group (optional)
String The group of the bundle
artifact (optional)
String The artifact of the bundle
version (optional)
String The version of the bundle

BundleInfo Up

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
artifactId (optional)
String The artifact id of the bundle
version (optional)
String The version of the bundle
systemApiVersion (optional)
String The version of the system API the bundle was built against

BundleVersion Up

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

BundleVersionDependency Up

groupId (optional)
String The group id of the bundle dependency
artifactId (optional)
String The artifact id of the bundle dependency
version (optional)
String The version of the bundle dependency

BundleVersionMetadata Up

link (optional)
JaxbLink
id (optional)
String The id of this version of the extension bundle
bundleId (optional)
String The id of the extension bundle this version is for
bucketId
String The id of the bucket the extension bundle belongs to
groupId (optional)
String
artifactId (optional)
String
version (optional)
String The version of the extension bundle
timestamp (optional)
Long The timestamp of the create date of this version format: int64
author (optional)
String The identity that created this version
description (optional)
String The description for this version
sha256 (optional)
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
contentSize
Long The size of the binary content for this version in bytes format: int64
systemApiVersion (optional)
String The version of the system API that this bundle version was built against
buildInfo
BuildInfo

ComponentDifference Up

valueA (optional)
String The earlier value from the difference.
valueB (optional)
String The newer value from the difference.
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.

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.
processGroupId (optional)
String The process group id for this component.
differences (optional)
array[ComponentDifference] The list of changes related to this component between the 2 versions.

ConnectableComponent Up

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

ControllerServiceAPI Up

type (optional)
String The fully qualified name of the service interface.
bundle (optional)
Bundle

ControllerServiceDefinition Up

className (optional)
String The class name of the service API
groupId (optional)
String The group id of the service API
artifactId (optional)
String The artifact id of the service API
version (optional)
String The version of the service API

CurrentUser Up

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

DefaultSchedule Up

strategy (optional)
String The default scheduling strategy
period (optional)
String The default scheduling period
concurrentTasks (optional)
String The default concurrent tasks

DefaultSettings Up

yieldDuration (optional)
String The default yield duration
penaltyDuration (optional)
String The default penalty duration
bulletinLevel (optional)
String The default bulletin level

Dependency Up

propertyName (optional)
String The name of the dependent property
propertyDisplayName (optional)
String The display name of the dependent property
dependentValues (optional)
DependentValues

DependentValues Up

values (optional)
array[String] The dependent values

DeprecationNotice Up

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

DynamicProperty Up

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

DynamicRelationship Up

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

Extension Up

name (optional)
String The name of the extension
type (optional)
String The type of the extension
Enum:
PROCESSOR
CONTROLLER_SERVICE
REPORTING_TASK
deprecationNotice (optional)
DeprecationNotice
description (optional)
String The description of the extension
tags (optional)
array[String] The tags of the extension
properties (optional)
array[Property] The properties of the extension
supportsSensitiveDynamicProperties (optional)
Boolean
dynamicProperties (optional)
array[DynamicProperty] The dynamic properties of the extension
relationships (optional)
array[Relationship] The relationships of the extension
dynamicRelationship (optional)
DynamicRelationship
readsAttributes (optional)
array[Attribute] The attributes read from flow files by the extension
writesAttributes (optional)
array[Attribute] The attributes written to flow files by the extension
stateful (optional)
Stateful
restricted (optional)
Restricted
inputRequirement (optional)
String The input requirement of the extension
Enum:
INPUT_REQUIRED
INPUT_ALLOWED
INPUT_FORBIDDEN
systemResourceConsiderations (optional)
array[SystemResourceConsideration] The resource considerations of the extension
seeAlso (optional)
array[String] The names of other extensions to see
providedServiceAPIs (optional)
array[ProvidedServiceAPI] The service APIs provided by this extension
defaultSettings (optional)
DefaultSettings
defaultSchedule (optional)
DefaultSchedule
triggerSerially (optional)
Boolean Indicates that a processor should be triggered serially
triggerWhenEmpty (optional)
Boolean Indicates that a processor should be triggered when the incoming queues are empty
triggerWhenAnyDestinationAvailable (optional)
Boolean Indicates that a processor should be triggered when any destinations have space for flow files
supportsBatching (optional)
Boolean Indicates that a processor supports batching
eventDriven (optional)
Boolean Indicates that a processor supports event driven scheduling
primaryNodeOnly (optional)
Boolean Indicates that a processor should be scheduled only on the primary node
sideEffectFree (optional)
Boolean Indicates that a processor is side effect free

ExtensionBundle Up

link (optional)
JaxbLink
identifier (optional)
String An ID to uniquely identify this object.
name
String The name of the item.
description (optional)
String A description of the item.
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
modifiedTimestamp (optional)
Long The timestamp of when the item was last modified, as milliseconds since epoch. format: int64
type
String The type of item.
Enum:
Flow
Bundle
permissions (optional)
Permissions
bundleType
String The type of the extension bundle
Enum:
NIFI_NAR
MINIFI_CPP
groupId (optional)
String The group id of the extension bundle
artifactId (optional)
String The artifact id of the extension bundle
versionCount (optional)
Long The number of versions of this extension bundle. format: int64

ExtensionFilterParams Up

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
tags (optional)
array[String] The tags

ExtensionMetadata Up

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

ExtensionMetadataContainer Up

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

ExtensionRepoArtifact Up

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

ExtensionRepoBucket Up

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

ExtensionRepoGroup Up

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

ExtensionRepoVersion Up

extensionsLink (optional)
JaxbLink
downloadLink (optional)
JaxbLink
sha256Link (optional)
JaxbLink
sha256Supplied (optional)
JaxbLink

ExtensionRepoVersionSummary Up

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

ExternalControllerServiceReference Up

identifier (optional)
String The identifier of the controller service
name (optional)
String The name of the controller service

Fields Up

fields (optional)
array[String]

JaxbLink Up

href (optional)
String The href for the link format: uri
params (optional)
map[String, String] The params for the link

ParameterProviderReference Up

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.
bundle (optional)
Bundle

Permissions Up

canRead (optional)
Boolean Indicates whether the user can read a given resource.
canWrite (optional)
Boolean Indicates whether the user can write a given resource.
canDelete (optional)
Boolean Indicates whether the user can delete 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

Property Up

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

ProvidedServiceAPI Up

className (optional)
String The class name of the service API being provided
groupId (optional)
String The group id of the service API being provided
artifactId (optional)
String The artifact id of the service API being provided
version (optional)
String The version of the service API being provided

RegistryAbout Up

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

RegistryConfiguration Up

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

Relationship Up

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

Resource Up

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

ResourceDefinition Up

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

ResourcePermissions Up

buckets (optional)
Permissions
tenants (optional)
Permissions
policies (optional)
Permissions
proxy (optional)
Permissions
anyTopLevelResource (optional)
Permissions

Restricted Up

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

requiredPermission (optional)
String The permission required for this restriction
explanation (optional)
String The explanation of 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.
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
lastModifier (optional)
String The user that last modified the entity.

Stateful Up

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

SystemResourceConsideration Up

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

TagCount Up

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

Tenant Up

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

User Up

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

UserGroup Up

identifier (optional)
String The computer-generated identifier of the tenant.
identity
String The human-facing identity of the tenant. This can only be changed if the tenant is configurable.
configurable (optional)
Boolean Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.
resourcePermissions (optional)
ResourcePermissions
accessPolicies (optional)
array[AccessPolicySummary] The access policies granted to this tenant.
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.

VersionedConnection Up

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
comments (optional)
String The user-supplied comments for the component
position (optional)
Position
source (optional)
ConnectableComponent
destination (optional)
ConnectableComponent
labelIndex (optional)
Integer The index of the bend point where to place the connection label. format: int32
zIndex (optional)
Long The z index of the connection. format: int64
selectedRelationships (optional)
array[String] The selected relationship that comprise the connection.
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
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.
flowFileExpiration (optional)
String The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it.
prioritizers (optional)
array[String] The comparators used to prioritize the queue.
bends (optional)
array[Position] The bend points on the connection.
loadBalanceStrategy (optional)
String The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.
Enum:
DO_NOT_LOAD_BALANCE
PARTITION_BY_ATTRIBUTE
ROUND_ROBIN
SINGLE_NODE
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.
loadBalanceCompression (optional)
String Whether or not compression should be used when transferring FlowFiles between nodes
Enum:
DO_NOT_COMPRESS
COMPRESS_ATTRIBUTES_ONLY
COMPRESS_ATTRIBUTES_AND_CONTENT
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
PARAMETER_CONTEXT
PARAMETER_PROVIDER
TEMPLATE
FLOW_REGISTRY_CLIENT
groupIdentifier (optional)
String The ID of the Process Group that this component belongs to

VersionedControllerService Up

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
comments (optional)
String The user-supplied comments for the component
position (optional)
Position
type (optional)
String The type of the extension component
bundle (optional)
Bundle
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.
controllerServiceApis (optional)
array[ControllerServiceAPI] Lists the APIs this Controller Service implements.
annotationData (optional)
String The annotation for the controller service. This is how the custom UI relays configuration to the controller service.
scheduledState (optional)
String The ScheduledState denoting whether the Controller Service is ENABLED or DISABLED
Enum:
ENABLED
DISABLED
RUNNING
bulletinLevel (optional)
String The level at which the controller service will report bulletins.
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
PARAMETER_CONTEXT
PARAMETER_PROVIDER
TEMPLATE
FLOW_REGISTRY_CLIENT
groupIdentifier (optional)
String The ID of the Process Group that this component belongs to

VersionedFlow Up

link (optional)
JaxbLink
identifier (optional)
String An ID to uniquely identify this object.
name
String The name of the item.
description (optional)
String A description of the item.
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
modifiedTimestamp (optional)
Long The timestamp of when the item was last modified, as milliseconds since epoch. format: int64
type
String The type of item.
Enum:
Flow
Bundle
permissions (optional)
Permissions
versionCount (optional)
Long The number of versions of this flow. format: int64
revision (optional)
RevisionInfo

VersionedFlowCoordinates Up

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
registryUrl (optional)
String The URL of the Flow Registry that contains the flow
bucketId (optional)
String The UUID of the bucket that the flow resides in
flowId (optional)
String The UUID of the flow
version (optional)
Integer The version of the flow format: int32
latest (optional)
Boolean Whether or not these coordinates point to the latest version of the flow

VersionedFlowDifference Up

bucketId (optional)
String The id of the bucket that the flow is stored in.
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
componentDifferenceGroups (optional)
array[ComponentDifferenceGroup]

VersionedFlowSnapshot Up

snapshotMetadata
VersionedFlowSnapshotMetadata
flowContents
VersionedProcessGroup
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.
parameterProviders (optional)
map[String, ParameterProviderReference] Contains basic information about parameter providers referenced in the versioned flow.
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.
flowEncodingVersion (optional)
String The optional encoding version of the flow contents.
flow (optional)
VersionedFlow
bucket (optional)
Bucket
latest (optional)
Boolean

VersionedFlowSnapshotMetadata Up

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

VersionedFunnel Up

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
comments (optional)
String The user-supplied comments for the component
position (optional)
Position
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
PARAMETER_CONTEXT
PARAMETER_PROVIDER
TEMPLATE
FLOW_REGISTRY_CLIENT
groupIdentifier (optional)
String The ID of the Process Group that this component belongs to

VersionedLabel Up

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
comments (optional)
String The user-supplied comments for the component
position (optional)
Position
label (optional)
String The text that appears in the label.
zIndex (optional)
Long The z index of the connection. format: int64
width (optional)
Double The width of the label in pixels when at a 1:1 scale. format: double
height (optional)
Double The height of the label in pixels when at a 1:1 scale. format: double
style (optional)
map[String, String] The styles for this label (font-size : 12px, background-color : #eee, etc).
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
PARAMETER_CONTEXT
PARAMETER_PROVIDER
TEMPLATE
FLOW_REGISTRY_CLIENT
groupIdentifier (optional)
String The ID of the Process Group that this component belongs to

VersionedParameter Up

name (optional)
String The name of the parameter
description (optional)
String The description of the param
sensitive (optional)
Boolean Whether or not the parameter value is sensitive
provided (optional)
Boolean Whether or not the parameter value is provided by a ParameterProvider
value (optional)
String The value of the parameter

VersionedParameterContext Up

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
comments (optional)
String The user-supplied comments for the component
position (optional)
Position
parameters (optional)
array[VersionedParameter] The parameters in the context
inheritedParameterContexts (optional)
array[String] The names of additional parameter contexts from which to inherit parameters
description (optional)
String The description of the parameter context
parameterProvider (optional)
String The identifier of an optional parameter provider
parameterGroupName (optional)
String The corresponding parameter group name fetched from the parameter provider, if applicable
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
PARAMETER_CONTEXT
PARAMETER_PROVIDER
TEMPLATE
FLOW_REGISTRY_CLIENT
synchronized (optional)
Boolean True if the parameter provider is set and the context should receive updates when its parameters are next fetched
groupIdentifier (optional)
String The ID of the Process Group that this component belongs to

VersionedPort Up

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
comments (optional)
String The user-supplied comments for the component
position (optional)
Position
type (optional)
String The type of port.
Enum:
INPUT_PORT
OUTPUT_PORT
concurrentlySchedulableTaskCount (optional)
Integer The number of tasks that should be concurrently scheduled for the port. format: int32
scheduledState (optional)
String The scheduled state of the component
Enum:
ENABLED
DISABLED
RUNNING
allowRemoteAccess (optional)
Boolean Whether or not this port allows remote access for site-to-site
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
PARAMETER_CONTEXT
PARAMETER_PROVIDER
TEMPLATE
FLOW_REGISTRY_CLIENT
groupIdentifier (optional)
String The ID of the Process Group that this component belongs to

VersionedProcessGroup Up

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
comments (optional)
String The user-supplied comments for the component
position (optional)
Position
processGroups (optional)
array[VersionedProcessGroup] The child Process Groups
remoteProcessGroups (optional)
array[VersionedRemoteProcessGroup] The Remote Process Groups
processors (optional)
array[VersionedProcessor] The Processors
inputPorts (optional)
array[VersionedPort] The Input Ports
outputPorts (optional)
array[VersionedPort] The Output Ports
connections (optional)
array[VersionedConnection] The Connections
labels (optional)
array[VersionedLabel] The Labels
funnels (optional)
array[VersionedFunnel] The Funnels
controllerServices (optional)
array[VersionedControllerService] The Controller Services
versionedFlowCoordinates (optional)
VersionedFlowCoordinates
variables (optional)
map[String, String] The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)
parameterContextName (optional)
String The name of the parameter context used by this process group
defaultFlowFileExpiration (optional)
String The default FlowFile Expiration for this Process Group.
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
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.
logFileSuffix (optional)
String The log file suffix for this Process Group for dedicated logging.
flowFileConcurrency (optional)
String The configured FlowFile Concurrency for the Process Group
flowFileOutboundPolicy (optional)
String The FlowFile Outbound Policy for the Process Group
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
PARAMETER_CONTEXT
PARAMETER_PROVIDER
TEMPLATE
FLOW_REGISTRY_CLIENT
groupIdentifier (optional)
String The ID of the Process Group that this component belongs to

VersionedProcessor Up

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
comments (optional)
String The user-supplied comments for the component
position (optional)
Position
type (optional)
String The type of the extension component
bundle (optional)
Bundle
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.
style (optional)
map[String, String] Stylistic data for rendering in a UI
annotationData (optional)
String The annotation data for the processor used to relay configuration between a custom UI and the procesosr.
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 whether the processor should be scheduled to run in event or timer driven mode.
executionNode (optional)
String Indicates the node where the process will execute.
penaltyDuration (optional)
String The amout of time that is used when the process penalizes a flowfile.
yieldDuration (optional)
String The amount of time that must elapse before this processor is scheduled again after yielding.
bulletinLevel (optional)
String The level at which the processor will report bulletins.
runDurationMillis (optional)
Long The run duration for the processor in milliseconds. format: int64
concurrentlySchedulableTaskCount (optional)
Integer The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored. format: int32
autoTerminatedRelationships (optional)
array[String] The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.
scheduledState (optional)
String The scheduled state of the component
Enum:
ENABLED
DISABLED
RUNNING
retryCount (optional)
Integer Overall number of retries. format: int32
retriedRelationships (optional)
array[String] All the relationships should be retried.
backoffMechanism (optional)
String Determines whether the FlowFile should be penalized or the processor should be yielded between retries.
Enum:
PENALIZE_FLOWFILE
YIELD_PROCESSOR
maxBackoffPeriod (optional)
String Maximum amount of time to be waited during a retry period.
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
PARAMETER_CONTEXT
PARAMETER_PROVIDER
TEMPLATE
FLOW_REGISTRY_CLIENT
groupIdentifier (optional)
String The ID of the Process Group that this component belongs to

VersionedPropertyDescriptor Up

name (optional)
String The name of the property
displayName (optional)
String The display name of the property
identifiesControllerService (optional)
Boolean Whether or not the property provides the identifier of a Controller Service
sensitive (optional)
Boolean Whether or not the property is considered sensitive
resourceDefinition (optional)
VersionedResourceDefinition

VersionedRemoteGroupPort Up

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
comments (optional)
String The user-supplied comments for the component
position (optional)
Position
remoteGroupId (optional)
String The id of the remote process group that the port resides in.
concurrentlySchedulableTaskCount (optional)
Integer The number of task that may transmit flowfiles to the target port concurrently. format: int32
useCompression (optional)
Boolean Whether the flowfiles are compressed when sent to the target port.
batchSize (optional)
BatchSize
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
PARAMETER_CONTEXT
PARAMETER_PROVIDER
TEMPLATE
FLOW_REGISTRY_CLIENT
targetId (optional)
String The ID of the port on the target NiFi instance
scheduledState (optional)
String The scheduled state of the component
Enum:
ENABLED
DISABLED
RUNNING
groupIdentifier (optional)
String The ID of the Process Group that this component belongs to

VersionedRemoteProcessGroup Up

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
comments (optional)
String The user-supplied comments for the component
position (optional)
Position
targetUri (optional)
String [DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null.
targetUris (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.
communicationsTimeout (optional)
String The time period used for the timeout when communicating with the target.
yieldDuration (optional)
String When yielding, this amount of time must elapse before the remote process group is scheduled again.
transportProtocol (optional)
String The Transport Protocol that is used for Site-to-Site communications
Enum:
RAW
HTTP
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.
proxyHost (optional)
String
proxyPort (optional)
Integer format: int32
proxyUser (optional)
String
proxyPassword (optional)
String
inputPorts (optional)
array[VersionedRemoteGroupPort] A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance
outputPorts (optional)
array[VersionedRemoteGroupPort] A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance
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
PARAMETER_CONTEXT
PARAMETER_PROVIDER
TEMPLATE
FLOW_REGISTRY_CLIENT
groupIdentifier (optional)
String The ID of the Process Group that this component belongs to

VersionedResourceDefinition Up

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: