Plugin API

List all plugins registered in account

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

Example Response JSON


{
  "values": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
      "name": "string",
      "version": "string",
      "description": "string",
      "icon": "string",
      "homepage": "string",
      "spec": {
        "type": "OplogProcessor",
        "componentId": "616ccd92-d666-4180-8349-8d125b269fac",
        "componentRevision": 0
      }
    }
  ]
}

Register a new plugin

Path	Method	Protected
`/v1/accounts/{account_id}/plugins`	POST	Yes

Example Request JSON


{
  "name": "string",
  "version": "string",
  "description": "string",
  "icon": "string",
  "homepage": "string",
  "spec": {
    "type": "OplogProcessor",
    "componentId": "616ccd92-d666-4180-8349-8d125b269fac",
    "componentRevision": 0
  }
}

Example Response JSON


{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
  "name": "string",
  "version": "string",
  "description": "string",
  "icon": "string",
  "homepage": "string",
  "spec": {
    "type": "OplogProcessor",
    "componentId": "616ccd92-d666-4180-8349-8d125b269fac",
    "componentRevision": 0
  }
}

Get a plugin by id

Path	Method	Protected
`/v1/plugins/{plugin_id}`	GET	Yes

Example Response JSON


{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
  "name": "string",
  "version": "string",
  "description": "string",
  "icon": "string",
  "homepage": "string",
  "spec": {
    "type": "OplogProcessor",
    "componentId": "616ccd92-d666-4180-8349-8d125b269fac",
    "componentRevision": 0
  }
}

Delete a plugin

Path	Method	Protected
`/v1/plugins/{plugin_id}`	DELETE	Yes

Example Response JSON


{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
  "name": "string",
  "version": "string",
  "description": "string",
  "icon": "string",
  "homepage": "string",
  "spec": {
    "type": "OplogProcessor",
    "componentId": "616ccd92-d666-4180-8349-8d125b269fac",
    "componentRevision": 0
  }
}

Plugin API Errors

Status Code	Description	Body
400	Invalid request, returning with a list of issues detected in the request	`{"code":"string","errors":["string"]}`
401	Unauthorized request	`{"code":"string","error":"string"}`
403	Forbidden Request	`{"code":"string","error":"string"}`
404	Entity not found	`{"code":"string","error":"string"}`
409		`{"code":"string","error":"string"}`
422	Limits of the plan exceeded	`{"code":"string","error":"string"}`
500	Internal server error	`{"code":"string","error":"string"}`