Welcome to the new Golem Cloud Docs! 👋

Plugin API

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

PathMethodProtected
/v1/pluginsGETNo

Query Parameters

NameTypeRequiredDescription
scope#/components/schemas/DefaultPluginScopeNo-

Example Response 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"
    },
    "owner": {}
  }
]

Registers a new plugin

PathMethodProtected
/v1/pluginsPOSTNo

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

{}

Lists all the registered versions of a specific plugin identified by its name

PathMethodProtected
/v1/plugins/{name}GETNo

Example Response 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"
    },
    "owner": {}
  }
]

Registers a new library plugin

PathMethodProtected
/v1/library-pluginsPOSTNo

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

PathMethodProtected
/v1/app-pluginsPOSTNo

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

{}

Gets a registered plugin by its name and version

PathMethodProtected
/v1/plugins/{name}/{version}GETNo

Example Response 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"
  },
  "owner": {}
}

Deletes a registered plugin by its name and version

PathMethodProtected
/v1/plugins/{name}/{version}DELETENo

Example Response JSON

{}

Plugin API Errors

Status CodeDescriptionBody
400{"errors":["string"]}
401{"error":"string"}
403{"error":"string"}
404{"error":"string"}
409{"error":"string"}
500{"error":"string"}