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

Path parameters

tagOrIdstringrequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Query parameters

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/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

429

200

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

Successfully retrieved groups

Add groups to entity

put

Authorizations

Path parameters

tagOrIdstringrequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Body

groupsobject[]required

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/catalog/{tagOrId}/groups' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "groups": [
      {
        "tag": "text"
      }
    ]
  }'

200

400

404

429

200

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

Successfully created group memberships

Delete groups from entity

delete

Authorizations

Path parameters

tagOrIdstringrequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Body

groupsobject[]required

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.getcortexapp.com/api/v1/catalog/{tagOrId}/groups' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "groups": [
      {
        "tag": "text"
      }
    ]
  }'

200

400

404

429

200

No body

Successfully deleted group memberships