Plugin API

Lists all the registered plugins (including all versions of each).

Path	Method	Protected
`/v1/plugins`	GET	Yes

Query Parameters

Name	Type	Required	Description
scope	#/components/schemas/PluginScope	Yes	-

Example Response JSON

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "version": "string",
    "description": "string",
    "icon": [
      0
    ],
    "homepage": "string",
    "specs": {
      "type": "ComponentTransformer",
      "providedWitPackage": "string",
      "jsonSchema": "string",
      "validateUrl": "string",
      "transformUrl": "string"
    },
    "scope": {
      "type": "Global"
    },
    "owner": {
      "accountId": "string"
    },
    "deleted": true
  }
]

Registers a new plugin

Path	Method	Protected
`/v1/plugins`	POST	Yes

Example Request JSON

{
  "name": "string",
  "version": "string",
  "description": "string",
  "icon": [
    0
  ],
  "homepage": "string",
  "specs": {
    "type": "ComponentTransformer",
    "providedWitPackage": "string",
    "jsonSchema": "string",
    "validateUrl": "string",
    "transformUrl": "string"
  },
  "scope": {
    "type": "Global"
  }
}

Example Response JSON

{}

Gets a registered plugin by its name and version

Path	Method	Protected
`/v1/plugins/{account_id}/{name}/{version}`	GET	Yes

Example Response JSON

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "version": "string",
  "description": "string",
  "icon": [
    0
  ],
  "homepage": "string",
  "specs": {
    "type": "ComponentTransformer",
    "providedWitPackage": "string",
    "jsonSchema": "string",
    "validateUrl": "string",
    "transformUrl": "string"
  },
  "scope": {
    "type": "Global"
  },
  "owner": {
    "accountId": "string"
  },
  "deleted": true
}

Deletes a registered plugin by its name and version

Path	Method	Protected
`/v1/plugins/{account_id}/{name}/{version}`	DELETE	Yes

Example Response JSON

{}

Registers a new library plugin

Path	Method	Protected
`/v1/plugins/library-plugins`	POST	Yes

Request Form: multipart/form-data

Make sure to include Content-Type: multipart/form-data Header

Field name: string undefined

Field version: string undefined

Field description: string undefined

Field icon: string binary

Field homepage: string undefined

Field scope: JSON

{
  "type": "Global"
}

Field wasm: string binary

Example Response JSON

{}

Registers a new app plugin

Path	Method	Protected
`/v1/plugins/app-plugins`	POST	Yes

Request Form: multipart/form-data

Make sure to include Content-Type: multipart/form-data Header

Field name: string undefined

Field version: string undefined

Field description: string undefined

Field icon: string binary

Field homepage: string undefined

Field scope: JSON

{
  "type": "Global"
}

Field wasm: string binary

Example Response JSON

{}

Plugin API Errors

Status Code	Description	Body
400	Invalid request, returning with a list of issues detected in the request	`{"errors":["string"]}`
401	Unauthorized	`{"error":"string"}`
403	Maximum number of components exceeded	`{"error":"string"}`
404	Component not found	`{"error":"string"}`
409	Component already exists	`{"error":"string"}`
500	Internal server error	`{"error":"string"}`