Groups

Use these operations to interact with groups on entities in Cortex.

Required permissions

Your API key must have the Edit entities permission.

Operations

Retrieve groups for entity

get

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Query parameters

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

200

Successfully retrieved groups

application/json

pageinteger · int32Required

Current page number, 0-indexed

totalinteger · int32Required

Total number of results

totalPagesinteger · int32Required

Total number of pages

404

Entity not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

get

/api/v1/catalog/{tagOrId}/groups

HTTPcURLJavaScriptPython

GET /api/v1/catalog/{tagOrId}/groups?pageSize=250&page=0 HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "groups": [
    {
      "tag": "text"
    }
  ],
  "page": 1,
  "total": 1,
  "totalPages": 1
}

Add groups to entity

put

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Body

application/json

Responses

200

Successfully created group memberships

application/json

pageinteger · int32Required

Current page number, 0-indexed

totalinteger · int32Required

Total number of results

totalPagesinteger · int32Required

Total number of pages

400

Bad Request

application/json

404

Entity not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

put

/api/v1/catalog/{tagOrId}/groups

HTTPcURLJavaScriptPython

PUT /api/v1/catalog/{tagOrId}/groups HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "groups": [
    {
      "tag": "text"
    }
  ]
}

{
  "groups": [
    {
      "tag": "text"
    }
  ],
  "page": 1,
  "total": 1,
  "totalPages": 1
}

Delete groups from entity

delete

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Body

application/json

Responses

200

Successfully deleted group memberships

No content

400

Bad Request

application/json

404

Entity not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

delete

/api/v1/catalog/{tagOrId}/groups

HTTPcURLJavaScriptPython

DELETE /api/v1/catalog/{tagOrId}/groups HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "groups": [
    {
      "tag": "text"
    }
  ]
}

No content