Get plugin by tag
GET/api/v1/plugins/:tag
Retrieve the metadata of a plugin by tag
Request
Path Parameters
Responses
- 200
- 404
Metadata of the plugin
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
contexts
object[]
required
Which contexts the plugin should execute/show up in, e.g. { "type": "GLOBAL" }
createdBy
object
The creator of the plugin. Null if created via API.
Description of the plugin
Whether the plugin is generally available or not
When the plugin was last updated
The minimum role required to view the plugin, e.g. VIEWER
, USER
, MANAGER
, OWNER
, or the tag for a custom role. Learn more about each permission in our docs.
Display name of the plugin
The identifier of the proxy to use for requests from this plugin
Unique identifier for the plugin
{
"contexts": [
{
"type": "string"
}
],
"createdBy": {
"dateCreated": "2024-07-29T15:51:28.071Z",
"email": "string",
"id": 0,
"name": "string",
"oauthUserId": "string",
"tenantId": 0
},
"description": "string",
"isDraft": true,
"lastUpdated": "2024-07-29T15:51:28.071Z",
"minimumRoleRequired": "string",
"name": "string",
"proxyTag": "string",
"tag": "string"
}
Plugin not found
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [INTEGRATION_MISSING
, INTEGRATION_UNREGISTERED
, INTEGRATION_UNSUPPORTED
, INTEGRATION_GRAPHQL_ERROR
, INTEGRATION_BAD_REQUEST
, INTEGRATION_UNAUTHORIZED
, INTEGRATION_FORBIDDEN
, INTEGRATION_NOT_FOUND
, INTEGRATION_UNPROCESSABLE_CONTENT
, INTEGRATION_RATE_LIMITED
, INTEGRATION_INTERNAL_ERROR
, INTEGRATION_NOT_IMPLEMENTED
, INTEGRATION_BAD_GATEWAY
, INTEGRATION_UNAVAILABLE
, INTEGRATION_GATEWAY_TIMEOUT
, INTEGRATION_TIMED_OUT
, INTEGRATION_CACHE_ERROR
, INTEGRATION_UNHANDLED_HTTP_ERROR
, INTEGRATION_UNHANDLED_EXCEPTION
, INTEGRATION_UNEXPECTED_ERROR
, ILLEGAL_ARGUMENT_ERROR
, BAD_REQUEST
, FORBIDDEN
, NOT_FOUND
, REQUEST_TIMEOUT
, CONFLICT
, UNHANDLED_EXCEPTION
, UNCATEGORIZED
, SERVICE_CREATOR
, UNKNOWN_HOST
]
{
"details": "string",
"gatewayHttpStatus": 0,
"httpStatus": 0,
"message": "string",
"requestId": "string",
"type": "INTEGRATION_MISSING"
}