Plugins

Get Marketplace

get

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

get/api/v2/plugin-registries/marketplace

GET /api/v2/plugin-registries/marketplace HTTP/1.1
Accept: */*

{
  "records": [
    {
      "name": "text",
      "registries": {
        "ANY_ADDITIONAL_PROPERTY": {
          "name": "text",
          "registry": "text",
          "homepage_url": "text",
          "source_url": "text",
          "authors": [
            {
              "name": "text",
              "handle": "text",
              "link": "text"
            }
          ],
          "versions": [
            {
              "name": "text",
              "git_url": "text",
              "tar_url": "text",
              "ref": "text",
              "subdirectory": "text"
            }
          ],
          "description": "text"
        }
      },
      "installed": false,
      "installed_version": "text"
    }
  ]
}

Install Plugin

post

Body

namestringRequired

versionstringRequired

registrystringRequired

Responses

200

Successful Response

application/json

anyOptional

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post/api/v2/plugin-registries/marketplace/install

POST /api/v2/plugin-registries/marketplace/install HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "name": "text",
  "version": "text",
  "registry": "text"
}

No content

Add Tag

post

Path parameters

uidintegerRequired

plugin_idstringRequired

Body

namestringRequiredPattern: ^[^:]+$

valuestringRequiredPattern: ^[^:]+$

colorstring · nullableOptional

Responses

201

Successful Response

application/json

anyOptional

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post/api/v2/plugins/{plugin_id}/tasks/{uid}/tags

POST /api/v2/plugins/{plugin_id}/tasks/{uid}/tags HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "name": "text",
  "value": "text",
  "color": "text"
}

No content

Update Tag

put

Path parameters

uidintegerRequired

plugin_idstringRequired

tag_idintegerRequired

Body

namestringRequiredPattern: ^[^:]+$

valuestringRequiredPattern: ^[^:]+$

colorstring · nullableOptional

Responses

200

Successful Response

application/json

anyOptional

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

put/api/v2/plugins/{plugin_id}/tasks/{uid}/tags/{tag_id}

PUT /api/v2/plugins/{plugin_id}/tasks/{uid}/tags/{tag_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "name": "text",
  "value": "text",
  "color": "text"
}

No content

Delete Tag

delete

Path parameters

uidintegerRequired

tag_idintegerRequired

plugin_idstringRequired

Responses

204

Successful Response

No content

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

delete/api/v2/plugins/{plugin_id}/tasks/{uid}/tags/{tag_id}

DELETE /api/v2/plugins/{plugin_id}/tasks/{uid}/tags/{tag_id} HTTP/1.1
Accept: */*

No content

Read Tasks All Plugins

get

Query parameters

limitintegerOptionalDefault: -1

pageintegerOptionalDefault: 1

include_full_inputbooleanOptionalDefault: false

include_outputbooleanOptionalDefault: true

sincestring · date-time · nullableOptional

order_bystring · enumOptionalDefault: idPossible values:

order_directionstring · enumOptionalDefault: descPossible values:

statusstring · enum · nullableOptionalPossible values:

pluginsstring[] · nullableOptional

usersinteger[] · nullableOptional

tagsstring[] · nullableOptional

querystring · nullableOptional

Responses

200

Successful Response

application/json

limitintegerRequired

pageintegerRequired

total_pagesintegerRequired

totalintegerRequired

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get/api/v2/plugins/tasks

GET /api/v2/plugins/tasks HTTP/1.1
Accept: */*

{
  "records": [
    {
      "id": 1,
      "input": "text",
      "full_input": "text",
      "output": "text",
      "user_id": 1,
      "username": "text",
      "plugin_id": "text",
      "plugin_options": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "downloads": [
        {
          "id": 1,
          "filename": "text",
          "link": "text"
        }
      ],
      "status": "queued",
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z",
      "tags": [
        {
          "id": 1,
          "name": "text",
          "value": "text",
          "label": "text",
          "color": "text"
        }
      ]
    }
  ],
  "limit": 1,
  "page": 1,
  "total_pages": 1,
  "total": 1
}

Read Tasks

get

Path parameters

plugin_idstringRequired

Query parameters

limitintegerOptionalDefault: -1

pageintegerOptionalDefault: 1

include_full_inputbooleanOptionalDefault: false

include_outputbooleanOptionalDefault: true

sincestring · date-time · nullableOptional

order_bystring · enumOptionalDefault: idPossible values:

order_directionstring · enumOptionalDefault: descPossible values:

statusstring · enum · nullableOptionalPossible values:

usersinteger[] · nullableOptional

tagsstring[] · nullableOptional

querystring · nullableOptional

Responses

200

Successful Response

application/json

limitintegerRequired

pageintegerRequired

total_pagesintegerRequired

totalintegerRequired

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get/api/v2/plugins/{plugin_id}/tasks

GET /api/v2/plugins/{plugin_id}/tasks HTTP/1.1
Accept: */*

{
  "records": [
    {
      "id": 1,
      "input": "text",
      "full_input": "text",
      "output": "text",
      "user_id": 1,
      "username": "text",
      "plugin_id": "text",
      "plugin_options": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "downloads": [
        {
          "id": 1,
          "filename": "text",
          "link": "text"
        }
      ],
      "status": "queued",
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z",
      "tags": [
        {
          "id": 1,
          "name": "text",
          "value": "text",
          "label": "text",
          "color": "text"
        }
      ]
    }
  ],
  "limit": 1,
  "page": 1,
  "total_pages": 1,
  "total": 1
}

Read Task

get

Path parameters

uidintegerRequired

plugin_idstringRequired

Responses

200

Successful Response

application/json

idintegerRequired

inputstringRequired

full_inputstring · nullableOptional

outputstring · nullableOptional

user_idinteger · nullableOptional

usernamestring · nullableOptional

plugin_idstringRequired

statusstring · enum · nullableOptionalPossible values:

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get/api/v2/plugins/{plugin_id}/tasks/{uid}

GET /api/v2/plugins/{plugin_id}/tasks/{uid} HTTP/1.1
Accept: */*

{
  "id": 1,
  "input": "text",
  "full_input": "text",
  "output": "text",
  "user_id": 1,
  "username": "text",
  "plugin_id": "text",
  "plugin_options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "downloads": [
    {
      "id": 1,
      "filename": "text",
      "link": "text"
    }
  ],
  "status": "queued",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "tags": [
    {
      "id": 1,
      "name": "text",
      "value": "text",
      "label": "text",
      "color": "text"
    }
  ]
}

Read Plugins

get

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

get/api/v2/plugins

GET /api/v2/plugins HTTP/1.1
Accept: */*

{
  "records": [
    {
      "id": "text",
      "name": "text",
      "authors": [
        {
          "name": "text",
          "handle": "text",
          "link": "text"
        }
      ],
      "readme": "",
      "techniques": [
        "text"
      ],
      "software": "text",
      "execution_options": {
        "ANY_ADDITIONAL_PROPERTY": {
          "description": "text",
          "required": true,
          "value": "text",
          "suggested_values": [
            "text"
          ],
          "strict": true,
          "editable": true,
          "value_type": "STRING",
          "internal": true,
          "depends_on": [
            {
              "name": "text",
              "values": [
                "text"
              ]
            }
          ]
        }
      },
      "settings_options": {
        "ANY_ADDITIONAL_PROPERTY": {
          "description": "text",
          "required": true,
          "value": "text",
          "suggested_values": [
            "text"
          ],
          "strict": true,
          "editable": true,
          "value_type": "STRING",
          "internal": true,
          "depends_on": [
            {
              "name": "text",
              "values": [
                "text"
              ]
            }
          ]
        }
      },
      "current_settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "enabled": true,
      "loaded": false,
      "execution_enabled": false,
      "python_deps": [
        "text"
      ]
    }
  ]
}

Read Plugin

get

Path parameters

plugin_idstringRequired

Responses

200

Successful Response

application/json

anyOptional

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get/api/v2/plugins/{plugin_id}

GET /api/v2/plugins/{plugin_id} HTTP/1.1
Accept: */*

No content

Update Plugin

put

Path parameters

plugin_idstringRequired

Body

enabledbooleanRequired

Responses

200

Successful Response

application/json

anyOptional

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

put/api/v2/plugins/{plugin_id}

PUT /api/v2/plugins/{plugin_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "enabled": true
}

No content

Execute Plugin

post

Path parameters

plugin_idstringRequired

Body

Responses

200

Successful Response

application/json

detailstringOptionalDefault: ""

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post/api/v2/plugins/{plugin_id}/execute

POST /api/v2/plugins/{plugin_id}/execute HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "options": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "detail": ""
}

Update Plugin Settings

put

Path parameters

plugin_idstringRequired

Body

Other propertiesanyOptional

Responses

200

Successful Response

application/json

anyOptional

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

put/api/v2/plugins/{plugin_id}/settings

PUT /api/v2/plugins/{plugin_id}/settings HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

No content

Reload Plugins

post

Responses

204

Successful Response

No content

400

Bad request

application/json

404

Not found

application/json

post/api/v2/plugins/reload

POST /api/v2/plugins/reload HTTP/1.1
Accept: */*

No content

Install Plugin Git

post

Body

urlstringRequired

refstring · nullableOptional

subdirectorystring · nullableOptional

Responses

200

Successful Response

application/json

anyOptional

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post/api/v2/plugins/install/git

POST /api/v2/plugins/install/git HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "url": "text",
  "ref": "text",
  "subdirectory": "text"
}

No content

Install Plugin Tar

post

Body

urlstringRequired

subdirectorystring · nullableOptional

Responses

200

Successful Response

application/json

anyOptional

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post/api/v2/plugins/install/tar

POST /api/v2/plugins/install/tar HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "url": "text",
  "subdirectory": "text"
}

No content