Plugins
Use these operations to interact with plugins in Cortex.
Required permissions
Your API key must have the Edit plugins
permission.
Operations
Retrieve a list of all plugins, excluding drafts
Number of results to return per page, between 1 and 1000. Default 250.
250
Page number to return, 0-indexed. Default 0.
0
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-06-28T19:23:57.339Z",
"email": "text",
"id": 1,
"lastLogin": "2025-06-28T19:23:57.339Z",
"name": "text",
"oauthUserId": "text",
"tenantId": 1,
"timezone": "text"
},
"description": "text",
"iconTag": "text",
"isDraft": true,
"lastUpdated": "2025-06-28T19:23:57.339Z",
"minimumRoleRequired": "text",
"name": "text",
"proxyTag": "text",
"tag": "text",
"version": "text"
}
],
"total": 1,
"totalPages": 1
}
Retrieve the metadata of a plugin by tag
Unique identifier for the plugin
When true, returns the plugin blob. Defaults to false.
false
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-06-28T19:23:57.339Z",
"email": "text",
"id": 1,
"lastLogin": "2025-06-28T19:23:57.339Z",
"name": "text",
"oauthUserId": "text",
"tenantId": 1,
"timezone": "text"
},
"description": "text",
"iconTag": "text",
"isDraft": true,
"lastUpdated": "2025-06-28T19:23:57.339Z",
"minimumRoleRequired": "text",
"name": "text",
"proxyTag": "text",
"tag": "text",
"version": "text"
}
Create a new plugin
The raw source code of the plugin. This should be an HTML file
Description of the plugin
Icon tag for the plugin
Whether the plugin is generally available or not
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.
Display name of the plugin
The identifier of the proxy to use for requests from this plugin
Unique identifier for the plugin
The version of the plugin
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-06-28T19:23:57.339Z",
"email": "text",
"id": 1,
"lastLogin": "2025-06-28T19:23:57.339Z",
"name": "text",
"oauthUserId": "text",
"tenantId": 1,
"timezone": "text"
},
"description": "text",
"iconTag": "text",
"isDraft": true,
"lastUpdated": "2025-06-28T19:23:57.339Z",
"minimumRoleRequired": "text",
"name": "text",
"proxyTag": "text",
"tag": "text",
"version": "text"
}
Replace an existing plugin by tag
Unique identifier for the plugin
The raw source code of the plugin. This should be an HTML file
Description of the plugin
Icon tag for the plugin
Whether the plugin is generally available or not
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.
Display name of the plugin
The identifier of the proxy to use for requests from this plugin
The version of the plugin
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-06-28T19:23:57.339Z",
"email": "text",
"id": 1,
"lastLogin": "2025-06-28T19:23:57.339Z",
"name": "text",
"oauthUserId": "text",
"tenantId": 1,
"timezone": "text"
},
"description": "text",
"iconTag": "text",
"isDraft": true,
"lastUpdated": "2025-06-28T19:23:57.339Z",
"minimumRoleRequired": "text",
"name": "text",
"proxyTag": "text",
"tag": "text",
"version": "text"
}
Delete a plugin by tag
Unique identifier for the plugin
DELETE /api/v1/plugins/{tag} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
No content
Last updated
Was this helpful?