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.

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

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"
      }
    }
  } ]
}