Groups

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

Required permissions

Your API key must have the Edit entities permission.

Operations

Last updated 2 months ago

Was this helpful?

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

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

GET /api/v1/catalog/{tagOrId}/groups HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

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

Add groups to entity

put

Authorizations

Path parameters

tagOrIdstringRequired

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

Body

Responses

200

Successfully created group memberships

application/json

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

PUT /api/v1/catalog/{tagOrId}/groups HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
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

Path parameters

tagOrIdstringRequired

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

Body

Responses

200

Successfully deleted group memberships

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

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

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

No content