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 · int32Required

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

Default: 250

pageinteger · int32Required

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

Default: 0

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/plugins HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

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

Get plugin by tag

get

Retrieve the metadata of a plugin by tag

Authorizations

Path parameters

tagstringRequired

Unique identifier for the plugin

Query parameters

includeBlobbooleanOptional

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

Default: false

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/plugins/{tag} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

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

Create a plugin

post

Create a new plugin

Authorizations

Body

blobstringRequired

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

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

post

HTTPcURLJavaScriptPython

POST /api/v1/plugins HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 279

{
  "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"
}

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

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

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

put

HTTPcURLJavaScriptPython

PUT /api/v1/plugins/{tag} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 266

{
  "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"
}

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

Delete a plugin

delete

Delete a plugin by tag

Authorizations

Path parameters

tagstringRequired

Unique identifier for the plugin

Responses

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/plugins/{tag} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

No content