Custom Data (Advanced)

Retrieve custom data for entity

get

Use this endpoint when attempting to delete custom data where the key contains non-alphanumeric characters. Otherwise, use the standard API under Custom Data.

Authorizations

Query parameters

tagstringrequired

Entity tag (x-cortex-tag), supports non-alphanumeric characters

keystringoptional

When set, returns the entity's value at this key. Otherwise, returns all custom data key/values for the entity.

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/catalog/custom-data?tag=text' \
  --header 'Authorization: Bearer JWT'

200

404

429

200

[
  {
    "dateUpdated": "2025-03-29T00:35:41.353Z",
    "description": "text",
    "id": 1,
    "key": "text",
    "source": "YAML",
    "value": {}
  }
]

Successfully retrieved custom data

Add custom data for entity

post

Authorizations

Query parameters

tagstringrequired

forcebooleanoptional

When true, overrides values that were defined in the catalog descriptor. Will be overwritten the next time the catalog descriptor is processed.

Body

descriptionstringoptional

keystringrequired

Custom data key for the entity

Example: my-key

valueobjectrequired

Value for the key; can be any valid JSON type

Example: {"nested":{"objects":"are ok"}}

Responses

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/catalog/custom-data?tag=text' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": "text",
    "key": "my-key",
    "value": {
      "nested": {
        "objects": "are ok"
      }
    }
  }'

200

400

404

429

200

{
  "dateUpdated": "2025-03-29T00:35:41.353Z",
  "description": "text",
  "id": 1,
  "key": "text",
  "source": "YAML",
  "value": {}
}

Successfully created data

Delete custom data by key for entity

delete

Use this endpoint when attempting to delete custom data where the key contains non-alphanumeric characters. Otherwise, use the standard API under Custom Data.

Authorizations

Query parameters

tagstringrequired

keystringrequired

forcebooleanoptional

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.getcortexapp.com/api/v1/catalog/custom-data?tag=text&key=text' \
  --header 'Authorization: Bearer JWT'

200

404

429

200

No body

Successfully deleted custom data