Skip to main content
API docs by Redocly

Plugins (0.1.2)

Download OpenAPI specification:Download

Legacy Plugin

(Deprecated) Create a new Plugin Deprecated

Use this endpoint to create a new Plugin in the system.

Deprecated Endpoint

This endpoint is deprecated and will be removed in the next major version (V1.0) of the SDK.

Please use the new POST endpoint at /v1/plugins instead, which supports versioning and has been refactored to improve the overall structure of the API.

Authorizations:
ApplicationToken
Request Body schema: application/json
id
integer <int64>
name
string
pluginId
string
pluginURL
string
project
string
resourceId
string
Array of objects (LegacyPluginTag)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "pluginId": "string",
  • "pluginURL": "string",
  • "project": "string",
  • "resourceId": "string",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "pluginId": "string",
  • "pluginURL": "string",
  • "project": "string",
  • "resourceId": "string",
  • "tags": [
    ]
}

(Deprecated) Update an existing Plugin Deprecated

Use this endpoint to update an existing Plugin in the system.

Deprecated Endpoint

This endpoint is deprecated and will be removed in the next major version (V1.0) of the SDK.

Please use the new PUT endpoint at /v1/plugins/{pluginId} instead, which supports versioning and has been refactored to improve the overall structure of the API.

Authorizations:
ApplicationToken
path Parameters
pluginId
required
string

Plugin ID in path

Request Body schema: application/json
id
integer <int64>
name
string
pluginId
string
pluginURL
string
project
string
resourceId
string
Array of objects (LegacyPluginTag)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "pluginId": "string",
  • "pluginURL": "string",
  • "project": "string",
  • "resourceId": "string",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "pluginId": "string",
  • "pluginURL": "string",
  • "project": "string",
  • "resourceId": "string",
  • "tags": [
    ]
}

(Deprecated) Delete Plugin by its ID Deprecated

Use this endpoint to delete a marco Plugin by its ID.

Deprecated Endpoint

This endpoint is deprecated and will be removed in the next major version (V1.0) of the SDK.

Please use the new DELETE endpoint at /v1/plugins/{pluginId} instead, which supports versioning and has been refactored to improve the overall structure of the API.

Authorizations:
ApplicationToken
path Parameters
pluginId
required
string

Plugin ID in path

Responses

(Deprecated) Get Plugin by its ID Deprecated

Use this endpoint to get a marco Plugin by its ID.

Deprecated Endpoint

This endpoint is deprecated and will be removed in the next major version (V1.0) of the SDK.

Please use the new GET endpoint at /v1/plugins/{pluginId} instead, which supports versioning and has been refactored to improve the overall structure of the API.

Authorizations:
ApplicationToken
path Parameters
pluginId
required
string

Plugin ID in path

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "pluginId": "string",
  • "pluginURL": "string",
  • "project": "string",
  • "resourceId": "string",
  • "tags": [
    ]
}

(Deprecated) Get a page of marco Plugins in a project Deprecated

Use this endpoint to get a page of marco Plugins in a project.

Deprecated Endpoint

This endpoint is deprecated and will be removed in the next major version (V1.0) of the SDK.

Please use the new GET endpoint at /v1/plugins with the project query parameter instead, which supports versioning and has been refactored to improve the overall structure of the API.

Authorizations:
ApplicationToken
path Parameters
project
required
string

Name of the project

query Parameters
resourceId
string
Default: ""

The resourceId of the project that you want to return

size
integer <int> [ 5 .. 100 ]
Default: 20

The number of items to return per page

page
integer <int> >= 0
Default: 0

The page number that you want to return

sort
Array of strings
Example: sort=name,name,asc,name,desc

The sort order that you want to return. You can specify one or more comma-separated sort keys, each followed by an optional sort direction of either asc (ascending) or desc (descending).

If you want to sort in descending order, append ,desc to the sort key; otherwise, the default is to sort in ascending order. If you want to sort in ascending order, you can optionally append ,asc.

Examples of valid sort query parameters include:

  • sort=name: Sort by name in ascending order
  • sort=name,desc: Sort by name in descending order
  • sort=name,desc,created,asc: Sort by name in descending order, then by created in ascending order
  • sort=name,desc&sort=created,asc: Sort by name in descending order, then by created in ascending order

Responses

Response samples

Content type
application/json
{
  • "contentType": "PluginPage"
}

(Deprecated) Get a page of marco Plugins in a project filtering by tags Deprecated

Use this endpoint to get a page of marco Plugins in a project filtering by tags.

Deprecated Endpoint

This endpoint is deprecated and scheduled to be removed. Please use the GET /v1/plugins endpoint with the project and tags query parameters instead, which supports versioning and has been refactored to improve the overall structure of the API.

Authorizations:
ApplicationToken
path Parameters
project
required
string

Name of the project

Responses

Response samples

Content type
application/json
{
  • "contentType": "PluginPage"
}

Legacy Tag

Add Plugin Tags Deprecated

Use this endpoint to add one or more tags to a Plugin.

Deprecated Endpoint

This endpoint is deprecated and will be removed in the next major version (V1.0) of the SDK.

Please use the new POST endpoint at /v1/plugins/{pluginId}/tags instead, which supports versioning and has been refactored to improve the overall structure of the API.

Authorizations:
ApplicationToken
path Parameters
pluginId
required
string

Plugin ID in path

Request Body schema: application/json
id
integer <int64>
name
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string"
}

Remove Plugin Tags Deprecated

Use this endpoint to remove a tag from a Plugin.

Deprecated Endpoint

This endpoint is deprecated and will be removed in the next major version (V1.0) of the SDK.

Please use the new DELETE endpoint at /v1/plugins/{pluginId}/tags instead, which supports versioning and has been refactored to improve the overall structure of the API.

Authorizations:
ApplicationToken
path Parameters
pluginId
required
string

Plugin ID in path

tagName
required
string

The name of the tag that you want to perform an action on

Responses

List available Plugin Tags Deprecated

Use this endpoint to retrieve a list of available tags for Plugins.

Deprecated Endpoint

This endpoint is deprecated and will be removed in the next major version (V1.0) of the SDK.

Please note that there will be no replacement for this endpoint, as tags are no longer supported as a separate entity. Instead, users can assign any unique string to a Plugin to indicate its tag.

Authorizations:
ApplicationToken
query Parameters
plugin
required
string

Plugin ID in query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Plugin

Get a page of Plugins

Use this endpoint to get a page of Plugins. You can filter the results by project and tags using the project and tags query parameters.

This endpoint supports pagination through the page and size query parameters. You can sort the results by specifying one or more comma-separated sort keys

Authorizations:
ApplicationToken
query Parameters
project
required
string
Example: project=PRJ-123456789AB

The project name for which to retrieve the plugins

tags
Array of strings

A comma-separated list of tag names by which to filter the plugins. Only plugins matching all specified tag names will be returned.

page
integer <int> >= 0
Default: 0

The page number that you want to return

size
integer <int> [ 5 .. 100 ]
Default: 20

The number of items to return per page

sort
Array of strings
Example: sort=name,name,asc,name,desc

The sort order that you want to return. You can specify one or more comma-separated sort keys, each followed by an optional sort direction of either asc (ascending) or desc (descending).

If you want to sort in descending order, append ,desc to the sort key; otherwise, the default is to sort in ascending order. If you want to sort in ascending order, you can optionally append ,asc.

Examples of valid sort query parameters include:

  • sort=name: Sort by name in ascending order
  • sort=name,desc: Sort by name in descending order
  • sort=name,desc,created,asc: Sort by name in descending order, then by created in ascending order
  • sort=name,desc&sort=created,asc: Sort by name in descending order, then by created in ascending order

Responses

Response samples

Content type
application/json
{
  • "contentType": "PluginPagedResult",
  • "hasMore": true,
  • "nextPage": 0,
  • "previousPage": 0,
  • "pageContent": [
    ]
}

Create new Plugin

Use this endpoint to create a new Plugin.

Authorizations:
ApplicationToken
Request Body schema: application/json
implementationVersion
string

The version of the interface the plugin is running.

name
required
string

The name of the plugin.

projectId
required
string

The ID of the project that the plugin belongs to.

tags
Array of strings unique

A set of tag names associated with the plugin.

url
required
string

The URL for the plugin.

Responses

Request samples

Content type
application/json
{
  • "implementationVersion": "string",
  • "name": "string",
  • "projectId": "string",
  • "tags": [
    ],
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "active": true,
  • "id": "string",
  • "implementationVersion": "string",
  • "name": "string",
  • "pluginType": "BLOCKCHAIN_PLUGIN",
  • "projectId": "string",
  • "tags": [
    ],
  • "url": "string"
}

Delete a Plugin by its ID

Use this endpoint to delete a Plugin by its ID.

Authorizations:
ApplicationToken
path Parameters
pluginId
required
string

Plugin ID in path

Responses

Get a Plugin by its ID

Use this endpoint to get a Plugin by its ID.

Authorizations:
ApplicationToken
path Parameters
pluginId
required
string

Plugin ID in path

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "id": "string",
  • "implementationVersion": "string",
  • "name": "string",
  • "pluginType": "BLOCKCHAIN_PLUGIN",
  • "projectId": "string",
  • "tags": [
    ],
  • "url": "string"
}

Update a Plugin by its ID

Use this endpoint to update a Plugin by its ID.

Authorizations:
ApplicationToken
path Parameters
pluginId
required
string

Plugin ID in path

Request Body schema: application/json
active
required
boolean

Whether the plugin is active or not.

implementationVersion
string

The version of the interface the plugin is running.

name
required
string

The name of the plugin.

url
required
string

The URL for the plugin.

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "implementationVersion": "string",
  • "name": "string",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "active": true,
  • "id": "string",
  • "implementationVersion": "string",
  • "name": "string",
  • "pluginType": "BLOCKCHAIN_PLUGIN",
  • "projectId": "string",
  • "tags": [
    ],
  • "url": "string"
}

Remove Tags from Plugin

Use this endpoint to remove one or more tags from a Plugin.

Authorizations:
ApplicationToken
path Parameters
pluginId
required
string

Plugin ID in path

Request Body schema: application/json
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ]
}

Add Tags to Plugin

Use this endpoint to add one or more tags to a Plugin.

Authorizations:
ApplicationToken
path Parameters
pluginId
required
string

Plugin ID in path

Request Body schema: application/json
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ]
}