Plugins

Use these operations to interact with plugins in Cortex.

Required permissions

Your API key must have the Edit plugins permission.

Operations

Get all plugins

get

Retrieve a list of all plugins, excluding drafts

Authorizations

Query parameters

includeDraftsbooleanoptional

pageSizeinteger · int32 · default: 250required

Number of results to return per page, between 1 and 1000. Default 250.

pageinteger · int32 · default: 0required

Page number to return, 0-indexed. Default 0.

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/plugins?pageSize=1&page=1' \
  --header 'Authorization: Bearer JWT'

200

429

200

{
  "page": 1,
  "plugins": [
    {
      "contexts": [
        {
          "entityFilter": {
            "type": "CQL_FILTER",
            "category": "Service",
            "cqlVersion": "V1",
            "query": "text"
          },
          "type": "text"
        }
      ],
      "createdBy": {
        "dateCreated": "2025-03-29T00:50:13.438Z",
        "email": "text",
        "id": 1,
        "lastLogin": "2025-03-29T00:50:13.438Z",
        "name": "text",
        "oauthUserId": "text",
        "tenantId": 1,
        "timezone": "text"
      },
      "description": "text",
      "iconTag": "text",
      "isDraft": true,
      "lastUpdated": "2025-03-29T00:50:13.438Z",
      "minimumRoleRequired": "text",
      "name": "text",
      "proxyTag": "text",
      "tag": "text",
      "version": "text"
    }
  ],
  "total": 1,
  "totalPages": 1
}

List of plugins

Get plugin by tag

get

Retrieve the metadata of a plugin by tag

Authorizations

Path parameters

tagstringrequired

Unique identifier for the plugin

Query parameters

includeBlobboolean · default: falseoptional

When true, returns the plugin blob. Defaults to false.

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/plugins/{tag}' \
  --header 'Authorization: Bearer JWT'

200

404

429

200

{
  "blob": "text",
  "contexts": [
    {
      "entityFilter": {
        "type": "CQL_FILTER",
        "category": "Service",
        "cqlVersion": "V1",
        "query": "text"
      },
      "type": "text"
    }
  ],
  "createdBy": {
    "dateCreated": "2025-03-29T00:50:13.438Z",
    "email": "text",
    "id": 1,
    "lastLogin": "2025-03-29T00:50:13.438Z",
    "name": "text",
    "oauthUserId": "text",
    "tenantId": 1,
    "timezone": "text"
  },
  "description": "text",
  "iconTag": "text",
  "isDraft": true,
  "lastUpdated": "2025-03-29T00:50:13.438Z",
  "minimumRoleRequired": "text",
  "name": "text",
  "proxyTag": "text",
  "tag": "text",
  "version": "text"
}

Metadata of the plugin

Create a plugin

post

Create a new plugin

Authorizations

Body

blobstringrequired

The raw source code of the plugin. This should be an HTML file

contextsone of[]required

Which contexts the plugin should execute/show up in, e.g. { "type": "GLOBAL" }

descriptionstringoptional

Description of the plugin

iconTagstringoptional

Icon tag for the plugin

isDraftbooleanrequired

Whether the plugin is generally available or not

minimumRoleRequiredstringrequired

The minimum role required to view the plugin, e.g. VIEWER, USER, MANAGER, OWNER, or the tag for a custom role. Learn more about each permission in our docs.

namestringrequired

Display name of the plugin

proxyTagstringoptional

The identifier of the proxy to use for requests from this plugin

tagstringrequired

Unique identifier for the plugin

versionstringoptional

The version of the plugin

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/plugins' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "blob": "text",
    "contexts": [
      {
        "entityFilter": {
          "type": "CQL_FILTER",
          "category": "Service",
          "cqlVersion": "V1",
          "query": "text"
        },
        "type": "text"
      }
    ],
    "description": "text",
    "iconTag": "text",
    "isDraft": true,
    "minimumRoleRequired": "text",
    "name": "text",
    "proxyTag": "text",
    "tag": "text",
    "version": "text"
  }'

200

400

429

200

{
  "contexts": [
    {
      "entityFilter": {
        "type": "CQL_FILTER",
        "category": "Service",
        "cqlVersion": "V1",
        "query": "text"
      },
      "type": "text"
    }
  ],
  "createdBy": {
    "dateCreated": "2025-03-29T00:50:13.438Z",
    "email": "text",
    "id": 1,
    "lastLogin": "2025-03-29T00:50:13.438Z",
    "name": "text",
    "oauthUserId": "text",
    "tenantId": 1,
    "timezone": "text"
  },
  "description": "text",
  "iconTag": "text",
  "isDraft": true,
  "lastUpdated": "2025-03-29T00:50:13.438Z",
  "minimumRoleRequired": "text",
  "name": "text",
  "proxyTag": "text",
  "tag": "text",
  "version": "text"
}

Metadata of the created plugin

Replace a plugin

put

Replace an existing plugin by tag

Authorizations

Path parameters

tagstringrequired

Unique identifier for the plugin

Body

blobstringrequired

The raw source code of the plugin. This should be an HTML file

contextsone of[]required

Which contexts the plugin should execute/show up in, e.g. { "type": "GLOBAL" }

descriptionstringoptional

Description of the plugin

iconTagstringoptional

Icon tag for the plugin

isDraftbooleanrequired

Whether the plugin is generally available or not

minimumRoleRequiredstringrequired

The minimum role required to view the plugin, e.g. VIEWER, USER, MANAGER, OWNER, or the tag for a custom role. Learn more about each permission in our docs.

namestringrequired

Display name of the plugin

proxyTagstringoptional

The identifier of the proxy to use for requests from this plugin

versionstringoptional

The version of the plugin

Responses

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.getcortexapp.com/api/v1/plugins/{tag}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "blob": "text",
    "contexts": [
      {
        "entityFilter": {
          "type": "CQL_FILTER",
          "category": "Service",
          "cqlVersion": "V1",
          "query": "text"
        },
        "type": "text"
      }
    ],
    "description": "text",
    "iconTag": "text",
    "isDraft": true,
    "minimumRoleRequired": "text",
    "name": "text",
    "proxyTag": "text",
    "version": "text"
  }'

200

400

404

429

200

{
  "contexts": [
    {
      "entityFilter": {
        "type": "CQL_FILTER",
        "category": "Service",
        "cqlVersion": "V1",
        "query": "text"
      },
      "type": "text"
    }
  ],
  "createdBy": {
    "dateCreated": "2025-03-29T00:50:13.438Z",
    "email": "text",
    "id": 1,
    "lastLogin": "2025-03-29T00:50:13.438Z",
    "name": "text",
    "oauthUserId": "text",
    "tenantId": 1,
    "timezone": "text"
  },
  "description": "text",
  "iconTag": "text",
  "isDraft": true,
  "lastUpdated": "2025-03-29T00:50:13.438Z",
  "minimumRoleRequired": "text",
  "name": "text",
  "proxyTag": "text",
  "tag": "text",
  "version": "text"
}

Metadata of the replaced plugin

Delete a plugin

delete

Delete a plugin by tag

Authorizations

Path parameters

tagstringrequired

Unique identifier for the plugin

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.getcortexapp.com/api/v1/plugins/{tag}' \
  --header 'Authorization: Bearer JWT'

204

404

429

204

No body

Plugin deleted