1. Overview

The REST API provides an interface to a registry with operations for saving, versioning, reading NiFi flows and components.

1.1. Version information

Version : 0.8.0

1.2. Contact information

Contact : Apache NiFi Registry
Contact Email : dev@nifi.apache.org

1.3. License information

License : Apache 2.0 License
License URL : https://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : As described in the license

1.4. URI scheme

BasePath : /nifi-registry-api
Schemes : HTTP, HTTPS

1.5. Tags

  • access : Endpoints for obtaining an access token or checking access status.

  • bucket bundles : Create extension bundles scoped to an existing bucket in the registry.

  • bucket flows : Create flows scoped to an existing bucket in the registry.

  • buckets : Create named buckets in the registry to store NiFi objects such flows and extensions. Search for and retrieve existing buckets.

  • bundles : Gets metadata about extension bundles and their versions.

  • config : Retrieves the configuration for this NiFi Registry.

  • extension repository : Interact with extension bundles via the hierarchy of bucket/group/artifact/version.

  • extensions : Find and retrieve extensions.

  • flows : Gets metadata about flows.

  • items : Retrieve items across all buckets for which the user is authorized.

  • policies : Endpoint for managing access policies.

  • tenants : Endpoint for managing users and user groups.

2. Security

2.1. Authorization

Type : apiKey
Name : Authorization
In : HEADER

2.2. BasicAuth

HTTP Basic Auth

Type : basic

3. Resources

3.1. Access

Endpoints for obtaining an access token or checking access status.

3.1.1. Get access status

GET /access
Description

Returns the current client’s authenticated identity and permissions to top-level resources

Responses
HTTP Code Description Schema

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.

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/access
Example HTTP response
Response 200
{
  "identity" : "string",
  "anonymous" : true,
  "loginSupported" : true,
  "resourcePermissions" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "tenants" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "policies" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "proxy" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "anyTopLevelResource" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    }
  },
  "oidcloginSupported" : true
}

3.1.2. Performs a logout for other providers that have been issued a JWT.

DELETE /access/logout
Description
Note
 This endpoint is subject to change as NiFi Registry and its REST API evolve.
Responses
HTTP Code Description Schema

200

User was logged out successfully.

No Content

401

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

No Content

500

Client failed to log out.

No Content
Consumes

  • /

Produces

  • /

Example HTTP request
Request path
/access/logout

3.1.3. Redirect/callback URI for processing the result of the OpenId Connect login sequence.

GET /access/oidc/callback
Description
Note
 This endpoint is subject to change as NiFi Registry and its REST API evolve.
Responses
HTTP Code Description Schema

default

successful operation

No Content
Consumes

  • /

Produces

  • /

Example HTTP request
Request path
/access/oidc/callback

3.1.4. Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.

POST /access/oidc/exchange
Description
Note
 This endpoint is subject to change as NiFi Registry and its REST API evolve.
Responses
HTTP Code Description Schema

200

successful operation

string
Consumes

  • /

Produces

  • text/plain

Example HTTP request
Request path
/access/oidc/exchange
Example HTTP response
Response 200
"string"

3.1.5. Performs a logout in the OpenId Provider.

DELETE /access/oidc/logout
Description
Note
 This endpoint is subject to change as NiFi Registry and its REST API evolve.
Responses
HTTP Code Description Schema

default

successful operation

No Content
Consumes

  • /

Produces

  • /

Example HTTP request
Request path
/access/oidc/logout

3.1.6. Initiates a request to authenticate through the configured OpenId Connect provider.

GET /access/oidc/request
Description
Note
 This endpoint is subject to change as NiFi Registry and its REST API evolve.
Responses
HTTP Code Description Schema

default

successful operation

No Content
Consumes

  • /

Produces

  • /

Example HTTP request
Request path
/access/oidc/request

3.1.7. Create token trying all providers

POST /access/token
Description

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 <token>'.

Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

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.

No Content

500

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

No Content
Consumes

  • /

Produces

  • text/plain

Example HTTP request
Request path
/access/token
Example HTTP response
Response 200
"string"

3.1.8. Create token using identity provider

POST /access/token/identity-provider
Description

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 <token>'.

Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

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.

No Content

500

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

No Content
Consumes

  • /

Produces

  • text/plain

Example HTTP request
Request path
/access/token/identity-provider
Example HTTP response
Response 200
"string"

3.1.9. Test identity provider

POST /access/token/identity-provider/test
Description

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'.

Responses
HTTP Code Description Schema

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.

No Content

401

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

No Content

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.

No Content

500

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

No Content
Consumes

  • /

Produces

  • text/plain

Example HTTP request
Request path
/access/token/identity-provider/test
Example HTTP response
Response 200
"string"

3.1.10. Get identity provider usage

GET /access/token/identity-provider/usage
Description

Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider

Responses
HTTP Code Description Schema

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.

No Content

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.

No Content

500

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

No Content
Consumes

  • /

Produces

  • text/plain

Example HTTP request
Request path
/access/token/identity-provider/usage
Example HTTP response
Response 200
"string"

3.1.11. Create token using kerberos

POST /access/token/kerberos
Description

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 <token>'.

Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

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.

No Content

500

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

No Content
Consumes

  • /

Produces

  • text/plain

Example HTTP request
Request path
/access/token/kerberos
Example HTTP response
Response 200
"string"

3.1.12. Create token using basic auth

POST /access/token/login
Description

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 <credentials>', where <credentials> is the base64 encoded value of '<username>:<password>'. 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 <token>'.

Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

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.

No Content

500

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

No Content
Consumes

  • /

Produces

  • text/plain

Security
Type Name

basic

BasicAuth
Example HTTP request
Request path
/access/token/login
Example HTTP response
Response 200
"string"

3.2. Bucket Bundles

Create extension bundles scoped to an existing bucket in the registry.

3.2.1. Get extension bundles by bucket

GET /buckets/{bucketId}/bundles
Description
Note
 This endpoint is subject to change as NiFi Registry and its REST API evolve.
Parameters
Type Name Description Schema

Path

bucketId
required

The bucket identifier

string
Responses
HTTP Code Description Schema

200

successful operation

< ExtensionBundle > array

400

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

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/buckets/string/bundles
Example HTTP response
Response 200
[ {
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "identifier" : "string",
  "name" : "string",
  "description" : "string",
  "bucketIdentifier" : "string",
  "bucketName" : "string",
  "createdTimestamp" : 0,
  "modifiedTimestamp" : 0,
  "type" : "string",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "bundleType" : "string",
  "groupId" : "string",
  "artifactId" : "string",
  "versionCount" : 0
} ]

3.2.2. Create extension bundle version

POST /buckets/{bucketId}/bundles/{bundleType}
Description

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.
Parameters
Type Name Description Schema

Path

bucketId
required

The bucket identifier

string

Path

bundleType
required

The type of the bundle

enum (nifi-nar, minifi-cpp)
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • multipart/form-data

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/buckets/string/bundles/string
Example HTTP response
Response 200
{
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "versionMetadata" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "id" : "string",
    "bundleId" : "string",
    "bucketId" : "string",
    "groupId" : "string",
    "artifactId" : "string",
    "version" : "string",
    "timestamp" : 0,
    "author" : "string",
    "description" : "string",
    "sha256" : "string",
    "sha256Supplied" : true,
    "contentSize" : 0,
    "systemApiVersion" : "string",
    "buildInfo" : {
      "buildTool" : "string",
      "buildFlags" : "string",
      "buildBranch" : "string",
      "buildTag" : "string",
      "buildRevision" : "string",
      "built" : 0,
      "builtBy" : "string"
    }
  },
  "dependencies" : [ {
    "groupId" : "string",
    "artifactId" : "string",
    "version" : "string"
  } ],
  "bundle" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "identifier" : "string",
    "name" : "string",
    "description" : "string",
    "bucketIdentifier" : "string",
    "bucketName" : "string",
    "createdTimestamp" : 0,
    "modifiedTimestamp" : 0,
    "type" : "string",
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "bundleType" : "string",
    "groupId" : "string",
    "artifactId" : "string",
    "versionCount" : 0
  },
  "bucket" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "identifier" : "string",
    "name" : "string",
    "createdTimestamp" : 0,
    "description" : "string",
    "allowBundleRedeploy" : true,
    "allowPublicRead" : true,
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  },
  "filename" : "string"
}

3.3. Bucket Flows

Create flows scoped to an existing bucket in the registry.

3.3.1. Create flow

POST /buckets/{bucketId}/flows
Description

Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity.

Parameters
Type Name Description Schema

Path

bucketId
required

The bucket identifier

string

Body

body
required

The details of the flow to create.

VersionedFlow
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/buckets/string/flows
Request body
{
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "identifier" : "string",
  "name" : "string",
  "description" : "string",
  "bucketIdentifier" : "string",
  "bucketName" : "string",
  "createdTimestamp" : 0,
  "modifiedTimestamp" : 0,
  "type" : "string",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "versionCount" : 0,
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  }
}
Example HTTP response
Response 200
{
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "identifier" : "string",
  "name" : "string",
  "description" : "string",
  "bucketIdentifier" : "string",
  "bucketName" : "string",
  "createdTimestamp" : 0,
  "modifiedTimestamp" : 0,
  "type" : "string",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "versionCount" : 0,
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  }
}

3.3.2. Get bucket flows

GET /buckets/{bucketId}/flows
Description

Retrieves all flows in the given bucket.

Parameters
Type Name Description Schema

Path

bucketId
required

The bucket identifier

string
Responses
HTTP Code Description Schema

200

successful operation

< VersionedFlow > array

400

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

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/buckets/string/flows
Example HTTP response
Response 200
[ {
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "identifier" : "string",
  "name" : "string",
  "description" : "string",
  "bucketIdentifier" : "string",
  "bucketName" : "string",
  "createdTimestamp" : 0,
  "modifiedTimestamp" : 0,
  "type" : "string",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "versionCount" : 0,
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  }
} ]

3.3.3. Get bucket flow

GET /buckets/{bucketId}/flows/{flowId}
Description

Retrieves the flow with the given id in the given bucket.

Parameters
Type Name Description Schema

Path

bucketId
required

The bucket identifier

string

Path

flowId
required

The flow identifier

string
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/buckets/string/flows/string
Example HTTP response
Response 200
{
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "identifier" : "string",
  "name" : "string",
  "description" : "string",
  "bucketIdentifier" : "string",
  "bucketName" : "string",
  "createdTimestamp" : 0,
  "modifiedTimestamp" : 0,
  "type" : "string",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "versionCount" : 0,
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  }
}

3.3.4. Update bucket flow

PUT /buckets/{bucketId}/flows/{flowId}
Description

Updates the flow with the given id in the given bucket.

Parameters
Type Name Description Schema

Path

bucketId
required

The bucket identifier

string

Path

flowId
required

The flow identifier

string

Body

body
required

The updated flow

VersionedFlow
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/buckets/string/flows/string
Request body
{
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "identifier" : "string",
  "name" : "string",
  "description" : "string",
  "bucketIdentifier" : "string",
  "bucketName" : "string",
  "createdTimestamp" : 0,
  "modifiedTimestamp" : 0,
  "type" : "string",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "versionCount" : 0,
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  }
}
Example HTTP response
Response 200
{
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "identifier" : "string",
  "name" : "string",
  "description" : "string",
  "bucketIdentifier" : "string",
  "bucketName" : "string",
  "createdTimestamp" : 0,
  "modifiedTimestamp" : 0,
  "type" : "string",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "versionCount" : 0,
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  }
}

3.3.5. Delete bucket flow

DELETE /buckets/{bucketId}/flows/{flowId}
Description

Deletes a flow, including all saved versions of that flow.

Parameters
Type Name Description Schema

Path

bucketId
required

The bucket identifier

string

Path

flowId
required

The flow identifier

string

Query

clientId
optional

If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

string

Query

version
required

The version is used to verify the client is working with the latest version of the entity.

string
Responses
HTTP Code Description Schema

200

successful operation

VersionedFlow

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/buckets/string/flows/string
Request query
{
  "clientId" : "string",
  "version" : "string"
}
Example HTTP response
Response 200
{
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "identifier" : "string",
  "name" : "string",
  "description" : "string",
  "bucketIdentifier" : "string",
  "bucketName" : "string",
  "createdTimestamp" : 0,
  "modifiedTimestamp" : 0,
  "type" : "string",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "versionCount" : 0,
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  }
}

3.3.6. Get bucket flow diff

GET /buckets/{bucketId}/flows/{flowId}/diff/{versionA}/{versionB}
Description

Computes the differences between two given versions of a flow.

Parameters
Type Name Description Schema

Path

bucketId
required

The bucket identifier

string

Path

flowId
required

The flow identifier

string

Path

versionA
required

The first version number

integer (int32)

Path

versionB
required

The second version number

integer (int32)
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/buckets/string/flows/string/diff/0/0
Example HTTP response
Response 200
{
  "bucketId" : "string",
  "flowId" : "string",
  "versionA" : 0,
  "versionB" : 0,
  "componentDifferenceGroups" : [ {
    "componentId" : "string",
    "componentName" : "string",
    "componentType" : "string",
    "processGroupId" : "string",
    "differences" : [ {
      "valueA" : "string",
      "valueB" : "string",
      "changeDescription" : "string",
      "differenceType" : "string",
      "differenceTypeDescription" : "string"
    } ]
  } ]
}

3.3.7. Create flow version

POST /buckets/{bucketId}/flows/{flowId}/versions
Description

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.

Parameters
Type Name Description Schema

Path

bucketId
required

The bucket identifier

string

Path

flowId
required

The flow identifier

string

Body

body
required

The new versioned flow snapshot.

VersionedFlowSnapshot
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/buckets/string/flows/string/versions
Request body
{
  "snapshotMetadata" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "bucketIdentifier" : "string",
    "flowIdentifier" : "string",
    "version" : 0,
    "timestamp" : 0,
    "author" : "string",
    "comments" : "string"
  },
  "flowContents" : {
    "identifier" : "string",
    "name" : "string",
    "comments" : "string",
    "position" : {
      "x" : 0.0,
      "y" : 0.0
    },
    "processGroups" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "processGroups" : [ "..." ],
      "remoteProcessGroups" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "targetUri" : "string",
        "targetUris" : "string",
        "communicationsTimeout" : "string",
        "yieldDuration" : "string",
        "transportProtocol" : "string",
        "localNetworkInterface" : "string",
        "proxyHost" : "string",
        "proxyPort" : 0,
        "proxyUser" : "string",
        "inputPorts" : [ {
          "identifier" : "string",
          "name" : "string",
          "comments" : "string",
          "position" : {
            "x" : 0.0,
            "y" : 0.0
          },
          "remoteGroupId" : "string",
          "concurrentlySchedulableTaskCount" : 0,
          "useCompression" : true,
          "batchSize" : {
            "count" : 0,
            "size" : "string",
            "duration" : "string"
          },
          "componentType" : "string",
          "targetId" : "string",
          "scheduledState" : "string",
          "groupIdentifier" : "string"
        } ],
        "outputPorts" : [ {
          "identifier" : "string",
          "name" : "string",
          "comments" : "string",
          "position" : {
            "x" : 0.0,
            "y" : 0.0
          },
          "remoteGroupId" : "string",
          "concurrentlySchedulableTaskCount" : 0,
          "useCompression" : true,
          "batchSize" : {
            "count" : 0,
            "size" : "string",
            "duration" : "string"
          },
          "componentType" : "string",
          "targetId" : "string",
          "scheduledState" : "string",
          "groupIdentifier" : "string"
        } ],
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "processors" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "bundle" : {
          "group" : "string",
          "artifact" : "string",
          "version" : "string"
        },
        "style" : {
          "string" : "string"
        },
        "type" : "string",
        "properties" : {
          "string" : "string"
        },
        "propertyDescriptors" : {
          "string" : "<<_versionedpropertydescriptor>>"
        },
        "annotationData" : "string",
        "schedulingPeriod" : "string",
        "schedulingStrategy" : "string",
        "executionNode" : "string",
        "penaltyDuration" : "string",
        "yieldDuration" : "string",
        "bulletinLevel" : "string",
        "runDurationMillis" : 0,
        "concurrentlySchedulableTaskCount" : 0,
        "autoTerminatedRelationships" : [ "string" ],
        "scheduledState" : "string",
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "inputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "type" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "scheduledState" : "string",
        "allowRemoteAccess" : true,
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "outputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "type" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "scheduledState" : "string",
        "allowRemoteAccess" : true,
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "connections" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "source" : {
          "id" : "string",
          "type" : "string",
          "groupId" : "string",
          "name" : "string",
          "comments" : "string"
        },
        "destination" : {
          "id" : "string",
          "type" : "string",
          "groupId" : "string",
          "name" : "string",
          "comments" : "string"
        },
        "labelIndex" : 0,
        "zIndex" : 0,
        "selectedRelationships" : [ "string" ],
        "backPressureObjectThreshold" : 0,
        "backPressureDataSizeThreshold" : "string",
        "flowFileExpiration" : "string",
        "prioritizers" : [ "string" ],
        "bends" : [ {
          "x" : 0.0,
          "y" : 0.0
        } ],
        "loadBalanceStrategy" : "string",
        "partitioningAttribute" : "string",
        "loadBalanceCompression" : "string",
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "labels" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "label" : "string",
        "width" : 0.0,
        "height" : 0.0,
        "style" : {
          "string" : "string"
        },
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "funnels" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "controllerServices" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "type" : "string",
        "bundle" : {
          "group" : "string",
          "artifact" : "string",
          "version" : "string"
        },
        "controllerServiceApis" : [ {
          "type" : "string",
          "bundle" : {
            "group" : "string",
            "artifact" : "string",
            "version" : "string"
          }
        } ],
        "properties" : {
          "string" : "string"
        },
        "propertyDescriptors" : {
          "string" : "<<_versionedpropertydescriptor>>"
        },
        "annotationData" : "string",
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "versionedFlowCoordinates" : {
        "registryUrl" : "string",
        "bucketId" : "string",
        "flowId" : "string",
        "version" : 0,
        "latest" : true
      },
      "variables" : {
        "string" : "string"
      },
      "parameterContextName" : "string",
      "componentType" : "string",
      "flowFileConcurrency" : "string",
      "flowFileOutboundPolicy" : "string",
      "groupIdentifier" : "string"
    } ],
    "remoteProcessGroups" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "targetUri" : "string",
      "targetUris" : "string",
      "communicationsTimeout" : "string",
      "yieldDuration" : "string",
      "transportProtocol" : "string",
      "localNetworkInterface" : "string",
      "proxyHost" : "string",
      "proxyPort" : 0,
      "proxyUser" : "string",
      "inputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "remoteGroupId" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "useCompression" : true,
        "batchSize" : {
          "count" : 0,
          "size" : "string",
          "duration" : "string"
        },
        "componentType" : "string",
        "targetId" : "string",
        "scheduledState" : "string",
        "groupIdentifier" : "string"
      } ],
      "outputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "remoteGroupId" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "useCompression" : true,
        "batchSize" : {
          "count" : 0,
          "size" : "string",
          "duration" : "string"
        },
        "componentType" : "string",
        "targetId" : "string",
        "scheduledState" : "string",
        "groupIdentifier" : "string"
      } ],
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "processors" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "bundle" : {
        "group" : "string",
        "artifact" : "string",
        "version" : "string"
      },
      "style" : {
        "string" : "string"
      },
      "type" : "string",
      "properties" : {
        "string" : "string"
      },
      "propertyDescriptors" : {
        "string" : "<<_versionedpropertydescriptor>>"
      },
      "annotationData" : "string",
      "schedulingPeriod" : "string",
      "schedulingStrategy" : "string",
      "executionNode" : "string",
      "penaltyDuration" : "string",
      "yieldDuration" : "string",
      "bulletinLevel" : "string",
      "runDurationMillis" : 0,
      "concurrentlySchedulableTaskCount" : 0,
      "autoTerminatedRelationships" : [ "string" ],
      "scheduledState" : "string",
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "inputPorts" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "type" : "string",
      "concurrentlySchedulableTaskCount" : 0,
      "scheduledState" : "string",
      "allowRemoteAccess" : true,
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "outputPorts" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "type" : "string",
      "concurrentlySchedulableTaskCount" : 0,
      "scheduledState" : "string",
      "allowRemoteAccess" : true,
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "connections" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "source" : {
        "id" : "string",
        "type" : "string",
        "groupId" : "string",
        "name" : "string",
        "comments" : "string"
      },
      "destination" : {
        "id" : "string",
        "type" : "string",
        "groupId" : "string",
        "name" : "string",
        "comments" : "string"
      },
      "labelIndex" : 0,
      "zIndex" : 0,
      "selectedRelationships" : [ "string" ],
      "backPressureObjectThreshold" : 0,
      "backPressureDataSizeThreshold" : "string",
      "flowFileExpiration" : "string",
      "prioritizers" : [ "string" ],
      "bends" : [ {
        "x" : 0.0,
        "y" : 0.0
      } ],
      "loadBalanceStrategy" : "string",
      "partitioningAttribute" : "string",
      "loadBalanceCompression" : "string",
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "labels" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "label" : "string",
      "width" : 0.0,
      "height" : 0.0,
      "style" : {
        "string" : "string"
      },
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "funnels" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "controllerServices" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "type" : "string",
      "bundle" : {
        "group" : "string",
        "artifact" : "string",
        "version" : "string"
      },
      "controllerServiceApis" : [ {
        "type" : "string",
        "bundle" : {
          "group" : "string",
          "artifact" : "string",
          "version" : "string"
        }
      } ],
      "properties" : {
        "string" : "string"
      },
      "propertyDescriptors" : {
        "string" : "<<_versionedpropertydescriptor>>"
      },
      "annotationData" : "string",
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "versionedFlowCoordinates" : {
      "registryUrl" : "string",
      "bucketId" : "string",
      "flowId" : "string",
      "version" : 0,
      "latest" : true
    },
    "variables" : {
      "string" : "string"
    },
    "parameterContextName" : "string",
    "componentType" : "string",
    "flowFileConcurrency" : "string",
    "flowFileOutboundPolicy" : "string",
    "groupIdentifier" : "string"
  },
  "externalControllerServices" : {
    "string" : "<<_externalcontrollerservicereference>>"
  },
  "parameterContexts" : {
    "string" : "<<_versionedparametercontext>>"
  },
  "flowEncodingVersion" : "string",
  "flow" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "identifier" : "string",
    "name" : "string",
    "description" : "string",
    "bucketIdentifier" : "string",
    "bucketName" : "string",
    "createdTimestamp" : 0,
    "modifiedTimestamp" : 0,
    "type" : "string",
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "versionCount" : 0,
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  },
  "bucket" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "identifier" : "string",
    "name" : "string",
    "createdTimestamp" : 0,
    "description" : "string",
    "allowBundleRedeploy" : true,
    "allowPublicRead" : true,
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  },
  "latest" : true
}
Example HTTP response
Response 200
{
  "snapshotMetadata" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "bucketIdentifier" : "string",
    "flowIdentifier" : "string",
    "version" : 0,
    "timestamp" : 0,
    "author" : "string",
    "comments" : "string"
  },
  "flowContents" : {
    "identifier" : "string",
    "name" : "string",
    "comments" : "string",
    "position" : {
      "x" : 0.0,
      "y" : 0.0
    },
    "processGroups" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "processGroups" : [ "..." ],
      "remoteProcessGroups" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "targetUri" : "string",
        "targetUris" : "string",
        "communicationsTimeout" : "string",
        "yieldDuration" : "string",
        "transportProtocol" : "string",
        "localNetworkInterface" : "string",
        "proxyHost" : "string",
        "proxyPort" : 0,
        "proxyUser" : "string",
        "inputPorts" : [ {
          "identifier" : "string",
          "name" : "string",
          "comments" : "string",
          "position" : {
            "x" : 0.0,
            "y" : 0.0
          },
          "remoteGroupId" : "string",
          "concurrentlySchedulableTaskCount" : 0,
          "useCompression" : true,
          "batchSize" : {
            "count" : 0,
            "size" : "string",
            "duration" : "string"
          },
          "componentType" : "string",
          "targetId" : "string",
          "scheduledState" : "string",
          "groupIdentifier" : "string"
        } ],
        "outputPorts" : [ {
          "identifier" : "string",
          "name" : "string",
          "comments" : "string",
          "position" : {
            "x" : 0.0,
            "y" : 0.0
          },
          "remoteGroupId" : "string",
          "concurrentlySchedulableTaskCount" : 0,
          "useCompression" : true,
          "batchSize" : {
            "count" : 0,
            "size" : "string",
            "duration" : "string"
          },
          "componentType" : "string",
          "targetId" : "string",
          "scheduledState" : "string",
          "groupIdentifier" : "string"
        } ],
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "processors" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "bundle" : {
          "group" : "string",
          "artifact" : "string",
          "version" : "string"
        },
        "style" : {
          "string" : "string"
        },
        "type" : "string",
        "properties" : {
          "string" : "string"
        },
        "propertyDescriptors" : {
          "string" : "<<_versionedpropertydescriptor>>"
        },
        "annotationData" : "string",
        "schedulingPeriod" : "string",
        "schedulingStrategy" : "string",
        "executionNode" : "string",
        "penaltyDuration" : "string",
        "yieldDuration" : "string",
        "bulletinLevel" : "string",
        "runDurationMillis" : 0,
        "concurrentlySchedulableTaskCount" : 0,
        "autoTerminatedRelationships" : [ "string" ],
        "scheduledState" : "string",
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "inputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "type" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "scheduledState" : "string",
        "allowRemoteAccess" : true,
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "outputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "type" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "scheduledState" : "string",
        "allowRemoteAccess" : true,
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "connections" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "source" : {
          "id" : "string",
          "type" : "string",
          "groupId" : "string",
          "name" : "string",
          "comments" : "string"
        },
        "destination" : {
          "id" : "string",
          "type" : "string",
          "groupId" : "string",
          "name" : "string",
          "comments" : "string"
        },
        "labelIndex" : 0,
        "zIndex" : 0,
        "selectedRelationships" : [ "string" ],
        "backPressureObjectThreshold" : 0,
        "backPressureDataSizeThreshold" : "string",
        "flowFileExpiration" : "string",
        "prioritizers" : [ "string" ],
        "bends" : [ {
          "x" : 0.0,
          "y" : 0.0
        } ],
        "loadBalanceStrategy" : "string",
        "partitioningAttribute" : "string",
        "loadBalanceCompression" : "string",
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "labels" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "label" : "string",
        "width" : 0.0,
        "height" : 0.0,
        "style" : {
          "string" : "string"
        },
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "funnels" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "controllerServices" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "type" : "string",
        "bundle" : {
          "group" : "string",
          "artifact" : "string",
          "version" : "string"
        },
        "controllerServiceApis" : [ {
          "type" : "string",
          "bundle" : {
            "group" : "string",
            "artifact" : "string",
            "version" : "string"
          }
        } ],
        "properties" : {
          "string" : "string"
        },
        "propertyDescriptors" : {
          "string" : "<<_versionedpropertydescriptor>>"
        },
        "annotationData" : "string",
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "versionedFlowCoordinates" : {
        "registryUrl" : "string",
        "bucketId" : "string",
        "flowId" : "string",
        "version" : 0,
        "latest" : true
      },
      "variables" : {
        "string" : "string"
      },
      "parameterContextName" : "string",
      "componentType" : "string",
      "flowFileConcurrency" : "string",
      "flowFileOutboundPolicy" : "string",
      "groupIdentifier" : "string"
    } ],
    "remoteProcessGroups" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "targetUri" : "string",
      "targetUris" : "string",
      "communicationsTimeout" : "string",
      "yieldDuration" : "string",
      "transportProtocol" : "string",
      "localNetworkInterface" : "string",
      "proxyHost" : "string",
      "proxyPort" : 0,
      "proxyUser" : "string",
      "inputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "remoteGroupId" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "useCompression" : true,
        "batchSize" : {
          "count" : 0,
          "size" : "string",
          "duration" : "string"
        },
        "componentType" : "string",
        "targetId" : "string",
        "scheduledState" : "string",
        "groupIdentifier" : "string"
      } ],
      "outputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "remoteGroupId" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "useCompression" : true,
        "batchSize" : {
          "count" : 0,
          "size" : "string",
          "duration" : "string"
        },
        "componentType" : "string",
        "targetId" : "string",
        "scheduledState" : "string",
        "groupIdentifier" : "string"
      } ],
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "processors" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "bundle" : {
        "group" : "string",
        "artifact" : "string",
        "version" : "string"
      },
      "style" : {
        "string" : "string"
      },
      "type" : "string",
      "properties" : {
        "string" : "string"
      },
      "propertyDescriptors" : {
        "string" : "<<_versionedpropertydescriptor>>"
      },
      "annotationData" : "string",
      "schedulingPeriod" : "string",
      "schedulingStrategy" : "string",
      "executionNode" : "string",
      "penaltyDuration" : "string",
      "yieldDuration" : "string",
      "bulletinLevel" : "string",
      "runDurationMillis" : 0,
      "concurrentlySchedulableTaskCount" : 0,
      "autoTerminatedRelationships" : [ "string" ],
      "scheduledState" : "string",
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "inputPorts" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "type" : "string",
      "concurrentlySchedulableTaskCount" : 0,
      "scheduledState" : "string",
      "allowRemoteAccess" : true,
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "outputPorts" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "type" : "string",
      "concurrentlySchedulableTaskCount" : 0,
      "scheduledState" : "string",
      "allowRemoteAccess" : true,
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "connections" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "source" : {
        "id" : "string",
        "type" : "string",
        "groupId" : "string",
        "name" : "string",
        "comments" : "string"
      },
      "destination" : {
        "id" : "string",
        "type" : "string",
        "groupId" : "string",
        "name" : "string",
        "comments" : "string"
      },
      "labelIndex" : 0,
      "zIndex" : 0,
      "selectedRelationships" : [ "string" ],
      "backPressureObjectThreshold" : 0,
      "backPressureDataSizeThreshold" : "string",
      "flowFileExpiration" : "string",
      "prioritizers" : [ "string" ],
      "bends" : [ {
        "x" : 0.0,
        "y" : 0.0
      } ],
      "loadBalanceStrategy" : "string",
      "partitioningAttribute" : "string",
      "loadBalanceCompression" : "string",
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "labels" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "label" : "string",
      "width" : 0.0,
      "height" : 0.0,
      "style" : {
        "string" : "string"
      },
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "funnels" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "controllerServices" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "type" : "string",
      "bundle" : {
        "group" : "string",
        "artifact" : "string",
        "version" : "string"
      },
      "controllerServiceApis" : [ {
        "type" : "string",
        "bundle" : {
          "group" : "string",
          "artifact" : "string",
          "version" : "string"
        }
      } ],
      "properties" : {
        "string" : "string"
      },
      "propertyDescriptors" : {
        "string" : "<<_versionedpropertydescriptor>>"
      },
      "annotationData" : "string",
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "versionedFlowCoordinates" : {
      "registryUrl" : "string",
      "bucketId" : "string",
      "flowId" : "string",
      "version" : 0,
      "latest" : true
    },
    "variables" : {
      "string" : "string"
    },
    "parameterContextName" : "string",
    "componentType" : "string",
    "flowFileConcurrency" : "string",
    "flowFileOutboundPolicy" : "string",
    "groupIdentifier" : "string"
  },
  "externalControllerServices" : {
    "string" : "<<_externalcontrollerservicereference>>"
  },
  "parameterContexts" : {
    "string" : "<<_versionedparametercontext>>"
  },
  "flowEncodingVersion" : "string",
  "flow" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "identifier" : "string",
    "name" : "string",
    "description" : "string",
    "bucketIdentifier" : "string",
    "bucketName" : "string",
    "createdTimestamp" : 0,
    "modifiedTimestamp" : 0,
    "type" : "string",
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "versionCount" : 0,
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  },
  "bucket" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "identifier" : "string",
    "name" : "string",
    "createdTimestamp" : 0,
    "description" : "string",
    "allowBundleRedeploy" : true,
    "allowPublicRead" : true,
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  },
  "latest" : true
}

3.3.8. Get bucket flow versions

GET /buckets/{bucketId}/flows/{flowId}/versions
Description

Gets summary information for all versions of a flow. Versions are ordered newest->oldest.

Parameters
Type Name Description Schema

Path

bucketId
required

The bucket identifier

string

Path

flowId
required

The flow identifier

string
Responses
HTTP Code Description Schema

200

successful operation

< VersionedFlowSnapshotMetadata > array

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/buckets/string/flows/string/versions
Example HTTP response
Response 200
[ {
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "bucketIdentifier" : "string",
  "flowIdentifier" : "string",
  "version" : 0,
  "timestamp" : 0,
  "author" : "string",
  "comments" : "string"
} ]

3.3.9. Get latest bucket flow version content

GET /buckets/{bucketId}/flows/{flowId}/versions/latest
Description

Gets the latest version of a flow, including the metadata and content of the flow.

Parameters
Type Name Description Schema

Path

bucketId
required

The bucket identifier

string

Path

flowId
required

The flow identifier

string
Responses
HTTP Code Description Schema

200

successful operation

VersionedFlowSnapshot

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/buckets/string/flows/string/versions/latest
Example HTTP response
Response 200
{
  "snapshotMetadata" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "bucketIdentifier" : "string",
    "flowIdentifier" : "string",
    "version" : 0,
    "timestamp" : 0,
    "author" : "string",
    "comments" : "string"
  },
  "flowContents" : {
    "identifier" : "string",
    "name" : "string",
    "comments" : "string",
    "position" : {
      "x" : 0.0,
      "y" : 0.0
    },
    "processGroups" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "processGroups" : [ "..." ],
      "remoteProcessGroups" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "targetUri" : "string",
        "targetUris" : "string",
        "communicationsTimeout" : "string",
        "yieldDuration" : "string",
        "transportProtocol" : "string",
        "localNetworkInterface" : "string",
        "proxyHost" : "string",
        "proxyPort" : 0,
        "proxyUser" : "string",
        "inputPorts" : [ {
          "identifier" : "string",
          "name" : "string",
          "comments" : "string",
          "position" : {
            "x" : 0.0,
            "y" : 0.0
          },
          "remoteGroupId" : "string",
          "concurrentlySchedulableTaskCount" : 0,
          "useCompression" : true,
          "batchSize" : {
            "count" : 0,
            "size" : "string",
            "duration" : "string"
          },
          "componentType" : "string",
          "targetId" : "string",
          "scheduledState" : "string",
          "groupIdentifier" : "string"
        } ],
        "outputPorts" : [ {
          "identifier" : "string",
          "name" : "string",
          "comments" : "string",
          "position" : {
            "x" : 0.0,
            "y" : 0.0
          },
          "remoteGroupId" : "string",
          "concurrentlySchedulableTaskCount" : 0,
          "useCompression" : true,
          "batchSize" : {
            "count" : 0,
            "size" : "string",
            "duration" : "string"
          },
          "componentType" : "string",
          "targetId" : "string",
          "scheduledState" : "string",
          "groupIdentifier" : "string"
        } ],
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "processors" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "bundle" : {
          "group" : "string",
          "artifact" : "string",
          "version" : "string"
        },
        "style" : {
          "string" : "string"
        },
        "type" : "string",
        "properties" : {
          "string" : "string"
        },
        "propertyDescriptors" : {
          "string" : "<<_versionedpropertydescriptor>>"
        },
        "annotationData" : "string",
        "schedulingPeriod" : "string",
        "schedulingStrategy" : "string",
        "executionNode" : "string",
        "penaltyDuration" : "string",
        "yieldDuration" : "string",
        "bulletinLevel" : "string",
        "runDurationMillis" : 0,
        "concurrentlySchedulableTaskCount" : 0,
        "autoTerminatedRelationships" : [ "string" ],
        "scheduledState" : "string",
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "inputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "type" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "scheduledState" : "string",
        "allowRemoteAccess" : true,
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "outputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "type" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "scheduledState" : "string",
        "allowRemoteAccess" : true,
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "connections" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "source" : {
          "id" : "string",
          "type" : "string",
          "groupId" : "string",
          "name" : "string",
          "comments" : "string"
        },
        "destination" : {
          "id" : "string",
          "type" : "string",
          "groupId" : "string",
          "name" : "string",
          "comments" : "string"
        },
        "labelIndex" : 0,
        "zIndex" : 0,
        "selectedRelationships" : [ "string" ],
        "backPressureObjectThreshold" : 0,
        "backPressureDataSizeThreshold" : "string",
        "flowFileExpiration" : "string",
        "prioritizers" : [ "string" ],
        "bends" : [ {
          "x" : 0.0,
          "y" : 0.0
        } ],
        "loadBalanceStrategy" : "string",
        "partitioningAttribute" : "string",
        "loadBalanceCompression" : "string",
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "labels" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "label" : "string",
        "width" : 0.0,
        "height" : 0.0,
        "style" : {
          "string" : "string"
        },
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "funnels" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "controllerServices" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "type" : "string",
        "bundle" : {
          "group" : "string",
          "artifact" : "string",
          "version" : "string"
        },
        "controllerServiceApis" : [ {
          "type" : "string",
          "bundle" : {
            "group" : "string",
            "artifact" : "string",
            "version" : "string"
          }
        } ],
        "properties" : {
          "string" : "string"
        },
        "propertyDescriptors" : {
          "string" : "<<_versionedpropertydescriptor>>"
        },
        "annotationData" : "string",
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "versionedFlowCoordinates" : {
        "registryUrl" : "string",
        "bucketId" : "string",
        "flowId" : "string",
        "version" : 0,
        "latest" : true
      },
      "variables" : {
        "string" : "string"
      },
      "parameterContextName" : "string",
      "componentType" : "string",
      "flowFileConcurrency" : "string",
      "flowFileOutboundPolicy" : "string",
      "groupIdentifier" : "string"
    } ],
    "remoteProcessGroups" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "targetUri" : "string",
      "targetUris" : "string",
      "communicationsTimeout" : "string",
      "yieldDuration" : "string",
      "transportProtocol" : "string",
      "localNetworkInterface" : "string",
      "proxyHost" : "string",
      "proxyPort" : 0,
      "proxyUser" : "string",
      "inputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "remoteGroupId" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "useCompression" : true,
        "batchSize" : {
          "count" : 0,
          "size" : "string",
          "duration" : "string"
        },
        "componentType" : "string",
        "targetId" : "string",
        "scheduledState" : "string",
        "groupIdentifier" : "string"
      } ],
      "outputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "remoteGroupId" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "useCompression" : true,
        "batchSize" : {
          "count" : 0,
          "size" : "string",
          "duration" : "string"
        },
        "componentType" : "string",
        "targetId" : "string",
        "scheduledState" : "string",
        "groupIdentifier" : "string"
      } ],
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "processors" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "bundle" : {
        "group" : "string",
        "artifact" : "string",
        "version" : "string"
      },
      "style" : {
        "string" : "string"
      },
      "type" : "string",
      "properties" : {
        "string" : "string"
      },
      "propertyDescriptors" : {
        "string" : "<<_versionedpropertydescriptor>>"
      },
      "annotationData" : "string",
      "schedulingPeriod" : "string",
      "schedulingStrategy" : "string",
      "executionNode" : "string",
      "penaltyDuration" : "string",
      "yieldDuration" : "string",
      "bulletinLevel" : "string",
      "runDurationMillis" : 0,
      "concurrentlySchedulableTaskCount" : 0,
      "autoTerminatedRelationships" : [ "string" ],
      "scheduledState" : "string",
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "inputPorts" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "type" : "string",
      "concurrentlySchedulableTaskCount" : 0,
      "scheduledState" : "string",
      "allowRemoteAccess" : true,
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "outputPorts" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "type" : "string",
      "concurrentlySchedulableTaskCount" : 0,
      "scheduledState" : "string",
      "allowRemoteAccess" : true,
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "connections" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "source" : {
        "id" : "string",
        "type" : "string",
        "groupId" : "string",
        "name" : "string",
        "comments" : "string"
      },
      "destination" : {
        "id" : "string",
        "type" : "string",
        "groupId" : "string",
        "name" : "string",
        "comments" : "string"
      },
      "labelIndex" : 0,
      "zIndex" : 0,
      "selectedRelationships" : [ "string" ],
      "backPressureObjectThreshold" : 0,
      "backPressureDataSizeThreshold" : "string",
      "flowFileExpiration" : "string",
      "prioritizers" : [ "string" ],
      "bends" : [ {
        "x" : 0.0,
        "y" : 0.0
      } ],
      "loadBalanceStrategy" : "string",
      "partitioningAttribute" : "string",
      "loadBalanceCompression" : "string",
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "labels" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "label" : "string",
      "width" : 0.0,
      "height" : 0.0,
      "style" : {
        "string" : "string"
      },
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "funnels" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "controllerServices" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "type" : "string",
      "bundle" : {
        "group" : "string",
        "artifact" : "string",
        "version" : "string"
      },
      "controllerServiceApis" : [ {
        "type" : "string",
        "bundle" : {
          "group" : "string",
          "artifact" : "string",
          "version" : "string"
        }
      } ],
      "properties" : {
        "string" : "string"
      },
      "propertyDescriptors" : {
        "string" : "<<_versionedpropertydescriptor>>"
      },
      "annotationData" : "string",
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "versionedFlowCoordinates" : {
      "registryUrl" : "string",
      "bucketId" : "string",
      "flowId" : "string",
      "version" : 0,
      "latest" : true
    },
    "variables" : {
      "string" : "string"
    },
    "parameterContextName" : "string",
    "componentType" : "string",
    "flowFileConcurrency" : "string",
    "flowFileOutboundPolicy" : "string",
    "groupIdentifier" : "string"
  },
  "externalControllerServices" : {
    "string" : "<<_externalcontrollerservicereference>>"
  },
  "parameterContexts" : {
    "string" : "<<_versionedparametercontext>>"
  },
  "flowEncodingVersion" : "string",
  "flow" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "identifier" : "string",
    "name" : "string",
    "description" : "string",
    "bucketIdentifier" : "string",
    "bucketName" : "string",
    "createdTimestamp" : 0,
    "modifiedTimestamp" : 0,
    "type" : "string",
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "versionCount" : 0,
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  },
  "bucket" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "identifier" : "string",
    "name" : "string",
    "createdTimestamp" : 0,
    "description" : "string",
    "allowBundleRedeploy" : true,
    "allowPublicRead" : true,
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  },
  "latest" : true
}

3.3.10. Get latest bucket flow version metadata

GET /buckets/{bucketId}/flows/{flowId}/versions/latest/metadata
Description

Gets the metadata for the latest version of a flow.

Parameters
Type Name Description Schema

Path

bucketId
required

The bucket identifier

string

Path

flowId
required

The flow identifier

string
Responses
HTTP Code Description Schema

200

successful operation

VersionedFlowSnapshotMetadata

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/buckets/string/flows/string/versions/latest/metadata
Example HTTP response
Response 200
{
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "bucketIdentifier" : "string",
  "flowIdentifier" : "string",
  "version" : 0,
  "timestamp" : 0,
  "author" : "string",
  "comments" : "string"
}

3.3.11. Get bucket flow version

GET /buckets/{bucketId}/flows/{flowId}/versions/{versionNumber}
Description

Gets the given version of a flow, including the metadata and content for the version.

Parameters
Type Name Description Schema

Path

bucketId
required

The bucket identifier

string

Path

flowId
required

The flow identifier

string

Path

versionNumber
required

The version number

integer (int32)
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/buckets/string/flows/string/versions/0
Example HTTP response
Response 200
{
  "snapshotMetadata" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "bucketIdentifier" : "string",
    "flowIdentifier" : "string",
    "version" : 0,
    "timestamp" : 0,
    "author" : "string",
    "comments" : "string"
  },
  "flowContents" : {
    "identifier" : "string",
    "name" : "string",
    "comments" : "string",
    "position" : {
      "x" : 0.0,
      "y" : 0.0
    },
    "processGroups" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "processGroups" : [ "..." ],
      "remoteProcessGroups" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "targetUri" : "string",
        "targetUris" : "string",
        "communicationsTimeout" : "string",
        "yieldDuration" : "string",
        "transportProtocol" : "string",
        "localNetworkInterface" : "string",
        "proxyHost" : "string",
        "proxyPort" : 0,
        "proxyUser" : "string",
        "inputPorts" : [ {
          "identifier" : "string",
          "name" : "string",
          "comments" : "string",
          "position" : {
            "x" : 0.0,
            "y" : 0.0
          },
          "remoteGroupId" : "string",
          "concurrentlySchedulableTaskCount" : 0,
          "useCompression" : true,
          "batchSize" : {
            "count" : 0,
            "size" : "string",
            "duration" : "string"
          },
          "componentType" : "string",
          "targetId" : "string",
          "scheduledState" : "string",
          "groupIdentifier" : "string"
        } ],
        "outputPorts" : [ {
          "identifier" : "string",
          "name" : "string",
          "comments" : "string",
          "position" : {
            "x" : 0.0,
            "y" : 0.0
          },
          "remoteGroupId" : "string",
          "concurrentlySchedulableTaskCount" : 0,
          "useCompression" : true,
          "batchSize" : {
            "count" : 0,
            "size" : "string",
            "duration" : "string"
          },
          "componentType" : "string",
          "targetId" : "string",
          "scheduledState" : "string",
          "groupIdentifier" : "string"
        } ],
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "processors" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "bundle" : {
          "group" : "string",
          "artifact" : "string",
          "version" : "string"
        },
        "style" : {
          "string" : "string"
        },
        "type" : "string",
        "properties" : {
          "string" : "string"
        },
        "propertyDescriptors" : {
          "string" : "<<_versionedpropertydescriptor>>"
        },
        "annotationData" : "string",
        "schedulingPeriod" : "string",
        "schedulingStrategy" : "string",
        "executionNode" : "string",
        "penaltyDuration" : "string",
        "yieldDuration" : "string",
        "bulletinLevel" : "string",
        "runDurationMillis" : 0,
        "concurrentlySchedulableTaskCount" : 0,
        "autoTerminatedRelationships" : [ "string" ],
        "scheduledState" : "string",
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "inputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "type" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "scheduledState" : "string",
        "allowRemoteAccess" : true,
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "outputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "type" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "scheduledState" : "string",
        "allowRemoteAccess" : true,
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "connections" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "source" : {
          "id" : "string",
          "type" : "string",
          "groupId" : "string",
          "name" : "string",
          "comments" : "string"
        },
        "destination" : {
          "id" : "string",
          "type" : "string",
          "groupId" : "string",
          "name" : "string",
          "comments" : "string"
        },
        "labelIndex" : 0,
        "zIndex" : 0,
        "selectedRelationships" : [ "string" ],
        "backPressureObjectThreshold" : 0,
        "backPressureDataSizeThreshold" : "string",
        "flowFileExpiration" : "string",
        "prioritizers" : [ "string" ],
        "bends" : [ {
          "x" : 0.0,
          "y" : 0.0
        } ],
        "loadBalanceStrategy" : "string",
        "partitioningAttribute" : "string",
        "loadBalanceCompression" : "string",
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "labels" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "label" : "string",
        "width" : 0.0,
        "height" : 0.0,
        "style" : {
          "string" : "string"
        },
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "funnels" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "controllerServices" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "type" : "string",
        "bundle" : {
          "group" : "string",
          "artifact" : "string",
          "version" : "string"
        },
        "controllerServiceApis" : [ {
          "type" : "string",
          "bundle" : {
            "group" : "string",
            "artifact" : "string",
            "version" : "string"
          }
        } ],
        "properties" : {
          "string" : "string"
        },
        "propertyDescriptors" : {
          "string" : "<<_versionedpropertydescriptor>>"
        },
        "annotationData" : "string",
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "versionedFlowCoordinates" : {
        "registryUrl" : "string",
        "bucketId" : "string",
        "flowId" : "string",
        "version" : 0,
        "latest" : true
      },
      "variables" : {
        "string" : "string"
      },
      "parameterContextName" : "string",
      "componentType" : "string",
      "flowFileConcurrency" : "string",
      "flowFileOutboundPolicy" : "string",
      "groupIdentifier" : "string"
    } ],
    "remoteProcessGroups" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "targetUri" : "string",
      "targetUris" : "string",
      "communicationsTimeout" : "string",
      "yieldDuration" : "string",
      "transportProtocol" : "string",
      "localNetworkInterface" : "string",
      "proxyHost" : "string",
      "proxyPort" : 0,
      "proxyUser" : "string",
      "inputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "remoteGroupId" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "useCompression" : true,
        "batchSize" : {
          "count" : 0,
          "size" : "string",
          "duration" : "string"
        },
        "componentType" : "string",
        "targetId" : "string",
        "scheduledState" : "string",
        "groupIdentifier" : "string"
      } ],
      "outputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "remoteGroupId" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "useCompression" : true,
        "batchSize" : {
          "count" : 0,
          "size" : "string",
          "duration" : "string"
        },
        "componentType" : "string",
        "targetId" : "string",
        "scheduledState" : "string",
        "groupIdentifier" : "string"
      } ],
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "processors" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "bundle" : {
        "group" : "string",
        "artifact" : "string",
        "version" : "string"
      },
      "style" : {
        "string" : "string"
      },
      "type" : "string",
      "properties" : {
        "string" : "string"
      },
      "propertyDescriptors" : {
        "string" : "<<_versionedpropertydescriptor>>"
      },
      "annotationData" : "string",
      "schedulingPeriod" : "string",
      "schedulingStrategy" : "string",
      "executionNode" : "string",
      "penaltyDuration" : "string",
      "yieldDuration" : "string",
      "bulletinLevel" : "string",
      "runDurationMillis" : 0,
      "concurrentlySchedulableTaskCount" : 0,
      "autoTerminatedRelationships" : [ "string" ],
      "scheduledState" : "string",
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "inputPorts" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "type" : "string",
      "concurrentlySchedulableTaskCount" : 0,
      "scheduledState" : "string",
      "allowRemoteAccess" : true,
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "outputPorts" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "type" : "string",
      "concurrentlySchedulableTaskCount" : 0,
      "scheduledState" : "string",
      "allowRemoteAccess" : true,
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "connections" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "source" : {
        "id" : "string",
        "type" : "string",
        "groupId" : "string",
        "name" : "string",
        "comments" : "string"
      },
      "destination" : {
        "id" : "string",
        "type" : "string",
        "groupId" : "string",
        "name" : "string",
        "comments" : "string"
      },
      "labelIndex" : 0,
      "zIndex" : 0,
      "selectedRelationships" : [ "string" ],
      "backPressureObjectThreshold" : 0,
      "backPressureDataSizeThreshold" : "string",
      "flowFileExpiration" : "string",
      "prioritizers" : [ "string" ],
      "bends" : [ {
        "x" : 0.0,
        "y" : 0.0
      } ],
      "loadBalanceStrategy" : "string",
      "partitioningAttribute" : "string",
      "loadBalanceCompression" : "string",
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "labels" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "label" : "string",
      "width" : 0.0,
      "height" : 0.0,
      "style" : {
        "string" : "string"
      },
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "funnels" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "controllerServices" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "type" : "string",
      "bundle" : {
        "group" : "string",
        "artifact" : "string",
        "version" : "string"
      },
      "controllerServiceApis" : [ {
        "type" : "string",
        "bundle" : {
          "group" : "string",
          "artifact" : "string",
          "version" : "string"
        }
      } ],
      "properties" : {
        "string" : "string"
      },
      "propertyDescriptors" : {
        "string" : "<<_versionedpropertydescriptor>>"
      },
      "annotationData" : "string",
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "versionedFlowCoordinates" : {
      "registryUrl" : "string",
      "bucketId" : "string",
      "flowId" : "string",
      "version" : 0,
      "latest" : true
    },
    "variables" : {
      "string" : "string"
    },
    "parameterContextName" : "string",
    "componentType" : "string",
    "flowFileConcurrency" : "string",
    "flowFileOutboundPolicy" : "string",
    "groupIdentifier" : "string"
  },
  "externalControllerServices" : {
    "string" : "<<_externalcontrollerservicereference>>"
  },
  "parameterContexts" : {
    "string" : "<<_versionedparametercontext>>"
  },
  "flowEncodingVersion" : "string",
  "flow" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "identifier" : "string",
    "name" : "string",
    "description" : "string",
    "bucketIdentifier" : "string",
    "bucketName" : "string",
    "createdTimestamp" : 0,
    "modifiedTimestamp" : 0,
    "type" : "string",
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "versionCount" : 0,
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  },
  "bucket" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "identifier" : "string",
    "name" : "string",
    "createdTimestamp" : 0,
    "description" : "string",
    "allowBundleRedeploy" : true,
    "allowPublicRead" : true,
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  },
  "latest" : true
}

3.4. Buckets

Create named buckets in the registry to store NiFi objects such flows and extensions. Search for and retrieve existing buckets.

3.4.1. Create bucket

POST /buckets
Parameters
Type Name Description Schema

Body

body
required

The bucket to create

Bucket
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/buckets
Request body
{
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "identifier" : "string",
  "name" : "string",
  "createdTimestamp" : 0,
  "description" : "string",
  "allowBundleRedeploy" : true,
  "allowPublicRead" : true,
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  }
}
Example HTTP response
Response 200
{
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "identifier" : "string",
  "name" : "string",
  "createdTimestamp" : 0,
  "description" : "string",
  "allowBundleRedeploy" : true,
  "allowPublicRead" : true,
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  }
}

3.4.2. Get all buckets

GET /buckets
Description

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.

Responses
HTTP Code Description Schema

200

successful operation

< Bucket > array

401

Client could not be authenticated.

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/buckets
Example HTTP response
Response 200
[ {
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "identifier" : "string",
  "name" : "string",
  "createdTimestamp" : 0,
  "description" : "string",
  "allowBundleRedeploy" : true,
  "allowPublicRead" : true,
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  }
} ]

3.4.3. Get bucket fields

GET /buckets/fields
Description

Retrieves bucket field names for searching or sorting on buckets.

Responses
HTTP Code Description Schema

200

successful operation

Fields
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/buckets/fields
Example HTTP response
Response 200
{
  "fields" : [ "string" ]
}

3.4.4. Get bucket

GET /buckets/{bucketId}
Description

Gets the bucket with the given id.

Parameters
Type Name Description Schema

Path

bucketId
required

The bucket identifier

string
Responses
HTTP Code Description Schema

200

successful operation

Bucket

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/buckets/string
Example HTTP response
Response 200
{
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "identifier" : "string",
  "name" : "string",
  "createdTimestamp" : 0,
  "description" : "string",
  "allowBundleRedeploy" : true,
  "allowPublicRead" : true,
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  }
}

3.4.5. Update bucket

PUT /buckets/{bucketId}
Description

Updates the bucket with the given id.

Parameters
Type Name Description Schema

Path

bucketId
required

The bucket identifier

string

Body

body
required

The updated bucket

Bucket
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/buckets/string
Request body
{
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "identifier" : "string",
  "name" : "string",
  "createdTimestamp" : 0,
  "description" : "string",
  "allowBundleRedeploy" : true,
  "allowPublicRead" : true,
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  }
}
Example HTTP response
Response 200
{
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "identifier" : "string",
  "name" : "string",
  "createdTimestamp" : 0,
  "description" : "string",
  "allowBundleRedeploy" : true,
  "allowPublicRead" : true,
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  }
}

3.4.6. Delete bucket

DELETE /buckets/{bucketId}
Description

Deletes the bucket with the given id, along with all objects stored in the bucket

Parameters
Type Name Description Schema

Path

bucketId
required

The bucket identifier

string

Query

clientId
optional

If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

string

Query

version
required

The version is used to verify the client is working with the latest version of the entity.

string
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/buckets/string
Request query
{
  "clientId" : "string",
  "version" : "string"
}
Example HTTP response
Response 200
{
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "identifier" : "string",
  "name" : "string",
  "createdTimestamp" : 0,
  "description" : "string",
  "allowBundleRedeploy" : true,
  "allowPublicRead" : true,
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  }
}

3.5. Bundles

Gets metadata about extension bundles and their versions.

3.5.1. Get all bundles

GET /bundles
Description

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.
Parameters
Type Name Description Schema

Query

artifactId
optional

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-'.

string

Query

bucketName
optional

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'.

string

Query

groupId
optional

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.'.

string
Responses
HTTP Code Description Schema

200

successful operation

< ExtensionBundle > array

401

Client could not be authenticated.

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/bundles
Request query
{
  "artifactId" : "string",
  "bucketName" : "string",
  "groupId" : "string"
}
Example HTTP response
Response 200
[ {
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "identifier" : "string",
  "name" : "string",
  "description" : "string",
  "bucketIdentifier" : "string",
  "bucketName" : "string",
  "createdTimestamp" : 0,
  "modifiedTimestamp" : 0,
  "type" : "string",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "bundleType" : "string",
  "groupId" : "string",
  "artifactId" : "string",
  "versionCount" : 0
} ]

3.5.2. Get all bundle versions

GET /bundles/versions
Description

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.
Parameters
Type Name Description Schema

Query

artifactId
optional

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-'.

string

Query

groupId
optional

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.'.

string

Query

version
optional

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.'.

string
Responses
HTTP Code Description Schema

200

successful operation

< BundleVersionMetadata > array

401

Client could not be authenticated.

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/bundles/versions
Request query
{
  "artifactId" : "string",
  "groupId" : "string",
  "version" : "string"
}
Example HTTP response
Response 200
[ {
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "id" : "string",
  "bundleId" : "string",
  "bucketId" : "string",
  "groupId" : "string",
  "artifactId" : "string",
  "version" : "string",
  "timestamp" : 0,
  "author" : "string",
  "description" : "string",
  "sha256" : "string",
  "sha256Supplied" : true,
  "contentSize" : 0,
  "systemApiVersion" : "string",
  "buildInfo" : {
    "buildTool" : "string",
    "buildFlags" : "string",
    "buildBranch" : "string",
    "buildTag" : "string",
    "buildRevision" : "string",
    "built" : 0,
    "builtBy" : "string"
  }
} ]

3.5.3. Get bundle

GET /bundles/{bundleId}
Description

Gets the metadata about an extension bundle.

Note
 This endpoint is subject to change as NiFi Registry and its REST API evolve.
Parameters
Type Name Description Schema

Path

bundleId
required

The extension bundle identifier

string
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/bundles/string
Example HTTP response
Response 200
{
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "identifier" : "string",
  "name" : "string",
  "description" : "string",
  "bucketIdentifier" : "string",
  "bucketName" : "string",
  "createdTimestamp" : 0,
  "modifiedTimestamp" : 0,
  "type" : "string",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "bundleType" : "string",
  "groupId" : "string",
  "artifactId" : "string",
  "versionCount" : 0
}

3.5.4. Delete bundle

DELETE /bundles/{bundleId}
Description

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.
Parameters
Type Name Description Schema

Path

bundleId
required

The extension bundle identifier

string
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/bundles/string
Example HTTP response
Response 200
{
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "identifier" : "string",
  "name" : "string",
  "description" : "string",
  "bucketIdentifier" : "string",
  "bucketName" : "string",
  "createdTimestamp" : 0,
  "modifiedTimestamp" : 0,
  "type" : "string",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "bundleType" : "string",
  "groupId" : "string",
  "artifactId" : "string",
  "versionCount" : 0
}

3.5.5. Get bundle versions

GET /bundles/{bundleId}/versions
Description

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.
Parameters
Type Name Description Schema

Path

bundleId
required

The extension bundle identifier

string
Responses
HTTP Code Description Schema

200

successful operation

< BundleVersionMetadata > array

400

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

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/bundles/string/versions
Example HTTP response
Response 200
[ {
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "id" : "string",
  "bundleId" : "string",
  "bucketId" : "string",
  "groupId" : "string",
  "artifactId" : "string",
  "version" : "string",
  "timestamp" : 0,
  "author" : "string",
  "description" : "string",
  "sha256" : "string",
  "sha256Supplied" : true,
  "contentSize" : 0,
  "systemApiVersion" : "string",
  "buildInfo" : {
    "buildTool" : "string",
    "buildFlags" : "string",
    "buildBranch" : "string",
    "buildTag" : "string",
    "buildRevision" : "string",
    "built" : 0,
    "builtBy" : "string"
  }
} ]

3.5.6. Get bundle version

GET /bundles/{bundleId}/versions/{version}
Description

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.
Parameters
Type Name Description Schema

Path

bundleId
required

The extension bundle identifier

string

Path

version
required

The version of the bundle

string
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/bundles/string/versions/string
Example HTTP response
Response 200
{
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "versionMetadata" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "id" : "string",
    "bundleId" : "string",
    "bucketId" : "string",
    "groupId" : "string",
    "artifactId" : "string",
    "version" : "string",
    "timestamp" : 0,
    "author" : "string",
    "description" : "string",
    "sha256" : "string",
    "sha256Supplied" : true,
    "contentSize" : 0,
    "systemApiVersion" : "string",
    "buildInfo" : {
      "buildTool" : "string",
      "buildFlags" : "string",
      "buildBranch" : "string",
      "buildTag" : "string",
      "buildRevision" : "string",
      "built" : 0,
      "builtBy" : "string"
    }
  },
  "dependencies" : [ {
    "groupId" : "string",
    "artifactId" : "string",
    "version" : "string"
  } ],
  "bundle" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "identifier" : "string",
    "name" : "string",
    "description" : "string",
    "bucketIdentifier" : "string",
    "bucketName" : "string",
    "createdTimestamp" : 0,
    "modifiedTimestamp" : 0,
    "type" : "string",
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "bundleType" : "string",
    "groupId" : "string",
    "artifactId" : "string",
    "versionCount" : 0
  },
  "bucket" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "identifier" : "string",
    "name" : "string",
    "createdTimestamp" : 0,
    "description" : "string",
    "allowBundleRedeploy" : true,
    "allowPublicRead" : true,
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  },
  "filename" : "string"
}

3.5.7. Delete bundle version

DELETE /bundles/{bundleId}/versions/{version}
Description

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.
Parameters
Type Name Description Schema

Path

bundleId
required

The extension bundle identifier

string

Path

version
required

The version of the bundle

string
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/bundles/string/versions/string
Example HTTP response
Response 200
{
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "versionMetadata" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "id" : "string",
    "bundleId" : "string",
    "bucketId" : "string",
    "groupId" : "string",
    "artifactId" : "string",
    "version" : "string",
    "timestamp" : 0,
    "author" : "string",
    "description" : "string",
    "sha256" : "string",
    "sha256Supplied" : true,
    "contentSize" : 0,
    "systemApiVersion" : "string",
    "buildInfo" : {
      "buildTool" : "string",
      "buildFlags" : "string",
      "buildBranch" : "string",
      "buildTag" : "string",
      "buildRevision" : "string",
      "built" : 0,
      "builtBy" : "string"
    }
  },
  "dependencies" : [ {
    "groupId" : "string",
    "artifactId" : "string",
    "version" : "string"
  } ],
  "bundle" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "identifier" : "string",
    "name" : "string",
    "description" : "string",
    "bucketIdentifier" : "string",
    "bucketName" : "string",
    "createdTimestamp" : 0,
    "modifiedTimestamp" : 0,
    "type" : "string",
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "bundleType" : "string",
    "groupId" : "string",
    "artifactId" : "string",
    "versionCount" : 0
  },
  "bucket" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "identifier" : "string",
    "name" : "string",
    "createdTimestamp" : 0,
    "description" : "string",
    "allowBundleRedeploy" : true,
    "allowPublicRead" : true,
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  },
  "filename" : "string"
}

3.5.8. Get bundle version content

GET /bundles/{bundleId}/versions/{version}/content
Description

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.
Parameters
Type Name Description Schema

Path

bundleId
required

The extension bundle identifier

string

Path

version
required

The version of the bundle

string
Responses
HTTP Code Description Schema

200

successful operation

< string (byte) > array

400

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

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/octet-stream

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/bundles/string/versions/string/content
Example HTTP response
Response 200
[ "string" ]

3.5.9. Get bundle version extensions

GET /bundles/{bundleId}/versions/{version}/extensions
Description

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.
Parameters
Type Name Description Schema

Path

bundleId
required

The extension bundle identifier

string

Path

version
required

The version of the bundle

string
Responses
HTTP Code Description Schema

200

successful operation

< ExtensionMetadata > array

400

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

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/bundles/string/versions/string/extensions
Example HTTP response
Response 200
[ {
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "name" : "string",
  "displayName" : "string",
  "type" : "string",
  "description" : "string",
  "deprecationNotice" : {
    "reason" : "string",
    "alternatives" : [ "string" ]
  },
  "tags" : [ "string" ],
  "restricted" : {
    "generalRestrictionExplanation" : "string",
    "restrictions" : [ {
      "requiredPermission" : "string",
      "explanation" : "string"
    } ]
  },
  "providedServiceAPIs" : [ {
    "className" : "string",
    "groupId" : "string",
    "artifactId" : "string",
    "version" : "string"
  } ],
  "bundleInfo" : {
    "bucketId" : "string",
    "bucketName" : "string",
    "bundleId" : "string",
    "bundleType" : "string",
    "groupId" : "string",
    "artifactId" : "string",
    "version" : "string",
    "systemApiVersion" : "string"
  },
  "hasAdditionalDetails" : true,
  "linkDocs" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  }
} ]

3.5.10. Get bundle version extension

GET /bundles/{bundleId}/versions/{version}/extensions/{name}
Description

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.
Parameters
Type Name Description Schema

Path

bundleId
required

The extension bundle identifier

string

Path

name
required

The fully qualified name of the extension

string

Path

version
required

The version of the bundle

string
Responses
HTTP Code Description Schema

200

successful operation

< Extension > array

400

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

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/bundles/string/versions/string/extensions/string
Example HTTP response
Response 200
[ {
  "name" : "string",
  "type" : "string",
  "deprecationNotice" : {
    "reason" : "string",
    "alternatives" : [ "string" ]
  },
  "description" : "string",
  "tags" : [ "string" ],
  "properties" : [ {
    "name" : "string",
    "displayName" : "string",
    "description" : "string",
    "defaultValue" : "string",
    "controllerServiceDefinition" : {
      "className" : "string",
      "groupId" : "string",
      "artifactId" : "string",
      "version" : "string"
    },
    "allowableValues" : [ {
      "value" : "string",
      "displayName" : "string",
      "description" : "string"
    } ],
    "required" : true,
    "sensitive" : true,
    "expressionLanguageSupported" : true,
    "expressionLanguageScope" : "string",
    "dynamicallyModifiesClasspath" : true,
    "dynamic" : true
  } ],
  "dynamicProperties" : [ {
    "name" : "string",
    "value" : "string",
    "description" : "string",
    "expressionLanguageScope" : "string",
    "expressionLanguageSupported" : true
  } ],
  "relationships" : [ {
    "name" : "string",
    "description" : "string",
    "autoTerminated" : true
  } ],
  "dynamicRelationship" : {
    "name" : "string",
    "description" : "string"
  },
  "readsAttributes" : [ {
    "name" : "string",
    "description" : "string"
  } ],
  "writesAttributes" : [ {
    "name" : "string",
    "description" : "string"
  } ],
  "stateful" : {
    "description" : "string",
    "scopes" : [ "string" ]
  },
  "restricted" : {
    "generalRestrictionExplanation" : "string",
    "restrictions" : [ {
      "requiredPermission" : "string",
      "explanation" : "string"
    } ]
  },
  "inputRequirement" : "string",
  "systemResourceConsiderations" : [ {
    "resource" : "string",
    "description" : "string"
  } ],
  "seeAlso" : [ "string" ],
  "providedServiceAPIs" : [ {
    "className" : "string",
    "groupId" : "string",
    "artifactId" : "string",
    "version" : "string"
  } ]
} ]

3.5.11. Get bundle version extension docs

GET /bundles/{bundleId}/versions/{version}/extensions/{name}/docs
Description

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.
Parameters
Type Name Description Schema

Path

bundleId
required

The extension bundle identifier

string

Path

name
required

The fully qualified name of the extension

string

Path

version
required

The version of the bundle

string
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • text/html

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/bundles/string/versions/string/extensions/string/docs
Example HTTP response
Response 200
"string"

3.5.12. Get bundle version extension docs details

GET /bundles/{bundleId}/versions/{version}/extensions/{name}/docs/additional-details
Description

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.
Parameters
Type Name Description Schema

Path

bundleId
required

The extension bundle identifier

string

Path

name
required

The fully qualified name of the extension

string

Path

version
required

The version of the bundle

string
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • text/html

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/bundles/string/versions/string/extensions/string/docs/additional-details
Example HTTP response
Response 200
"string"

3.6. Config

Retrieves the configuration for this NiFi Registry.

3.6.1. Get configration

GET /config
Description

Gets the NiFi Registry configurations.

Responses
HTTP Code Description Schema

200

successful operation

RegistryConfiguration

401

Client could not be authenticated.

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/config
Example HTTP response
Response 200
{
  "supportsManagedAuthorizer" : true,
  "supportsConfigurableAuthorizer" : true,
  "supportsConfigurableUsersAndGroups" : true
}

3.7. Extension Repository

Interact with extension bundles via the hierarchy of bucket/group/artifact/version.

3.7.1. Get extension repo buckets

GET /extension-repository
Description

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.
Responses
HTTP Code Description Schema

200

successful operation

< ExtensionRepoBucket > array

400

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

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/extension-repository
Example HTTP response
Response 200
[ {
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "bucketName" : "string"
} ]

3.7.2. Get extension repo groups

GET /extension-repository/{bucketName}
Description

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.
Parameters
Type Name Description Schema

Path

bucketName
required

The bucket name

string
Responses
HTTP Code Description Schema

200

successful operation

< ExtensionRepoGroup > array

400

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

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/extension-repository/string
Example HTTP response
Response 200
[ {
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "bucketName" : "string",
  "groupId" : "string"
} ]

3.7.3. Get extension repo artifacts

GET /extension-repository/{bucketName}/{groupId}
Description

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.
Parameters
Type Name Description Schema

Path

bucketName
required

The bucket name

string

Path

groupId
required

The group id

string
Responses
HTTP Code Description Schema

200

successful operation

< ExtensionRepoArtifact > array

400

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

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/extension-repository/string/string
Example HTTP response
Response 200
[ {
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "bucketName" : "string",
  "groupId" : "string",
  "artifactId" : "string"
} ]

3.7.4. Get extension repo versions

GET /extension-repository/{bucketName}/{groupId}/{artifactId}
Description

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.
Parameters
Type Name Description Schema

Path

artifactId
required

The artifact identifier

string

Path

bucketName
required

The bucket name

string

Path

groupId
required

The group identifier

string
Responses
HTTP Code Description Schema

200

successful operation

< ExtensionRepoVersionSummary > array

400

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

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/extension-repository/string/string/string
Example HTTP response
Response 200
[ {
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "bucketName" : "string",
  "groupId" : "string",
  "artifactId" : "string",
  "version" : "string",
  "author" : "string",
  "timestamp" : 0
} ]

3.7.5. Get extension repo version

GET /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}
Description

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.
Parameters
Type Name Description Schema

Path

artifactId
required

The artifact identifier

string

Path

bucketName
required

The bucket name

string

Path

groupId
required

The group identifier

string

Path

version
required

The version

string
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/extension-repository/string/string/string/string
Example HTTP response
Response 200
{
  "extensionsLink" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "downloadLink" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "sha256Link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "sha256Supplied" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  }
}

3.7.6. Get extension repo version content

GET /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/content
Description

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.
Parameters
Type Name Description Schema

Path

artifactId
required

The artifact identifier

string

Path

bucketName
required

The bucket name

string

Path

groupId
required

The group identifier

string

Path

version
required

The version

string
Responses
HTTP Code Description Schema

200

successful operation

< string (byte) > array

400

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

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/octet-stream

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/extension-repository/string/string/string/string/content
Example HTTP response
Response 200
[ "string" ]

3.7.7. Get extension repo extensions

GET /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions
Description

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.
Parameters
Type Name Description Schema

Path

artifactId
required

The artifact identifier

string

Path

bucketName
required

The bucket name

string

Path

groupId
required

The group identifier

string

Path

version
required

The version

string
Responses
HTTP Code Description Schema

200

successful operation

< ExtensionMetadata > array

400

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

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/extension-repository/string/string/string/string/extensions
Example HTTP response
Response 200
[ {
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "name" : "string",
  "displayName" : "string",
  "type" : "string",
  "description" : "string",
  "deprecationNotice" : {
    "reason" : "string",
    "alternatives" : [ "string" ]
  },
  "tags" : [ "string" ],
  "restricted" : {
    "generalRestrictionExplanation" : "string",
    "restrictions" : [ {
      "requiredPermission" : "string",
      "explanation" : "string"
    } ]
  },
  "providedServiceAPIs" : [ {
    "className" : "string",
    "groupId" : "string",
    "artifactId" : "string",
    "version" : "string"
  } ],
  "bundleInfo" : {
    "bucketId" : "string",
    "bucketName" : "string",
    "bundleId" : "string",
    "bundleType" : "string",
    "groupId" : "string",
    "artifactId" : "string",
    "version" : "string",
    "systemApiVersion" : "string"
  },
  "hasAdditionalDetails" : true,
  "linkDocs" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  }
} ]

3.7.8. Get extension repo extension

GET /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}
Description

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.
Parameters
Type Name Description Schema

Path

artifactId
required

The artifact identifier

string

Path

bucketName
required

The bucket name

string

Path

groupId
required

The group identifier

string

Path

name
required

The fully qualified name of the extension

string

Path

version
required

The version

string
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/extension-repository/string/string/string/string/extensions/string
Example HTTP response
Response 200
{
  "name" : "string",
  "type" : "string",
  "deprecationNotice" : {
    "reason" : "string",
    "alternatives" : [ "string" ]
  },
  "description" : "string",
  "tags" : [ "string" ],
  "properties" : [ {
    "name" : "string",
    "displayName" : "string",
    "description" : "string",
    "defaultValue" : "string",
    "controllerServiceDefinition" : {
      "className" : "string",
      "groupId" : "string",
      "artifactId" : "string",
      "version" : "string"
    },
    "allowableValues" : [ {
      "value" : "string",
      "displayName" : "string",
      "description" : "string"
    } ],
    "required" : true,
    "sensitive" : true,
    "expressionLanguageSupported" : true,
    "expressionLanguageScope" : "string",
    "dynamicallyModifiesClasspath" : true,
    "dynamic" : true
  } ],
  "dynamicProperties" : [ {
    "name" : "string",
    "value" : "string",
    "description" : "string",
    "expressionLanguageScope" : "string",
    "expressionLanguageSupported" : true
  } ],
  "relationships" : [ {
    "name" : "string",
    "description" : "string",
    "autoTerminated" : true
  } ],
  "dynamicRelationship" : {
    "name" : "string",
    "description" : "string"
  },
  "readsAttributes" : [ {
    "name" : "string",
    "description" : "string"
  } ],
  "writesAttributes" : [ {
    "name" : "string",
    "description" : "string"
  } ],
  "stateful" : {
    "description" : "string",
    "scopes" : [ "string" ]
  },
  "restricted" : {
    "generalRestrictionExplanation" : "string",
    "restrictions" : [ {
      "requiredPermission" : "string",
      "explanation" : "string"
    } ]
  },
  "inputRequirement" : "string",
  "systemResourceConsiderations" : [ {
    "resource" : "string",
    "description" : "string"
  } ],
  "seeAlso" : [ "string" ],
  "providedServiceAPIs" : [ {
    "className" : "string",
    "groupId" : "string",
    "artifactId" : "string",
    "version" : "string"
  } ]
}

3.7.9. Get extension repo extension docs

GET /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs
Description

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.
Parameters
Type Name Description Schema

Path

artifactId
required

The artifact identifier

string

Path

bucketName
required

The bucket name

string

Path

groupId
required

The group identifier

string

Path

name
required

The fully qualified name of the extension

string

Path

version
required

The version

string
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • text/html

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/extension-repository/string/string/string/string/extensions/string/docs
Example HTTP response
Response 200
"string"

3.7.10. Get extension repo extension details

GET /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/extensions/{name}/docs/additional-details
Description

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.
Parameters
Type Name Description Schema

Path

artifactId
required

The artifact identifier

string

Path

bucketName
required

The bucket name

string

Path

groupId
required

The group identifier

string

Path

name
required

The fully qualified name of the extension

string

Path

version
required

The version

string
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • text/html

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/extension-repository/string/string/string/string/extensions/string/docs/additional-details
Example HTTP response
Response 200
"string"

3.7.11. Get extension repo version checksum

GET /extension-repository/{bucketName}/{groupId}/{artifactId}/{version}/sha256
Description

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.
Parameters
Type Name Description Schema

Path

artifactId
required

The artifact identifier

string

Path

bucketName
required

The bucket name

string

Path

groupId
required

The group identifier

string

Path

version
required

The version

string
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • text/plain

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/extension-repository/string/string/string/string/sha256
Example HTTP response
Response 200
"string"

3.7.12. Get global extension repo version checksum

GET /extension-repository/{groupId}/{artifactId}/{version}/sha256
Description

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.
Parameters
Type Name Description Schema

Path

artifactId
required

The artifact identifier

string

Path

groupId
required

The group identifier

string

Path

version
required

The version

string
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • text/plain

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/extension-repository/string/string/string/sha256
Example HTTP response
Response 200
"string"

3.8. Extensions

Find and retrieve extensions.

3.8.1. Get all extensions

GET /extensions
Description

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.
Parameters
Type Name Description Schema

Query

bundleType
optional

The type of bundles to return

enum (nifi-nar, minifi-cpp)

Query

extensionType
optional

The type of extensions to return

enum (PROCESSOR, CONTROLLER_SERVICE, REPORTING_TASK)

Query

tag
optional

The tags to filter on, will be used in an OR statement

< string > array(multi)
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/extensions
Request query
{
  "bundleType" : "string",
  "extensionType" : "string",
  "tag" : "string"
}
Example HTTP response
Response 200
{
  "numResults" : 0,
  "filterParams" : {
    "bundleType" : "string",
    "extensionType" : "string",
    "tags" : [ "string" ]
  },
  "extensions" : [ {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "name" : "string",
    "displayName" : "string",
    "type" : "string",
    "description" : "string",
    "deprecationNotice" : {
      "reason" : "string",
      "alternatives" : [ "string" ]
    },
    "tags" : [ "string" ],
    "restricted" : {
      "generalRestrictionExplanation" : "string",
      "restrictions" : [ {
        "requiredPermission" : "string",
        "explanation" : "string"
      } ]
    },
    "providedServiceAPIs" : [ {
      "className" : "string",
      "groupId" : "string",
      "artifactId" : "string",
      "version" : "string"
    } ],
    "bundleInfo" : {
      "bucketId" : "string",
      "bucketName" : "string",
      "bundleId" : "string",
      "bundleType" : "string",
      "groupId" : "string",
      "artifactId" : "string",
      "version" : "string",
      "systemApiVersion" : "string"
    },
    "hasAdditionalDetails" : true,
    "linkDocs" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    }
  } ]
}

3.8.2. Get extensions providing service API

GET /extensions/provided-service-api
Description

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.
Parameters
Type Name Description Schema

Query

artifactId
required

The artifactId of the bundle containing the service API class

string

Query

className
required

The name of the service API class

string

Query

groupId
required

The groupId of the bundle containing the service API class

string

Query

version
required

The version of the bundle containing the service API class

string
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/extensions/provided-service-api
Request query
{
  "artifactId" : "string",
  "className" : "string",
  "groupId" : "string",
  "version" : "string"
}
Example HTTP response
Response 200
{
  "numResults" : 0,
  "filterParams" : {
    "bundleType" : "string",
    "extensionType" : "string",
    "tags" : [ "string" ]
  },
  "extensions" : [ {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "name" : "string",
    "displayName" : "string",
    "type" : "string",
    "description" : "string",
    "deprecationNotice" : {
      "reason" : "string",
      "alternatives" : [ "string" ]
    },
    "tags" : [ "string" ],
    "restricted" : {
      "generalRestrictionExplanation" : "string",
      "restrictions" : [ {
        "requiredPermission" : "string",
        "explanation" : "string"
      } ]
    },
    "providedServiceAPIs" : [ {
      "className" : "string",
      "groupId" : "string",
      "artifactId" : "string",
      "version" : "string"
    } ],
    "bundleInfo" : {
      "bucketId" : "string",
      "bucketName" : "string",
      "bundleId" : "string",
      "bundleType" : "string",
      "groupId" : "string",
      "artifactId" : "string",
      "version" : "string",
      "systemApiVersion" : "string"
    },
    "hasAdditionalDetails" : true,
    "linkDocs" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    }
  } ]
}

3.8.3. Get extension tags

GET /extensions/tags
Description

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.
Responses
HTTP Code Description Schema

200

successful operation

< TagCount > array

400

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

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/extensions/tags
Example HTTP response
Response 200
[ {
  "tag" : "string",
  "count" : 0
} ]

3.9. Flows

Gets metadata about flows.

3.9.1. Get flow fields

GET /flows/fields
Description

Retrieves the flow field names that can be used for searching or sorting on flows.

Responses
HTTP Code Description Schema

200

successful operation

Fields
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/flows/fields
Example HTTP response
Response 200
{
  "fields" : [ "string" ]
}

3.9.2. Get flow

GET /flows/{flowId}
Description

Gets a flow by id.

Parameters
Type Name Description Schema

Path

flowId
required

The flow identifier

string
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/flows/string
Example HTTP response
Response 200
{
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "identifier" : "string",
  "name" : "string",
  "description" : "string",
  "bucketIdentifier" : "string",
  "bucketName" : "string",
  "createdTimestamp" : 0,
  "modifiedTimestamp" : 0,
  "type" : "string",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  },
  "versionCount" : 0,
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  }
}

3.9.3. Get flow versions

GET /flows/{flowId}/versions
Description

Gets summary information for all versions of a given flow. Versions are ordered newest->oldest.

Parameters
Type Name Description Schema

Path

flowId
required

The flow identifier

string
Responses
HTTP Code Description Schema

200

successful operation

< VersionedFlowSnapshotMetadata > array

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/flows/string/versions
Example HTTP response
Response 200
[ {
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "bucketIdentifier" : "string",
  "flowIdentifier" : "string",
  "version" : 0,
  "timestamp" : 0,
  "author" : "string",
  "comments" : "string"
} ]

3.9.4. Get latest flow version

GET /flows/{flowId}/versions/latest
Description

Gets the latest version of a flow, including metadata and flow content.

Parameters
Type Name Description Schema

Path

flowId
required

The flow identifier

string
Responses
HTTP Code Description Schema

200

successful operation

VersionedFlowSnapshot

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/flows/string/versions/latest
Example HTTP response
Response 200
{
  "snapshotMetadata" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "bucketIdentifier" : "string",
    "flowIdentifier" : "string",
    "version" : 0,
    "timestamp" : 0,
    "author" : "string",
    "comments" : "string"
  },
  "flowContents" : {
    "identifier" : "string",
    "name" : "string",
    "comments" : "string",
    "position" : {
      "x" : 0.0,
      "y" : 0.0
    },
    "processGroups" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "processGroups" : [ "..." ],
      "remoteProcessGroups" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "targetUri" : "string",
        "targetUris" : "string",
        "communicationsTimeout" : "string",
        "yieldDuration" : "string",
        "transportProtocol" : "string",
        "localNetworkInterface" : "string",
        "proxyHost" : "string",
        "proxyPort" : 0,
        "proxyUser" : "string",
        "inputPorts" : [ {
          "identifier" : "string",
          "name" : "string",
          "comments" : "string",
          "position" : {
            "x" : 0.0,
            "y" : 0.0
          },
          "remoteGroupId" : "string",
          "concurrentlySchedulableTaskCount" : 0,
          "useCompression" : true,
          "batchSize" : {
            "count" : 0,
            "size" : "string",
            "duration" : "string"
          },
          "componentType" : "string",
          "targetId" : "string",
          "scheduledState" : "string",
          "groupIdentifier" : "string"
        } ],
        "outputPorts" : [ {
          "identifier" : "string",
          "name" : "string",
          "comments" : "string",
          "position" : {
            "x" : 0.0,
            "y" : 0.0
          },
          "remoteGroupId" : "string",
          "concurrentlySchedulableTaskCount" : 0,
          "useCompression" : true,
          "batchSize" : {
            "count" : 0,
            "size" : "string",
            "duration" : "string"
          },
          "componentType" : "string",
          "targetId" : "string",
          "scheduledState" : "string",
          "groupIdentifier" : "string"
        } ],
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "processors" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "bundle" : {
          "group" : "string",
          "artifact" : "string",
          "version" : "string"
        },
        "style" : {
          "string" : "string"
        },
        "type" : "string",
        "properties" : {
          "string" : "string"
        },
        "propertyDescriptors" : {
          "string" : "<<_versionedpropertydescriptor>>"
        },
        "annotationData" : "string",
        "schedulingPeriod" : "string",
        "schedulingStrategy" : "string",
        "executionNode" : "string",
        "penaltyDuration" : "string",
        "yieldDuration" : "string",
        "bulletinLevel" : "string",
        "runDurationMillis" : 0,
        "concurrentlySchedulableTaskCount" : 0,
        "autoTerminatedRelationships" : [ "string" ],
        "scheduledState" : "string",
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "inputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "type" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "scheduledState" : "string",
        "allowRemoteAccess" : true,
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "outputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "type" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "scheduledState" : "string",
        "allowRemoteAccess" : true,
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "connections" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "source" : {
          "id" : "string",
          "type" : "string",
          "groupId" : "string",
          "name" : "string",
          "comments" : "string"
        },
        "destination" : {
          "id" : "string",
          "type" : "string",
          "groupId" : "string",
          "name" : "string",
          "comments" : "string"
        },
        "labelIndex" : 0,
        "zIndex" : 0,
        "selectedRelationships" : [ "string" ],
        "backPressureObjectThreshold" : 0,
        "backPressureDataSizeThreshold" : "string",
        "flowFileExpiration" : "string",
        "prioritizers" : [ "string" ],
        "bends" : [ {
          "x" : 0.0,
          "y" : 0.0
        } ],
        "loadBalanceStrategy" : "string",
        "partitioningAttribute" : "string",
        "loadBalanceCompression" : "string",
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "labels" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "label" : "string",
        "width" : 0.0,
        "height" : 0.0,
        "style" : {
          "string" : "string"
        },
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "funnels" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "controllerServices" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "type" : "string",
        "bundle" : {
          "group" : "string",
          "artifact" : "string",
          "version" : "string"
        },
        "controllerServiceApis" : [ {
          "type" : "string",
          "bundle" : {
            "group" : "string",
            "artifact" : "string",
            "version" : "string"
          }
        } ],
        "properties" : {
          "string" : "string"
        },
        "propertyDescriptors" : {
          "string" : "<<_versionedpropertydescriptor>>"
        },
        "annotationData" : "string",
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "versionedFlowCoordinates" : {
        "registryUrl" : "string",
        "bucketId" : "string",
        "flowId" : "string",
        "version" : 0,
        "latest" : true
      },
      "variables" : {
        "string" : "string"
      },
      "parameterContextName" : "string",
      "componentType" : "string",
      "flowFileConcurrency" : "string",
      "flowFileOutboundPolicy" : "string",
      "groupIdentifier" : "string"
    } ],
    "remoteProcessGroups" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "targetUri" : "string",
      "targetUris" : "string",
      "communicationsTimeout" : "string",
      "yieldDuration" : "string",
      "transportProtocol" : "string",
      "localNetworkInterface" : "string",
      "proxyHost" : "string",
      "proxyPort" : 0,
      "proxyUser" : "string",
      "inputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "remoteGroupId" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "useCompression" : true,
        "batchSize" : {
          "count" : 0,
          "size" : "string",
          "duration" : "string"
        },
        "componentType" : "string",
        "targetId" : "string",
        "scheduledState" : "string",
        "groupIdentifier" : "string"
      } ],
      "outputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "remoteGroupId" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "useCompression" : true,
        "batchSize" : {
          "count" : 0,
          "size" : "string",
          "duration" : "string"
        },
        "componentType" : "string",
        "targetId" : "string",
        "scheduledState" : "string",
        "groupIdentifier" : "string"
      } ],
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "processors" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "bundle" : {
        "group" : "string",
        "artifact" : "string",
        "version" : "string"
      },
      "style" : {
        "string" : "string"
      },
      "type" : "string",
      "properties" : {
        "string" : "string"
      },
      "propertyDescriptors" : {
        "string" : "<<_versionedpropertydescriptor>>"
      },
      "annotationData" : "string",
      "schedulingPeriod" : "string",
      "schedulingStrategy" : "string",
      "executionNode" : "string",
      "penaltyDuration" : "string",
      "yieldDuration" : "string",
      "bulletinLevel" : "string",
      "runDurationMillis" : 0,
      "concurrentlySchedulableTaskCount" : 0,
      "autoTerminatedRelationships" : [ "string" ],
      "scheduledState" : "string",
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "inputPorts" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "type" : "string",
      "concurrentlySchedulableTaskCount" : 0,
      "scheduledState" : "string",
      "allowRemoteAccess" : true,
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "outputPorts" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "type" : "string",
      "concurrentlySchedulableTaskCount" : 0,
      "scheduledState" : "string",
      "allowRemoteAccess" : true,
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "connections" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "source" : {
        "id" : "string",
        "type" : "string",
        "groupId" : "string",
        "name" : "string",
        "comments" : "string"
      },
      "destination" : {
        "id" : "string",
        "type" : "string",
        "groupId" : "string",
        "name" : "string",
        "comments" : "string"
      },
      "labelIndex" : 0,
      "zIndex" : 0,
      "selectedRelationships" : [ "string" ],
      "backPressureObjectThreshold" : 0,
      "backPressureDataSizeThreshold" : "string",
      "flowFileExpiration" : "string",
      "prioritizers" : [ "string" ],
      "bends" : [ {
        "x" : 0.0,
        "y" : 0.0
      } ],
      "loadBalanceStrategy" : "string",
      "partitioningAttribute" : "string",
      "loadBalanceCompression" : "string",
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "labels" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "label" : "string",
      "width" : 0.0,
      "height" : 0.0,
      "style" : {
        "string" : "string"
      },
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "funnels" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "controllerServices" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "type" : "string",
      "bundle" : {
        "group" : "string",
        "artifact" : "string",
        "version" : "string"
      },
      "controllerServiceApis" : [ {
        "type" : "string",
        "bundle" : {
          "group" : "string",
          "artifact" : "string",
          "version" : "string"
        }
      } ],
      "properties" : {
        "string" : "string"
      },
      "propertyDescriptors" : {
        "string" : "<<_versionedpropertydescriptor>>"
      },
      "annotationData" : "string",
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "versionedFlowCoordinates" : {
      "registryUrl" : "string",
      "bucketId" : "string",
      "flowId" : "string",
      "version" : 0,
      "latest" : true
    },
    "variables" : {
      "string" : "string"
    },
    "parameterContextName" : "string",
    "componentType" : "string",
    "flowFileConcurrency" : "string",
    "flowFileOutboundPolicy" : "string",
    "groupIdentifier" : "string"
  },
  "externalControllerServices" : {
    "string" : "<<_externalcontrollerservicereference>>"
  },
  "parameterContexts" : {
    "string" : "<<_versionedparametercontext>>"
  },
  "flowEncodingVersion" : "string",
  "flow" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "identifier" : "string",
    "name" : "string",
    "description" : "string",
    "bucketIdentifier" : "string",
    "bucketName" : "string",
    "createdTimestamp" : 0,
    "modifiedTimestamp" : 0,
    "type" : "string",
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "versionCount" : 0,
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  },
  "bucket" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "identifier" : "string",
    "name" : "string",
    "createdTimestamp" : 0,
    "description" : "string",
    "allowBundleRedeploy" : true,
    "allowPublicRead" : true,
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  },
  "latest" : true
}

3.9.5. Get latest flow version metadata

GET /flows/{flowId}/versions/latest/metadata
Description

Gets the metadata for the latest version of a flow.

Parameters
Type Name Description Schema

Path

flowId
required

The flow identifier

string
Responses
HTTP Code Description Schema

200

successful operation

VersionedFlowSnapshotMetadata

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/flows/string/versions/latest/metadata
Example HTTP response
Response 200
{
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "bucketIdentifier" : "string",
  "flowIdentifier" : "string",
  "version" : 0,
  "timestamp" : 0,
  "author" : "string",
  "comments" : "string"
}

3.9.6. Get flow version

GET /flows/{flowId}/versions/{versionNumber}
Description

Gets the given version of a flow, including metadata and flow content.

Parameters
Type Name Description Schema

Path

flowId
required

The flow identifier

string

Path

versionNumber
required

The version number

integer (int32)
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/flows/string/versions/0
Example HTTP response
Response 200
{
  "snapshotMetadata" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "bucketIdentifier" : "string",
    "flowIdentifier" : "string",
    "version" : 0,
    "timestamp" : 0,
    "author" : "string",
    "comments" : "string"
  },
  "flowContents" : {
    "identifier" : "string",
    "name" : "string",
    "comments" : "string",
    "position" : {
      "x" : 0.0,
      "y" : 0.0
    },
    "processGroups" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "processGroups" : [ "..." ],
      "remoteProcessGroups" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "targetUri" : "string",
        "targetUris" : "string",
        "communicationsTimeout" : "string",
        "yieldDuration" : "string",
        "transportProtocol" : "string",
        "localNetworkInterface" : "string",
        "proxyHost" : "string",
        "proxyPort" : 0,
        "proxyUser" : "string",
        "inputPorts" : [ {
          "identifier" : "string",
          "name" : "string",
          "comments" : "string",
          "position" : {
            "x" : 0.0,
            "y" : 0.0
          },
          "remoteGroupId" : "string",
          "concurrentlySchedulableTaskCount" : 0,
          "useCompression" : true,
          "batchSize" : {
            "count" : 0,
            "size" : "string",
            "duration" : "string"
          },
          "componentType" : "string",
          "targetId" : "string",
          "scheduledState" : "string",
          "groupIdentifier" : "string"
        } ],
        "outputPorts" : [ {
          "identifier" : "string",
          "name" : "string",
          "comments" : "string",
          "position" : {
            "x" : 0.0,
            "y" : 0.0
          },
          "remoteGroupId" : "string",
          "concurrentlySchedulableTaskCount" : 0,
          "useCompression" : true,
          "batchSize" : {
            "count" : 0,
            "size" : "string",
            "duration" : "string"
          },
          "componentType" : "string",
          "targetId" : "string",
          "scheduledState" : "string",
          "groupIdentifier" : "string"
        } ],
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "processors" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "bundle" : {
          "group" : "string",
          "artifact" : "string",
          "version" : "string"
        },
        "style" : {
          "string" : "string"
        },
        "type" : "string",
        "properties" : {
          "string" : "string"
        },
        "propertyDescriptors" : {
          "string" : "<<_versionedpropertydescriptor>>"
        },
        "annotationData" : "string",
        "schedulingPeriod" : "string",
        "schedulingStrategy" : "string",
        "executionNode" : "string",
        "penaltyDuration" : "string",
        "yieldDuration" : "string",
        "bulletinLevel" : "string",
        "runDurationMillis" : 0,
        "concurrentlySchedulableTaskCount" : 0,
        "autoTerminatedRelationships" : [ "string" ],
        "scheduledState" : "string",
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "inputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "type" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "scheduledState" : "string",
        "allowRemoteAccess" : true,
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "outputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "type" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "scheduledState" : "string",
        "allowRemoteAccess" : true,
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "connections" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "source" : {
          "id" : "string",
          "type" : "string",
          "groupId" : "string",
          "name" : "string",
          "comments" : "string"
        },
        "destination" : {
          "id" : "string",
          "type" : "string",
          "groupId" : "string",
          "name" : "string",
          "comments" : "string"
        },
        "labelIndex" : 0,
        "zIndex" : 0,
        "selectedRelationships" : [ "string" ],
        "backPressureObjectThreshold" : 0,
        "backPressureDataSizeThreshold" : "string",
        "flowFileExpiration" : "string",
        "prioritizers" : [ "string" ],
        "bends" : [ {
          "x" : 0.0,
          "y" : 0.0
        } ],
        "loadBalanceStrategy" : "string",
        "partitioningAttribute" : "string",
        "loadBalanceCompression" : "string",
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "labels" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "label" : "string",
        "width" : 0.0,
        "height" : 0.0,
        "style" : {
          "string" : "string"
        },
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "funnels" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "controllerServices" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "type" : "string",
        "bundle" : {
          "group" : "string",
          "artifact" : "string",
          "version" : "string"
        },
        "controllerServiceApis" : [ {
          "type" : "string",
          "bundle" : {
            "group" : "string",
            "artifact" : "string",
            "version" : "string"
          }
        } ],
        "properties" : {
          "string" : "string"
        },
        "propertyDescriptors" : {
          "string" : "<<_versionedpropertydescriptor>>"
        },
        "annotationData" : "string",
        "componentType" : "string",
        "groupIdentifier" : "string"
      } ],
      "versionedFlowCoordinates" : {
        "registryUrl" : "string",
        "bucketId" : "string",
        "flowId" : "string",
        "version" : 0,
        "latest" : true
      },
      "variables" : {
        "string" : "string"
      },
      "parameterContextName" : "string",
      "componentType" : "string",
      "flowFileConcurrency" : "string",
      "flowFileOutboundPolicy" : "string",
      "groupIdentifier" : "string"
    } ],
    "remoteProcessGroups" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "targetUri" : "string",
      "targetUris" : "string",
      "communicationsTimeout" : "string",
      "yieldDuration" : "string",
      "transportProtocol" : "string",
      "localNetworkInterface" : "string",
      "proxyHost" : "string",
      "proxyPort" : 0,
      "proxyUser" : "string",
      "inputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "remoteGroupId" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "useCompression" : true,
        "batchSize" : {
          "count" : 0,
          "size" : "string",
          "duration" : "string"
        },
        "componentType" : "string",
        "targetId" : "string",
        "scheduledState" : "string",
        "groupIdentifier" : "string"
      } ],
      "outputPorts" : [ {
        "identifier" : "string",
        "name" : "string",
        "comments" : "string",
        "position" : {
          "x" : 0.0,
          "y" : 0.0
        },
        "remoteGroupId" : "string",
        "concurrentlySchedulableTaskCount" : 0,
        "useCompression" : true,
        "batchSize" : {
          "count" : 0,
          "size" : "string",
          "duration" : "string"
        },
        "componentType" : "string",
        "targetId" : "string",
        "scheduledState" : "string",
        "groupIdentifier" : "string"
      } ],
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "processors" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "bundle" : {
        "group" : "string",
        "artifact" : "string",
        "version" : "string"
      },
      "style" : {
        "string" : "string"
      },
      "type" : "string",
      "properties" : {
        "string" : "string"
      },
      "propertyDescriptors" : {
        "string" : "<<_versionedpropertydescriptor>>"
      },
      "annotationData" : "string",
      "schedulingPeriod" : "string",
      "schedulingStrategy" : "string",
      "executionNode" : "string",
      "penaltyDuration" : "string",
      "yieldDuration" : "string",
      "bulletinLevel" : "string",
      "runDurationMillis" : 0,
      "concurrentlySchedulableTaskCount" : 0,
      "autoTerminatedRelationships" : [ "string" ],
      "scheduledState" : "string",
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "inputPorts" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "type" : "string",
      "concurrentlySchedulableTaskCount" : 0,
      "scheduledState" : "string",
      "allowRemoteAccess" : true,
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "outputPorts" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "type" : "string",
      "concurrentlySchedulableTaskCount" : 0,
      "scheduledState" : "string",
      "allowRemoteAccess" : true,
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "connections" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "source" : {
        "id" : "string",
        "type" : "string",
        "groupId" : "string",
        "name" : "string",
        "comments" : "string"
      },
      "destination" : {
        "id" : "string",
        "type" : "string",
        "groupId" : "string",
        "name" : "string",
        "comments" : "string"
      },
      "labelIndex" : 0,
      "zIndex" : 0,
      "selectedRelationships" : [ "string" ],
      "backPressureObjectThreshold" : 0,
      "backPressureDataSizeThreshold" : "string",
      "flowFileExpiration" : "string",
      "prioritizers" : [ "string" ],
      "bends" : [ {
        "x" : 0.0,
        "y" : 0.0
      } ],
      "loadBalanceStrategy" : "string",
      "partitioningAttribute" : "string",
      "loadBalanceCompression" : "string",
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "labels" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "label" : "string",
      "width" : 0.0,
      "height" : 0.0,
      "style" : {
        "string" : "string"
      },
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "funnels" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "controllerServices" : [ {
      "identifier" : "string",
      "name" : "string",
      "comments" : "string",
      "position" : {
        "x" : 0.0,
        "y" : 0.0
      },
      "type" : "string",
      "bundle" : {
        "group" : "string",
        "artifact" : "string",
        "version" : "string"
      },
      "controllerServiceApis" : [ {
        "type" : "string",
        "bundle" : {
          "group" : "string",
          "artifact" : "string",
          "version" : "string"
        }
      } ],
      "properties" : {
        "string" : "string"
      },
      "propertyDescriptors" : {
        "string" : "<<_versionedpropertydescriptor>>"
      },
      "annotationData" : "string",
      "componentType" : "string",
      "groupIdentifier" : "string"
    } ],
    "versionedFlowCoordinates" : {
      "registryUrl" : "string",
      "bucketId" : "string",
      "flowId" : "string",
      "version" : 0,
      "latest" : true
    },
    "variables" : {
      "string" : "string"
    },
    "parameterContextName" : "string",
    "componentType" : "string",
    "flowFileConcurrency" : "string",
    "flowFileOutboundPolicy" : "string",
    "groupIdentifier" : "string"
  },
  "externalControllerServices" : {
    "string" : "<<_externalcontrollerservicereference>>"
  },
  "parameterContexts" : {
    "string" : "<<_versionedparametercontext>>"
  },
  "flowEncodingVersion" : "string",
  "flow" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "identifier" : "string",
    "name" : "string",
    "description" : "string",
    "bucketIdentifier" : "string",
    "bucketName" : "string",
    "createdTimestamp" : 0,
    "modifiedTimestamp" : 0,
    "type" : "string",
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "versionCount" : 0,
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  },
  "bucket" : {
    "link" : {
      "href" : "string",
      "params" : {
        "string" : "string"
      }
    },
    "identifier" : "string",
    "name" : "string",
    "createdTimestamp" : 0,
    "description" : "string",
    "allowBundleRedeploy" : true,
    "allowPublicRead" : true,
    "permissions" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  },
  "latest" : true
}

3.10. Items

Retrieve items across all buckets for which the user is authorized.

3.10.1. Get all items

GET /items
Description

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.

Responses
HTTP Code Description Schema

200

successful operation

< BucketItem > array

401

Client could not be authenticated.

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/items
Example HTTP response
Response 200
[ {
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "identifier" : "string",
  "name" : "string",
  "description" : "string",
  "bucketIdentifier" : "string",
  "bucketName" : "string",
  "createdTimestamp" : 0,
  "modifiedTimestamp" : 0,
  "type" : "string",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  }
} ]

3.10.2. Get item fields

GET /items/fields
Description

Retrieves the item field names for searching or sorting on bucket items.

Responses
HTTP Code Description Schema

200

successful operation

Fields
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/items/fields
Example HTTP response
Response 200
{
  "fields" : [ "string" ]
}

3.10.3. Get bucket items

GET /items/{bucketId}
Description

Gets the items located in the given bucket.

Parameters
Type Name Description Schema

Path

bucketId
required

The bucket identifier

string
Responses
HTTP Code Description Schema

200

successful operation

< BucketItem > array

400

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

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/items/string
Example HTTP response
Response 200
[ {
  "link" : {
    "href" : "string",
    "params" : {
      "string" : "string"
    }
  },
  "identifier" : "string",
  "name" : "string",
  "description" : "string",
  "bucketIdentifier" : "string",
  "bucketName" : "string",
  "createdTimestamp" : 0,
  "modifiedTimestamp" : 0,
  "type" : "string",
  "permissions" : {
    "canRead" : true,
    "canWrite" : true,
    "canDelete" : true
  }
} ]

3.11. Policies

Endpoint for managing access policies.

3.11.1. Create access policy

POST /policies
Parameters
Type Name Description Schema

Body

body
required

The access policy configuration details.

AccessPolicy
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

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.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/policies
Request body
{
  "identifier" : "string",
  "resource" : "string",
  "action" : "string",
  "configurable" : true,
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  },
  "users" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ],
  "userGroups" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ]
}
Example HTTP response
Response 200
{
  "identifier" : "string",
  "resource" : "string",
  "action" : "string",
  "configurable" : true,
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  },
  "users" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ],
  "userGroups" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ]
}

3.11.2. Get all access policies

GET /policies
Responses
HTTP Code Description Schema

200

successful operation

< AccessPolicy > array

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/policies
Example HTTP response
Response 200
[ {
  "identifier" : "string",
  "resource" : "string",
  "action" : "string",
  "configurable" : true,
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  },
  "users" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ],
  "userGroups" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ]
} ]

3.11.3. Get available resources

GET /policies/resources
Description

Gets the available resources that support access/authorization policies

Responses
HTTP Code Description Schema

200

successful operation

< Resource > array

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/policies/resources
Example HTTP response
Response 200
[ {
  "identifier" : "string",
  "name" : "string"
} ]

3.11.4. Get access policy for resource

GET /policies/{action}/{resource}
Description

Gets an access policy for the specified action and resource

Parameters
Type Name Description Schema

Path

action
required

The request action.

enum (read, write, delete)

Path

resource
required

The resource of the policy.

string
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/policies/string/string
Example HTTP response
Response 200
{
  "identifier" : "string",
  "resource" : "string",
  "action" : "string",
  "configurable" : true,
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  },
  "users" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ],
  "userGroups" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ]
}

3.11.5. Get access policy

GET /policies/{id}
Parameters
Type Name Description Schema

Path

id
required

The access policy id.

string
Responses
HTTP Code Description Schema

200

successful operation

AccessPolicy

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/policies/string
Example HTTP response
Response 200
{
  "identifier" : "string",
  "resource" : "string",
  "action" : "string",
  "configurable" : true,
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  },
  "users" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ],
  "userGroups" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ]
}

3.11.6. Update access policy

PUT /policies/{id}
Parameters
Type Name Description Schema

Path

id
required

The access policy id.

string

Body

body
required

The access policy configuration details.

AccessPolicy
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

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.

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/policies/string
Request body
{
  "identifier" : "string",
  "resource" : "string",
  "action" : "string",
  "configurable" : true,
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  },
  "users" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ],
  "userGroups" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ]
}
Example HTTP response
Response 200
{
  "identifier" : "string",
  "resource" : "string",
  "action" : "string",
  "configurable" : true,
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  },
  "users" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ],
  "userGroups" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ]
}

3.11.7. Delete access policy

DELETE /policies/{id}
Parameters
Type Name Description Schema

Path

id
required

The access policy id.

string

Query

clientId
optional

If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

string

Query

version
required

The version is used to verify the client is working with the latest version of the entity.

string
Responses
HTTP Code Description Schema

200

successful operation

AccessPolicy

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

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.

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/policies/string
Request query
{
  "clientId" : "string",
  "version" : "string"
}
Example HTTP response
Response 200
{
  "identifier" : "string",
  "resource" : "string",
  "action" : "string",
  "configurable" : true,
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  },
  "users" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ],
  "userGroups" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ]
}

3.12. Tenants

Endpoint for managing users and user groups.

3.12.1. Create user group

POST /tenants/user-groups
Description
Note
 This endpoint is subject to change as NiFi Registry and its REST API evolve.
Parameters
Type Name Description Schema

Body

body
required

The user group configuration details.

UserGroup
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/tenants/user-groups
Request body
{
  "identifier" : "string",
  "identity" : "string",
  "configurable" : true,
  "resourcePermissions" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "tenants" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "policies" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "proxy" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "anyTopLevelResource" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "string",
    "resource" : "string",
    "action" : "string",
    "configurable" : true,
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ],
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  },
  "users" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ]
}
Example HTTP response
Response 200
{
  "identifier" : "string",
  "identity" : "string",
  "configurable" : true,
  "resourcePermissions" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "tenants" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "policies" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "proxy" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "anyTopLevelResource" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "string",
    "resource" : "string",
    "action" : "string",
    "configurable" : true,
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ],
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  },
  "users" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ]
}

3.12.2. Get user groups

GET /tenants/user-groups
Description
Note
 This endpoint is subject to change as NiFi Registry and its REST API evolve.
Responses
HTTP Code Description Schema

200

successful operation

< UserGroup > array

400

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

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/tenants/user-groups
Example HTTP response
Response 200
[ {
  "identifier" : "string",
  "identity" : "string",
  "configurable" : true,
  "resourcePermissions" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "tenants" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "policies" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "proxy" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "anyTopLevelResource" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "string",
    "resource" : "string",
    "action" : "string",
    "configurable" : true,
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ],
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  },
  "users" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ]
} ]

3.12.3. Get user group

GET /tenants/user-groups/{id}
Description
Note
 This endpoint is subject to change as NiFi Registry and its REST API evolve.
Parameters
Type Name Description Schema

Path

id
required

The user group id.

string
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/tenants/user-groups/string
Example HTTP response
Response 200
{
  "identifier" : "string",
  "identity" : "string",
  "configurable" : true,
  "resourcePermissions" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "tenants" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "policies" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "proxy" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "anyTopLevelResource" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "string",
    "resource" : "string",
    "action" : "string",
    "configurable" : true,
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ],
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  },
  "users" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ]
}

3.12.4. Update user group

PUT /tenants/user-groups/{id}
Description
Note
 This endpoint is subject to change as NiFi Registry and its REST API evolve.
Parameters
Type Name Description Schema

Path

id
required

The user group id.

string

Body

body
required

The user group configuration details.

UserGroup
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/tenants/user-groups/string
Request body
{
  "identifier" : "string",
  "identity" : "string",
  "configurable" : true,
  "resourcePermissions" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "tenants" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "policies" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "proxy" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "anyTopLevelResource" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "string",
    "resource" : "string",
    "action" : "string",
    "configurable" : true,
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ],
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  },
  "users" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ]
}
Example HTTP response
Response 200
{
  "identifier" : "string",
  "identity" : "string",
  "configurable" : true,
  "resourcePermissions" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "tenants" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "policies" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "proxy" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "anyTopLevelResource" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "string",
    "resource" : "string",
    "action" : "string",
    "configurable" : true,
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ],
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  },
  "users" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ]
}

3.12.5. Delete user group

DELETE /tenants/user-groups/{id}
Description
Note
 This endpoint is subject to change as NiFi Registry and its REST API evolve.
Parameters
Type Name Description Schema

Path

id
required

The user group id.

string

Query

clientId
optional

If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

string

Query

version
required

The version is used to verify the client is working with the latest version of the entity.

string
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/tenants/user-groups/string
Request query
{
  "clientId" : "string",
  "version" : "string"
}
Example HTTP response
Response 200
{
  "identifier" : "string",
  "identity" : "string",
  "configurable" : true,
  "resourcePermissions" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "tenants" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "policies" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "proxy" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "anyTopLevelResource" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "string",
    "resource" : "string",
    "action" : "string",
    "configurable" : true,
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ],
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  },
  "users" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ]
}

3.12.6. Create user

POST /tenants/users
Description
Note
 This endpoint is subject to change as NiFi Registry and its REST API evolve.
Parameters
Type Name Description Schema

Body

body
required

The user configuration details.

User
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/tenants/users
Request body
{
  "identifier" : "string",
  "identity" : "string",
  "configurable" : true,
  "resourcePermissions" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "tenants" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "policies" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "proxy" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "anyTopLevelResource" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "string",
    "resource" : "string",
    "action" : "string",
    "configurable" : true,
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ],
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  },
  "userGroups" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ]
}
Example HTTP response
Response 200
{
  "identifier" : "string",
  "identity" : "string",
  "configurable" : true,
  "resourcePermissions" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "tenants" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "policies" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "proxy" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "anyTopLevelResource" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "string",
    "resource" : "string",
    "action" : "string",
    "configurable" : true,
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ],
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  },
  "userGroups" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ]
}

3.12.7. Get all users

GET /tenants/users
Description
Note
 This endpoint is subject to change as NiFi Registry and its REST API evolve.
Responses
HTTP Code Description Schema

200

successful operation

< User > array

400

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

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/tenants/users
Example HTTP response
Response 200
[ {
  "identifier" : "string",
  "identity" : "string",
  "configurable" : true,
  "resourcePermissions" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "tenants" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "policies" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "proxy" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "anyTopLevelResource" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "string",
    "resource" : "string",
    "action" : "string",
    "configurable" : true,
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ],
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  },
  "userGroups" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ]
} ]

3.12.8. Get user

GET /tenants/users/{id}
Description
Note
 This endpoint is subject to change as NiFi Registry and its REST API evolve.
Parameters
Type Name Description Schema

Path

id
required

The user id.

string
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/tenants/users/string
Example HTTP response
Response 200
{
  "identifier" : "string",
  "identity" : "string",
  "configurable" : true,
  "resourcePermissions" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "tenants" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "policies" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "proxy" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "anyTopLevelResource" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "string",
    "resource" : "string",
    "action" : "string",
    "configurable" : true,
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ],
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  },
  "userGroups" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ]
}

3.12.9. Update user

PUT /tenants/users/{id}
Description
Note
 This endpoint is subject to change as NiFi Registry and its REST API evolve.
Parameters
Type Name Description Schema

Path

id
required

The user id.

string

Body

body
required

The user configuration details.

User
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/tenants/users/string
Request body
{
  "identifier" : "string",
  "identity" : "string",
  "configurable" : true,
  "resourcePermissions" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "tenants" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "policies" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "proxy" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "anyTopLevelResource" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "string",
    "resource" : "string",
    "action" : "string",
    "configurable" : true,
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ],
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  },
  "userGroups" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ]
}
Example HTTP response
Response 200
{
  "identifier" : "string",
  "identity" : "string",
  "configurable" : true,
  "resourcePermissions" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "tenants" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "policies" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "proxy" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "anyTopLevelResource" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "string",
    "resource" : "string",
    "action" : "string",
    "configurable" : true,
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ],
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  },
  "userGroups" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ]
}

3.12.10. Delete user

DELETE /tenants/users/{id}
Description
Note
 This endpoint is subject to change as NiFi Registry and its REST API evolve.
Parameters
Type Name Description Schema

Path

id
required

The user id.

string

Query

clientId
optional

If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

string

Query

version
required

The version is used to verify the client is working with the latest version of the entity.

string
Responses
HTTP Code Description Schema

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.

No Content

401

Client could not be authenticated.

No Content

403

Client is not authorized to make this request.

No Content

404

The specified resource could not be found.

No Content

409

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

No Content
Consumes

  • /

Produces

  • application/json

Security
Type Name

apiKey

Authorization
Example HTTP request
Request path
/tenants/users/string
Request query
{
  "clientId" : "string",
  "version" : "string"
}
Example HTTP response
Response 200
{
  "identifier" : "string",
  "identity" : "string",
  "configurable" : true,
  "resourcePermissions" : {
    "buckets" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "tenants" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "policies" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "proxy" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    },
    "anyTopLevelResource" : {
      "canRead" : true,
      "canWrite" : true,
      "canDelete" : true
    }
  },
  "accessPolicies" : [ {
    "identifier" : "string",
    "resource" : "string",
    "action" : "string",
    "configurable" : true,
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ],
  "revision" : {
    "clientId" : "string",
    "version" : 0,
    "lastModifier" : "string"
  },
  "userGroups" : [ {
    "identifier" : "string",
    "identity" : "string",
    "configurable" : true,
    "resourcePermissions" : {
      "buckets" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "tenants" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "policies" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "proxy" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      },
      "anyTopLevelResource" : {
        "canRead" : true,
        "canWrite" : true,
        "canDelete" : true
      }
    },
    "accessPolicies" : [ {
      "identifier" : "string",
      "resource" : "string",
      "action" : "string",
      "configurable" : true,
      "revision" : {
        "clientId" : "string",
        "version" : 0,
        "lastModifier" : "string"
      }
    } ],
    "revision" : {
      "clientId" : "string",
      "version" : 0,
      "lastModifier" : "string"
    }
  } ]
}

4. Definitions

4.1. AccessPolicy

Name Description Schema

action
required

The action associated with this access policy.
Example : "string"

enum (read, write, delete)

configurable
optional
read-only

Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.
Example : true

boolean

identifier
optional
read-only

The id of the policy. Set by server at creation time.
Example : "string"

string

resource
required

The resource for this access policy.
Example : "string"

string

revision
optional

The revision of this entity used for optimistic-locking during updates.
Example : "RevisionInfo"

RevisionInfo

userGroups
optional

The set of user group IDs associated with this access policy.
Example : [ "Tenant" ]

< Tenant > array

users
optional

The set of user IDs associated with this access policy.
Example : [ "Tenant" ]

< Tenant > array

4.2. AccessPolicySummary

Name Description Schema

action
required

The action associated with this access policy.
Example : "string"

enum (read, write, delete)

configurable
optional
read-only

Indicates if this access policy is configurable, based on which Authorizer has been configured to manage it.
Example : true

boolean

identifier
optional
read-only

The id of the policy. Set by server at creation time.
Example : "string"

string

resource
required

The resource for this access policy.
Example : "string"

string

revision
optional

The revision of this entity used for optimistic-locking during updates.
Example : "RevisionInfo"

RevisionInfo

4.3. AllowableValue

Name Description Schema

description
optional

The description of the allowable value
Example : "string"

string

displayName
optional

The display name of the allowable value
Example : "string"

string

value
optional

The value of the allowable value
Example : "string"

string

4.4. Attribute

Name Description Schema

description
optional

The description of the attribute
Example : "string"

string

name
optional

The name of the attribute
Example : "string"

string

4.5. BatchSize

Name Description Schema

count
optional

Preferred number of flow files to include in a transaction.
Example : 0

integer (int32)

duration
optional

Preferred amount of time that a transaction should span.
Example : "string"

string

size
optional

Preferred number of bytes to include in a transaction.
Example : "string"

string

4.6. Bucket

Name Description Schema

allowBundleRedeploy
optional

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.
Example : true

boolean

allowPublicRead
optional

Indicates if this bucket allows read access to unauthenticated anonymous users
Example : true

boolean

createdTimestamp
optional
read-only

The timestamp of when the bucket was first created. This is set by the server at creation time.
Minimum value : 1
Example : 0

integer (int64)

description
optional

A description of the bucket.
Example : "string"

string

identifier
optional
read-only

An ID to uniquely identify this object.
Example : "string"

string

link
optional

An WebLink to this entity.
Example : "JaxbLink"

JaxbLink

name
required

The name of the bucket.
Example : "string"

string

permissions
optional

The access that the current user has to this bucket.
Example : "Permissions"

Permissions

revision
optional

The revision of this entity used for optimistic-locking during updates.
Example : "RevisionInfo"

RevisionInfo

4.7. BucketItem

Name Description Schema

bucketIdentifier
required

The identifier of the bucket this items belongs to. This cannot be changed after the item is created.
Example : "string"

string

bucketName
optional
read-only

The name of the bucket this items belongs to.
Example : "string"

string

createdTimestamp
optional
read-only

The timestamp of when the item was created, as milliseconds since epoch.
Minimum value : 1
Example : 0

integer (int64)

description
optional

A description of the item.
Example : "string"

string

identifier
optional
read-only

An ID to uniquely identify this object.
Example : "string"

string

link
optional

An WebLink to this entity.
Example : "JaxbLink"

JaxbLink

modifiedTimestamp
optional
read-only

The timestamp of when the item was last modified, as milliseconds since epoch.
Minimum value : 1
Example : 0

integer (int64)

name
required

The name of the item.
Example : "string"

string

permissions
optional

The access that the current user has to the bucket containing this item.
Example : "Permissions"

Permissions

type
required

The type of item.
Example : "string"

enum (Flow, Bundle)

4.8. BuildInfo

Name Description Schema

buildBranch
optional

The branch used to build the version of the bundle
Example : "string"

string

buildFlags
optional

The flags used to build the version of the bundle
Example : "string"

string

buildRevision
optional

The revision used to build the version of the bundle
Example : "string"

string

buildTag
optional

The tag used to build the version of the bundle
Example : "string"

string

buildTool
optional

The tool used to build the version of the bundle
Example : "string"

string

built
optional

The timestamp the version of the bundle was built
Example : 0

integer (int64)

builtBy
optional

The identity of the user that performed the build
Example : "string"

string

4.9. Bundle

Name Description Schema

artifact
optional

The artifact of the bundle
Example : "string"

string

group
optional

The group of the bundle
Example : "string"

string

version
optional

The version of the bundle
Example : "string"

string

4.10. BundleInfo

Name Description Schema

artifactId
optional

The artifact id of the bundle
Example : "string"

string

bucketId
optional

The id of the bucket where the bundle is located
Example : "string"

string

bucketName
optional

The name of the bucket where the bundle is located
Example : "string"

string

bundleId
optional

The id of the bundle
Example : "string"

string

bundleType
optional

The type of bundle (i.e. a NiFi NAR vs MiNiFi CPP)
Example : "string"

enum (NIFI_NAR, MINIFI_CPP)

groupId
optional

The group id of the bundle
Example : "string"

string

systemApiVersion
optional

The version of the system API the bundle was built against
Example : "string"

string

version
optional

The version of the bundle
Example : "string"

string

4.11. BundleVersion

Name Description Schema

bucket
optional

The bucket that the extension bundle belongs to
Example : "Bucket"

Bucket

bundle
optional

The bundle this version is for
Example : "ExtensionBundle"

ExtensionBundle

dependencies
optional

The set of other bundle versions that this version is dependent on
Example : [ "BundleVersionDependency" ]

< BundleVersionDependency > array

filename
optional

Example : "string"

string

link
optional

An WebLink to this entity.
Example : "JaxbLink"

JaxbLink

versionMetadata
required

The metadata about this version of the extension bundle
Example : "BundleVersionMetadata"

BundleVersionMetadata

4.12. BundleVersionDependency

Name Description Schema

artifactId
optional

The artifact id of the bundle dependency
Example : "string"

string

groupId
optional

The group id of the bundle dependency
Example : "string"

string

version
optional

The version of the bundle dependency
Example : "string"

string

4.13. BundleVersionMetadata

Name Description Schema

artifactId
optional

Example : "string"

string

author
optional

The identity that created this version
Example : "string"

string

bucketId
required

The id of the bucket the extension bundle belongs to
Example : "string"

string

buildInfo
required

The build information about this version
Example : "BuildInfo"

BuildInfo

bundleId
optional

The id of the extension bundle this version is for
Example : "string"

string

contentSize
required

The size of the binary content for this version in bytes
Minimum value : 0
Example : 0

integer (int64)

description
optional

The description for this version
Example : "string"

string

groupId
optional

Example : "string"

string

id
optional

The id of this version of the extension bundle
Example : "string"

string

link
optional

An WebLink to this entity.
Example : "JaxbLink"

JaxbLink

sha256
optional

The hex representation of the SHA-256 digest of the binary content for this version
Example : "string"

string

sha256Supplied
required

Whether or not the client supplied a SHA-256 when uploading the bundle
Example : true

boolean

systemApiVersion
optional

The version of the system API that this bundle version was built against
Example : "string"

string

timestamp
optional

The timestamp of the create date of this version
Minimum value : 1
Example : 0

integer (int64)

version
optional

The version of the extension bundle
Example : "string"

string

4.14. ComponentDifference

Name Description Schema

changeDescription
optional

The description of the change.
Example : "string"

string

differenceType
optional

The key to the difference.
Example : "string"

string

differenceTypeDescription
optional

The description of the change type.
Example : "string"

string

valueA
optional

The earlier value from the difference.
Example : "string"

string

valueB
optional

The newer value from the difference.
Example : "string"

string

4.15. ComponentDifferenceGroup

Name Description Schema

componentId
optional

The id of the component whose changes are grouped together.
Example : "string"

string

componentName
optional

The name of the component whose changes are grouped together.
Example : "string"

string

componentType
optional

The type of component these changes relate to.
Example : "string"

string

differences
optional

The list of changes related to this component between the 2 versions.
Example : [ "ComponentDifference" ]

< ComponentDifference > array

processGroupId
optional

The process group id for this component.
Example : "string"

string

4.16. ConnectableComponent

Name Description Schema

comments
optional

The comments for the connectable component.
Example : "string"

string

groupId
required

The id of the group that the connectable component resides in
Example : "string"

string

id
required

The id of the connectable component.
Example : "string"

string

name
optional

The name of the connectable component
Example : "string"

string

type
required

The type of component the connectable is.
Example : "string"

enum (PROCESSOR, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, INPUT_PORT, OUTPUT_PORT, FUNNEL)

4.17. ControllerServiceAPI

Name Description Schema

bundle
optional

The details of the artifact that bundled this service interface.
Example : "Bundle"

Bundle

type
optional

The fully qualified name of the service interface.
Example : "string"

string

4.18. ControllerServiceDefinition

Name Description Schema

artifactId
optional

The artifact id of the service API
Example : "string"

string

className
optional

The class name of the service API
Example : "string"

string

groupId
optional

The group id of the service API
Example : "string"

string

version
optional

The version of the service API
Example : "string"

string

4.19. CurrentUser

Name Description Schema

anonymous
optional
read-only

Indicates if the current user is anonymous
Example : true

boolean

identity
optional
read-only

The identity of the current user
Example : "string"

string

loginSupported
optional

Indicates if the NiFi Registry instance supports logging in
Example : true

boolean

oidcloginSupported
optional

Indicates if the NiFi Registry instance supports logging in with an OIDC provider
Example : true

boolean

resourcePermissions
optional

The access that the current user has to top level resources
Example : "ResourcePermissions"

ResourcePermissions

4.20. DeprecationNotice

Name Description Schema

alternatives
optional

The alternatives to use
Example : [ "string" ]

< string > array

reason
optional

The reason for the deprecation
Example : "string"

string

4.21. DynamicProperty

Name Description Schema

description
optional

The description of the dynamic property
Example : "string"

string

expressionLanguageScope
optional

The scope of the expression language support
Example : "string"

enum (NONE, VARIABLE_REGISTRY, FLOWFILE_ATTRIBUTES)

expressionLanguageSupported
optional

Whether or not expression language is supported
Example : true

boolean

name
optional

The description of the dynamic property name
Example : "string"

string

value
optional

The description of the dynamic property value
Example : "string"

string

4.22. DynamicRelationship

Name Description Schema

description
optional

The description of the dynamic relationship
Example : "string"

string

name
optional

The description of the dynamic relationship name
Example : "string"

string

4.23. Extension

Name Description Schema

deprecationNotice
optional

The deprecation notice of the extension
Example : "DeprecationNotice"

DeprecationNotice

description
optional

The description of the extension
Example : "string"

string

dynamicProperties
optional

The dynamic properties of the extension
Example : [ "DynamicProperty" ]

< DynamicProperty > array

dynamicRelationship
optional

The dynamic relationships of the extension
Example : "DynamicRelationship"

DynamicRelationship

inputRequirement
optional

The input requirement of the extension
Example : "string"

enum (INPUT_REQUIRED, INPUT_ALLOWED, INPUT_FORBIDDEN)

name
optional

The name of the extension
Example : "string"

string

properties
optional

The properties of the extension
Example : [ "Property" ]

< Property > array

providedServiceAPIs
optional

The service APIs provided by this extension
Example : [ "ProvidedServiceAPI" ]

< ProvidedServiceAPI > array

readsAttributes
optional

The attributes read from flow files by the extension
Example : [ "Attribute" ]

< Attribute > array

relationships
optional

The relationships of the extension
Example : [ "Relationship" ]

< Relationship > array

restricted
optional

The restrictions of the extension
Example : "Restricted"

Restricted

seeAlso
optional

The names of other extensions to see
Example : [ "string" ]

< string > array

stateful
optional

The information about how the extension stores state
Example : "Stateful"

Stateful

systemResourceConsiderations
optional

The resource considerations of the extension
Example : [ "SystemResourceConsideration" ]

< SystemResourceConsideration > array

tags
optional

The tags of the extension
Example : [ "string" ]

< string > array

type
optional

The type of the extension
Example : "string"

enum (PROCESSOR, CONTROLLER_SERVICE, REPORTING_TASK)

writesAttributes
optional

The attributes written to flow files by the extension
Example : [ "Attribute" ]

< Attribute > array

4.24. ExtensionBundle

Name Description Schema

artifactId
optional

The artifact id of the extension bundle
Example : "string"

string

bucketIdentifier
required

The identifier of the bucket this items belongs to. This cannot be changed after the item is created.
Example : "string"

string

bucketName
optional
read-only

The name of the bucket this items belongs to.
Example : "string"

string

bundleType
required

The type of the extension bundle
Example : "string"

enum (NIFI_NAR, MINIFI_CPP)

createdTimestamp
optional
read-only

The timestamp of when the item was created, as milliseconds since epoch.
Minimum value : 1
Example : 0

integer (int64)

description
optional

A description of the item.
Example : "string"

string

groupId
optional

The group id of the extension bundle
Example : "string"

string

identifier
optional
read-only

An ID to uniquely identify this object.
Example : "string"

string

link
optional

An WebLink to this entity.
Example : "JaxbLink"

JaxbLink

modifiedTimestamp
optional
read-only

The timestamp of when the item was last modified, as milliseconds since epoch.
Minimum value : 1
Example : 0

integer (int64)

name
required

The name of the item.
Example : "string"

string

permissions
optional

The access that the current user has to the bucket containing this item.
Example : "Permissions"

Permissions

type
required

The type of item.
Example : "string"

enum (Flow, Bundle)

versionCount
optional
read-only

The number of versions of this extension bundle.
Minimum value : 0
Example : 0

integer (int64)

4.25. ExtensionFilterParams

Name Description Schema

bundleType
optional

The type of bundle
Example : "string"

enum (NIFI_NAR, MINIFI_CPP)

extensionType
optional

The type of extension
Example : "string"

enum (PROCESSOR, CONTROLLER_SERVICE, REPORTING_TASK)

tags
optional

The tags
Example : [ "string" ]

< string > array

4.26. ExtensionMetadata

Name Description Schema

bundleInfo
optional

The information for the bundle where this extension is located
Example : "BundleInfo"

BundleInfo

deprecationNotice
optional

The deprecation notice of the extension
Example : "DeprecationNotice"

DeprecationNotice

description
optional

The description of the extension
Example : "string"

string

displayName
optional

The display name of the extension
Example : "string"

string

hasAdditionalDetails
optional

Whether or not the extension has additional detail documentation
Example : true

boolean

link
optional

An WebLink to this entity.
Example : "JaxbLink"

JaxbLink

linkDocs
optional

A WebLink to the documentation for this extension.
Example : "JaxbLink"

JaxbLink

name
optional

The name of the extension
Example : "string"

string

providedServiceAPIs
optional

The service APIs provided by the extension
Example : [ "ProvidedServiceAPI" ]

< ProvidedServiceAPI > array

restricted
optional

The restrictions of the extension
Example : "Restricted"

Restricted

tags
optional

The tags of the extension
Example : [ "string" ]

< string > array

type
optional

The type of the extension
Example : "string"

enum (PROCESSOR, CONTROLLER_SERVICE, REPORTING_TASK)

4.27. ExtensionMetadataContainer

Name Description Schema

extensions
optional

The metadata for the extensions
Example : [ "ExtensionMetadata" ]

< ExtensionMetadata > array

filterParams
optional

The filter parameters submitted for the request
Example : "ExtensionFilterParams"

ExtensionFilterParams

numResults
optional

The number of extensions in the response
Example : 0

integer (int32)

4.28. ExtensionRepoArtifact

Name Description Schema

artifactId
optional

The artifact id
Example : "string"

string

bucketName
optional

The bucket name
Example : "string"

string

groupId
optional

The group id
Example : "string"

string

link
optional

An WebLink to this entity.
Example : "JaxbLink"

JaxbLink

4.29. ExtensionRepoBucket

Name Description Schema

bucketName
optional

The name of the bucket
Example : "string"

string

link
optional

An WebLink to this entity.
Example : "JaxbLink"

JaxbLink

4.30. ExtensionRepoGroup

Name Description Schema

bucketName
optional

The bucket name
Example : "string"

string

groupId
optional

The group id
Example : "string"

string

link
optional

An WebLink to this entity.
Example : "JaxbLink"

JaxbLink

4.31. ExtensionRepoVersion

Name Description Schema

downloadLink
optional

The WebLink to download this version of the extension bundle.
Example : "JaxbLink"

JaxbLink

extensionsLink
optional

The WebLink to view the metadata about the extensions contained in the extension bundle.
Example : "JaxbLink"

JaxbLink

sha256Link
optional

The WebLink to retrieve the SHA-256 digest for this version of the extension bundle.
Example : "JaxbLink"

JaxbLink

sha256Supplied
optional

Indicates if the client supplied a SHA-256 when uploading this version of the extension bundle.
Example : "JaxbLink"

JaxbLink

4.32. ExtensionRepoVersionSummary

Name Description Schema

artifactId
optional

The artifact id
Example : "string"

string

author
optional

The identity of the user that created this version
Example : "string"

string

bucketName
optional

The bucket name
Example : "string"

string

groupId
optional

The group id
Example : "string"

string

link
optional

An WebLink to this entity.
Example : "JaxbLink"

JaxbLink

timestamp
optional

The timestamp of when this version was created
Example : 0

integer (int64)

version
optional

The version
Example : "string"

string

4.33. ExternalControllerServiceReference

Name Description Schema

identifier
optional

The identifier of the controller service
Example : "string"

string

name
optional

The name of the controller service
Example : "string"

string

4.34. Fields

Name Description Schema

fields
optional

Example : [ "string" ]

< string > array

4.35. JaxbLink

Name Description Schema

href
optional

The href for the link
Example : "string"

string (uri)

params
optional

The params for the link
Example : {
"string" : "string"
}

< string, string > map

4.36. Permissions

Name Description Schema

canDelete
optional
read-only

Indicates whether the user can delete a given resource.
Example : true

boolean

canRead
optional
read-only

Indicates whether the user can read a given resource.
Example : true

boolean

canWrite
optional
read-only

Indicates whether the user can write a given resource.
Example : true

boolean

4.37. Position

The position of a component on the graph

Name Description Schema

x
optional

The x coordinate.
Example : 0.0

number (double)

y
optional

The y coordinate.
Example : 0.0

number (double)

4.38. Property

Name Description Schema

allowableValues
optional

The allowable values for this property
Example : [ "AllowableValue" ]

< AllowableValue > array

controllerServiceDefinition
optional

The controller service required by this property, or null if none is required
Example : "ControllerServiceDefinition"

ControllerServiceDefinition

defaultValue
optional

The default value
Example : "string"

string

description
optional

The description
Example : "string"

string

displayName
optional

The display name
Example : "string"

string

dynamic
optional

Whether or not the processor is dynamic
Example : true

boolean

dynamicallyModifiesClasspath
optional

Whether or not the processor dynamically modifies the classpath
Example : true

boolean

expressionLanguageScope
optional

The scope of expression language support
Example : "string"

enum (NONE, VARIABLE_REGISTRY, FLOWFILE_ATTRIBUTES)

expressionLanguageSupported
optional

Whether or not expression language is supported
Example : true

boolean

name
optional

The name of the property
Example : "string"

string

required
optional

Whether or not the property is required
Example : true

boolean

sensitive
optional

Whether or not the property is sensitive
Example : true

boolean

4.39. ProvidedServiceAPI

Name Description Schema

artifactId
optional

The artifact id of the service API being provided
Example : "string"

string

className
optional

The class name of the service API being provided
Example : "string"

string

groupId
optional

The group id of the service API being provided
Example : "string"

string

version
optional

The version of the service API being provided
Example : "string"

string

4.40. RegistryConfiguration

Name Description Schema

supportsConfigurableAuthorizer
optional
read-only

Whether this NiFi Registry supports a configurable authorizer.
Example : true

boolean

supportsConfigurableUsersAndGroups
optional
read-only

Whether this NiFi Registry supports configurable users and groups.
Example : true

boolean

supportsManagedAuthorizer
optional
read-only

Whether this NiFi Registry supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.
Example : true

boolean

4.41. Relationship

Name Description Schema

autoTerminated
optional

Whether or not the relationship is auto-terminated by default
Example : true

boolean

description
optional

The description of the relationship
Example : "string"

string

name
optional

The name of the relationship
Example : "string"

string

4.42. Resource

Name Description Schema

identifier
optional
read-only

The identifier of the resource.
Example : "string"

string

name
optional
read-only

The name of the resource.
Example : "string"

string

4.43. ResourcePermissions

Name Description Schema

anyTopLevelResource
optional

The access that the current user has to any top level resources (a logical 'OR' of all other values)
Example : "Permissions"

Permissions

buckets
optional

The access that the current user has to the top level /buckets resource of this NiFi Registry (i.e., access to all buckets)
Example : "Permissions"

Permissions

policies
optional

The access that the current user has to the top level /policies resource of this NiFi Registry
Example : "Permissions"

Permissions

proxy
optional

The access that the current user has to the top level /proxy resource of this NiFi Registry
Example : "Permissions"

Permissions

tenants
optional

The access that the current user has to the top level /tenants resource of this NiFi Registry
Example : "Permissions"

Permissions

4.44. Restricted

Name Description Schema

generalRestrictionExplanation
optional

The general restriction for the extension, or null if only specific restrictions exist
Example : "string"

string

restrictions
optional

The specific restrictions
Example : [ "Restriction" ]

< Restriction > array

4.45. Restriction

Name Description Schema

explanation
optional

The explanation of this restriction
Example : "string"

string

requiredPermission
optional

The permission required for this restriction
Example : "string"

string

4.46. RevisionInfo

The revision information for an entity managed through the REST API.

Name Description Schema

clientId
optional

A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back.
Example : "string"

string

lastModifier
optional
read-only

The user that last modified the entity.
Example : "string"

string

version
optional

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.
Example : 0

integer (int64)

4.47. Stateful

Name Description Schema

description
optional

The description for how the extension stores state
Example : "string"

string

scopes
optional

The scopes used to store state
Example : [ "string" ]

< enum (CLUSTER, LOCAL) > array

4.48. SystemResourceConsideration

Name Description Schema

description
optional

The description of how the resource is affected
Example : "string"

string

resource
optional

The resource to consider
Example : "string"

string

4.49. TagCount

Name Description Schema

count
optional

The number of occurrences of the given tag
Example : 0

integer (int32)

tag
optional

The tag label
Example : "string"

string

4.50. Tenant

Name Description Schema

accessPolicies
optional

The access policies granted to this tenant.
Example : [ "AccessPolicySummary" ]

< AccessPolicySummary > array

configurable
optional
read-only

Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.
Example : true

boolean

identifier
optional
read-only

The computer-generated identifier of the tenant.
Example : "string"

string

identity
required

The human-facing identity of the tenant. This can only be changed if the tenant is configurable.
Example : "string"

string

resourcePermissions
optional

A summary top-level resource access policies granted to this tenant.
Example : "ResourcePermissions"

ResourcePermissions

revision
optional

The revision of this entity used for optimistic-locking during updates.
Example : "RevisionInfo"

RevisionInfo

4.51. User

Name Description Schema

accessPolicies
optional

The access policies granted to this tenant.
Example : [ "AccessPolicySummary" ]

< AccessPolicySummary > array

configurable
optional
read-only

Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.
Example : true

boolean

identifier
optional
read-only

The computer-generated identifier of the tenant.
Example : "string"

string

identity
required

The human-facing identity of the tenant. This can only be changed if the tenant is configurable.
Example : "string"

string

resourcePermissions
optional

A summary top-level resource access policies granted to this tenant.
Example : "ResourcePermissions"

ResourcePermissions

revision
optional

The revision of this entity used for optimistic-locking during updates.
Example : "RevisionInfo"

RevisionInfo

userGroups
optional

The groups to which the user belongs.
Example : [ "Tenant" ]

< Tenant > array

4.52. UserGroup

Name Description Schema

accessPolicies
optional

The access policies granted to this tenant.
Example : [ "AccessPolicySummary" ]

< AccessPolicySummary > array

configurable
optional
read-only

Indicates if this tenant is configurable, based on which UserGroupProvider has been configured to manage it.
Example : true

boolean

identifier
optional
read-only

The computer-generated identifier of the tenant.
Example : "string"

string

identity
required

The human-facing identity of the tenant. This can only be changed if the tenant is configurable.
Example : "string"

string

resourcePermissions
optional

A summary top-level resource access policies granted to this tenant.
Example : "ResourcePermissions"

ResourcePermissions

revision
optional

The revision of this entity used for optimistic-locking during updates.
Example : "RevisionInfo"

RevisionInfo

users
optional

The users that belong to this user group. This can only be changed if this group is configurable.
Example : [ "Tenant" ]

< Tenant > array

4.53. VersionedConnection

Name Description Schema

backPressureDataSizeThreshold
optional

The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won’t impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue.
Example : "string"

string

backPressureObjectThreshold
optional

The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won’t impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue.
Example : 0

integer (int64)

bends
optional

The bend points on the connection.
Example : [ "Position" ]

< Position > array

comments
optional

The user-supplied comments for the component
Example : "string"

string

componentType
optional

Example : "string"

enum (CONNECTION, PROCESSOR, PROCESS_GROUP, REMOTE_PROCESS_GROUP, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, FUNNEL, LABEL, CONTROLLER_SERVICE)

destination
optional

The destination of the connection.
Example : "ConnectableComponent"

ConnectableComponent

flowFileExpiration
optional

The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it.
Example : "string"

string

groupIdentifier
optional

The ID of the Process Group that this component belongs to
Example : "string"

string

identifier
optional

The component’s unique identifier
Example : "string"

string

labelIndex
optional

The index of the bend point where to place the connection label.
Example : 0

integer (int32)

loadBalanceCompression
optional

Whether or not compression should be used when transferring FlowFiles between nodes
Example : "string"

enum (DO_NOT_COMPRESS, COMPRESS_ATTRIBUTES_ONLY, COMPRESS_ATTRIBUTES_AND_CONTENT)

loadBalanceStrategy
optional

The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.
Example : "string"

enum (DO_NOT_LOAD_BALANCE, PARTITION_BY_ATTRIBUTE, ROUND_ROBIN, SINGLE_NODE)

name
optional

The component’s name
Example : "string"

string

partitioningAttribute
optional

The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect.
Example : "string"

string

position
optional

The component’s position on the graph
Example : "Position"

Position

prioritizers
optional

The comparators used to prioritize the queue.
Example : [ "string" ]

< string > array

selectedRelationships
optional

The selected relationship that comprise the connection.
Example : [ "string" ]

< string > array

source
optional

The source of the connection.
Example : "ConnectableComponent"

ConnectableComponent

zIndex
optional

The z index of the connection.
Example : 0

integer (int64)

4.54. VersionedControllerService

Name Description Schema

annotationData
optional

The annotation for the controller service. This is how the custom UI relays configuration to the controller service.
Example : "string"

string

bundle
optional

The details of the artifact that bundled this processor type.
Example : "Bundle"

Bundle

comments
optional

The user-supplied comments for the component
Example : "string"

string

componentType
optional

Example : "string"

enum (CONNECTION, PROCESSOR, PROCESS_GROUP, REMOTE_PROCESS_GROUP, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, FUNNEL, LABEL, CONTROLLER_SERVICE)

controllerServiceApis
optional

Lists the APIs this Controller Service implements.
Example : [ "ControllerServiceAPI" ]

< ControllerServiceAPI > array

groupIdentifier
optional

The ID of the Process Group that this component belongs to
Example : "string"

string

identifier
optional

The component’s unique identifier
Example : "string"

string

name
optional

The component’s name
Example : "string"

string

position
optional

The component’s position on the graph
Example : "Position"

Position

properties
optional

The properties of the controller service.
Example : {
"string" : "string"
}

< string, string > map

propertyDescriptors
optional

The property descriptors for the processor.
Example : {
"string" : "VersionedPropertyDescriptor"
}

< string, VersionedPropertyDescriptor > map

type
optional

The type of the controller service.
Example : "string"

string

4.55. VersionedFlow

Name Description Schema

bucketIdentifier
required

The identifier of the bucket this items belongs to. This cannot be changed after the item is created.
Example : "string"

string

bucketName
optional
read-only

The name of the bucket this items belongs to.
Example : "string"

string

createdTimestamp
optional
read-only

The timestamp of when the item was created, as milliseconds since epoch.
Minimum value : 1
Example : 0

integer (int64)

description
optional

A description of the item.
Example : "string"

string

identifier
optional
read-only

An ID to uniquely identify this object.
Example : "string"

string

link
optional

An WebLink to this entity.
Example : "JaxbLink"

JaxbLink

modifiedTimestamp
optional
read-only

The timestamp of when the item was last modified, as milliseconds since epoch.
Minimum value : 1
Example : 0

integer (int64)

name
required

The name of the item.
Example : "string"

string

permissions
optional

The access that the current user has to the bucket containing this item.
Example : "Permissions"

Permissions

revision
optional

The revision of this entity used for optimistic-locking during updates.
Example : "RevisionInfo"

RevisionInfo

type
required

The type of item.
Example : "string"

enum (Flow, Bundle)

versionCount
optional
read-only

The number of versions of this flow.
Minimum value : 0
Example : 0

integer (int64)

4.56. VersionedFlowCoordinates

Name Description Schema

bucketId
optional

The UUID of the bucket that the flow resides in
Example : "string"

string

flowId
optional

The UUID of the flow
Example : "string"

string

latest
optional

Whether or not these coordinates point to the latest version of the flow
Example : true

boolean

registryUrl
optional

The URL of the Flow Registry that contains the flow
Example : "string"

string

version
optional

The version of the flow
Example : 0

integer (int32)

4.57. VersionedFlowDifference

Name Description Schema

bucketId
optional

The id of the bucket that the flow is stored in.
Example : "string"

string

componentDifferenceGroups
optional

Example : [ "ComponentDifferenceGroup" ]

< ComponentDifferenceGroup > array

flowId
optional

The id of the flow that is being examined.
Example : "string"

string

versionA
optional

The earlier version from the diff operation.
Example : 0

integer (int32)

versionB
optional

The latter version from the diff operation.
Example : 0

integer (int32)

4.58. VersionedFlowSnapshot

Name Description Schema

bucket
optional

The bucket where the flow is located
Example : "Bucket"

Bucket

externalControllerServices
optional

The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.
Example : {
"string" : "ExternalControllerServiceReference"
}

< string, ExternalControllerServiceReference > map

flow
optional

The flow this snapshot is for
Example : "VersionedFlow"

VersionedFlow

flowContents
required

The contents of the versioned flow
Example : "VersionedProcessGroup"

VersionedProcessGroup

flowEncodingVersion
optional

The optional encoding version of the flow contents.
Example : "string"

string

latest
optional

Example : true

boolean

parameterContexts
optional

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.
Example : {
"string" : "VersionedParameterContext"
}

< string, VersionedParameterContext > map

snapshotMetadata
required

The metadata for this snapshot
Example : "VersionedFlowSnapshotMetadata"

VersionedFlowSnapshotMetadata

4.59. VersionedFlowSnapshotMetadata

Name Description Schema

author
optional
read-only

The user that created this snapshot of the flow.
Example : "string"

string

bucketIdentifier
required

The identifier of the bucket this snapshot belongs to.
Example : "string"

string

comments
optional

The comments provided by the user when creating the snapshot.
Example : "string"

string

flowIdentifier
required

The identifier of the flow this snapshot belongs to.
Example : "string"

string

link
optional

An WebLink to this entity.
Example : "JaxbLink"

JaxbLink

timestamp
optional
read-only

The timestamp when the flow was saved, as milliseconds since epoch.
Minimum value : 1
Example : 0

integer (int64)

version
required

The version of this snapshot of the flow.
Minimum value : -1
Example : 0

integer (int32)

4.60. VersionedFunnel

Name Description Schema

comments
optional

The user-supplied comments for the component
Example : "string"

string

componentType
optional

Example : "string"

enum (CONNECTION, PROCESSOR, PROCESS_GROUP, REMOTE_PROCESS_GROUP, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, FUNNEL, LABEL, CONTROLLER_SERVICE)

groupIdentifier
optional

The ID of the Process Group that this component belongs to
Example : "string"

string

identifier
optional

The component’s unique identifier
Example : "string"

string

name
optional

The component’s name
Example : "string"

string

position
optional

The component’s position on the graph
Example : "Position"

Position

4.61. VersionedLabel

Name Description Schema

comments
optional

The user-supplied comments for the component
Example : "string"

string

componentType
optional

Example : "string"

enum (CONNECTION, PROCESSOR, PROCESS_GROUP, REMOTE_PROCESS_GROUP, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, FUNNEL, LABEL, CONTROLLER_SERVICE)

groupIdentifier
optional

The ID of the Process Group that this component belongs to
Example : "string"

string

height
optional

The height of the label in pixels when at a 1:1 scale.
Example : 0.0

number (double)

identifier
optional

The component’s unique identifier
Example : "string"

string

label
optional

The text that appears in the label.
Example : "string"

string

name
optional

The component’s name
Example : "string"

string

position
optional

The component’s position on the graph
Example : "Position"

Position

style
optional

The styles for this label (font-size : 12px, background-color : #eee, etc).
Example : {
"string" : "string"
}

< string, string > map

width
optional

The width of the label in pixels when at a 1:1 scale.
Example : 0.0

number (double)

4.62. VersionedParameter

Name Description Schema

description
optional

The description of the param
Example : "string"

string

name
optional

The name of the parameter
Example : "string"

string

sensitive
optional

Whether or not the parameter value is sensitive
Example : true

boolean

value
optional

The value of the parameter
Example : "string"

string

4.63. VersionedParameterContext

Name Description Schema

description
optional

The description of the parameter context
Example : "string"

string

name
optional

The name of the context
Example : "string"

string

parameters
optional

The parameters in the context
Example : [ "VersionedParameter" ]

< VersionedParameter > array

4.64. VersionedPort

Name Description Schema

allowRemoteAccess
optional

Whether or not this port allows remote access for site-to-site
Example : true

boolean

comments
optional

The user-supplied comments for the component
Example : "string"

string

componentType
optional

Example : "string"

enum (CONNECTION, PROCESSOR, PROCESS_GROUP, REMOTE_PROCESS_GROUP, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, FUNNEL, LABEL, CONTROLLER_SERVICE)

concurrentlySchedulableTaskCount
optional

The number of tasks that should be concurrently scheduled for the port.
Example : 0

integer (int32)

groupIdentifier
optional

The ID of the Process Group that this component belongs to
Example : "string"

string

identifier
optional

The component’s unique identifier
Example : "string"

string

name
optional

The component’s name
Example : "string"

string

position
optional

The component’s position on the graph
Example : "Position"

Position

scheduledState
optional

The scheduled state of the component
Example : "string"

enum (ENABLED, DISABLED)

type
optional

The type of port.
Example : "string"

enum (INPUT_PORT, OUTPUT_PORT)

4.65. VersionedProcessGroup

Name Description Schema

comments
optional

The user-supplied comments for the component
Example : "string"

string

componentType
optional

Example : "string"

enum (CONNECTION, PROCESSOR, PROCESS_GROUP, REMOTE_PROCESS_GROUP, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, FUNNEL, LABEL, CONTROLLER_SERVICE)

connections
optional

The Connections
Example : [ "VersionedConnection" ]

< VersionedConnection > array

controllerServices
optional

The Controller Services
Example : [ "VersionedControllerService" ]

< VersionedControllerService > array

flowFileConcurrency
optional

The configured FlowFile Concurrency for the Process Group
Example : "string"

string

flowFileOutboundPolicy
optional

The FlowFile Outbound Policy for the Process Group
Example : "string"

string

funnels
optional

The Funnels
Example : [ "VersionedFunnel" ]

< VersionedFunnel > array

groupIdentifier
optional

The ID of the Process Group that this component belongs to
Example : "string"

string

identifier
optional

The component’s unique identifier
Example : "string"

string

inputPorts
optional

The Input Ports
Example : [ "VersionedPort" ]

< VersionedPort > array

labels
optional

The Labels
Example : [ "VersionedLabel" ]

< VersionedLabel > array

name
optional

The component’s name
Example : "string"

string

outputPorts
optional

The Output Ports
Example : [ "VersionedPort" ]

< VersionedPort > array

parameterContextName
optional

The name of the parameter context used by this process group
Example : "string"

string

position
optional

The component’s position on the graph
Example : "Position"

Position

processGroups
optional

The child Process Groups
Example : [ "VersionedProcessGroup" ]

< VersionedProcessGroup > array

processors
optional

The Processors
Example : [ "VersionedProcessor" ]

< VersionedProcessor > array

remoteProcessGroups
optional

The Remote Process Groups
Example : [ "VersionedRemoteProcessGroup" ]

< VersionedRemoteProcessGroup > array

variables
optional

The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)
Example : {
"string" : "string"
}

< string, string > map

versionedFlowCoordinates
optional

The coordinates where the remote flow is stored, or null if the Process Group is not directly under Version Control
Example : "VersionedFlowCoordinates"

VersionedFlowCoordinates

4.66. VersionedProcessor

Name Description Schema

annotationData
optional

The annotation data for the processor used to relay configuration between a custom UI and the procesosr.
Example : "string"

string

autoTerminatedRelationships
optional

The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.
Example : [ "string" ]

< string > array

bulletinLevel
optional

The level at which the processor will report bulletins.
Example : "string"

string

bundle
optional

Information about the bundle from which the component came
Example : "Bundle"

Bundle

comments
optional

The user-supplied comments for the component
Example : "string"

string

componentType
optional

Example : "string"

enum (CONNECTION, PROCESSOR, PROCESS_GROUP, REMOTE_PROCESS_GROUP, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, FUNNEL, LABEL, CONTROLLER_SERVICE)

concurrentlySchedulableTaskCount
optional

The number of tasks that should be concurrently schedule for the processor. If the processor doesn’t allow parallol processing then any positive input will be ignored.
Example : 0

integer (int32)

executionNode
optional

Indicates the node where the process will execute.
Example : "string"

string

groupIdentifier
optional

The ID of the Process Group that this component belongs to
Example : "string"

string

identifier
optional

The component’s unique identifier
Example : "string"

string

name
optional

The component’s name
Example : "string"

string

penaltyDuration
optional

The amout of time that is used when the process penalizes a flowfile.
Example : "string"

string

position
optional

The component’s position on the graph
Example : "Position"

Position

properties
optional

The properties for the processor. Properties whose value is not set will only contain the property name.
Example : {
"string" : "string"
}

< string, string > map

propertyDescriptors
optional

The property descriptors for the processor.
Example : {
"string" : "VersionedPropertyDescriptor"
}

< string, VersionedPropertyDescriptor > map

runDurationMillis
optional

The run duration for the processor in milliseconds.
Example : 0

integer (int64)

scheduledState
optional

The scheduled state of the component
Example : "string"

enum (ENABLED, DISABLED)

schedulingPeriod
optional

The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy.
Example : "string"

string

schedulingStrategy
optional

Indcates whether the prcessor should be scheduled to run in event or timer driven mode.
Example : "string"

string

style
optional

Stylistic data for rendering in a UI
Example : {
"string" : "string"
}

< string, string > map

type
optional

The type of Processor
Example : "string"

string

yieldDuration
optional

The amount of time that must elapse before this processor is scheduled again after yielding.
Example : "string"

string

4.67. VersionedPropertyDescriptor

Name Description Schema

displayName
optional

The display name of the property
Example : "string"

string

identifiesControllerService
optional

Whether or not the property provides the identifier of a Controller Service
Example : true

boolean

name
optional

The name of the property
Example : "string"

string

sensitive
optional

Whether or not the property is considered sensitive
Example : true

boolean

4.68. VersionedRemoteGroupPort

Name Description Schema

batchSize
optional

The batch settings for data transmission.
Example : "BatchSize"

BatchSize

comments
optional

The user-supplied comments for the component
Example : "string"

string

componentType
optional

Example : "string"

enum (CONNECTION, PROCESSOR, PROCESS_GROUP, REMOTE_PROCESS_GROUP, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, FUNNEL, LABEL, CONTROLLER_SERVICE)

concurrentlySchedulableTaskCount
optional

The number of task that may transmit flowfiles to the target port concurrently.
Example : 0

integer (int32)

groupIdentifier
optional

The ID of the Process Group that this component belongs to
Example : "string"

string

identifier
optional

The component’s unique identifier
Example : "string"

string

name
optional

The component’s name
Example : "string"

string

position
optional

The component’s position on the graph
Example : "Position"

Position

remoteGroupId
optional

The id of the remote process group that the port resides in.
Example : "string"

string

scheduledState
optional

The scheduled state of the component
Example : "string"

enum (ENABLED, DISABLED)

targetId
optional

The ID of the port on the target NiFi instance
Example : "string"

string

useCompression
optional

Whether the flowfiles are compressed when sent to the target port.
Example : true

boolean

4.69. VersionedRemoteProcessGroup

Name Description Schema

comments
optional

The user-supplied comments for the component
Example : "string"

string

communicationsTimeout
optional

The time period used for the timeout when communicating with the target.
Example : "string"

string

componentType
optional

Example : "string"

enum (CONNECTION, PROCESSOR, PROCESS_GROUP, REMOTE_PROCESS_GROUP, INPUT_PORT, OUTPUT_PORT, REMOTE_INPUT_PORT, REMOTE_OUTPUT_PORT, FUNNEL, LABEL, CONTROLLER_SERVICE)

groupIdentifier
optional

The ID of the Process Group that this component belongs to
Example : "string"

string

identifier
optional

The component’s unique identifier
Example : "string"

string

inputPorts
optional

A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance
Example : [ "VersionedRemoteGroupPort" ]

< VersionedRemoteGroupPort > array

localNetworkInterface
optional

The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier.
Example : "string"

string

name
optional

The component’s name
Example : "string"

string

outputPorts
optional

A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance
Example : [ "VersionedRemoteGroupPort" ]

< VersionedRemoteGroupPort > array

position
optional

The component’s position on the graph
Example : "Position"

Position

proxyHost
optional

Example : "string"

string

proxyPort
optional

Example : 0

integer (int32)

proxyUser
optional

Example : "string"

string

targetUri
optional

[DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null.
Example : "string"

string

targetUris
optional

The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null.
Example : "string"

string

transportProtocol
optional

The Transport Protocol that is used for Site-to-Site communications
Example : "string"

enum (RAW, HTTP)

yieldDuration
optional

When yielding, this amount of time must elapse before the remote process group is scheduled again.
Example : "string"

string