Retrieve custom data for entity

GET 
/api/v1/catalog/custom-data

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

Request

Query Parameters

tag stringrequired

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

key string

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

Responses

200

Successfully retrieved custom data

application/json

Schema

Schema

• Array [

dateUpdated date-timerequired
description string
id int64
key stringrequired
source stringrequired

Possible values: [YAML, API, INTEGRATION]

value objectrequired

• ]

Example (from schema)

[
  {
    "dateUpdated": "2024-04-26T18:10:53.872Z",
    "description": "string",
    "id": 0,
    "key": "string",
    "source": "YAML",
    "value": {}
  }
]

404

Entity not found

application/json

Schema

Schema

details string
gatewayHttpStatus int32
httpStatus int32
message stringrequired
requestId string
type stringrequired

Possible values: [INTEGRATION_MISSING, INTEGRATION_UNREGISTERED, INTEGRATION_UNSUPPORTED, INTEGRATION_GRAPHQL_ERROR, INTEGRATION_BAD_REQUEST, INTEGRATION_UNAUTHORIZED, INTEGRATION_FORBIDDEN, INTEGRATION_NOT_FOUND, INTEGRATION_UNPROCESSABLE_CONTENT, INTEGRATION_RATE_LIMITED, INTEGRATION_INTERNAL_ERROR, INTEGRATION_NOT_IMPLEMENTED, INTEGRATION_BAD_GATEWAY, INTEGRATION_UNAVAILABLE, INTEGRATION_GATEWAY_TIMEOUT, INTEGRATION_TIMED_OUT, INTEGRATION_CACHE_ERROR, INTEGRATION_UNHANDLED_HTTP_ERROR, INTEGRATION_UNHANDLED_EXCEPTION, INTEGRATION_UNEXPECTED_ERROR, ILLEGAL_ARGUMENT_ERROR, BAD_REQUEST, FORBIDDEN, NOT_FOUND, REQUEST_TIMEOUT, CONFLICT, UNHANDLED_EXCEPTION, UNCATEGORIZED, SERVICE_CREATOR, UNKNOWN_HOST]

Example (from schema)

{
  "details": "string",
  "gatewayHttpStatus": 0,
  "httpStatus": 0,
  "message": "string",
  "requestId": "string",
  "type": "INTEGRATION_MISSING"
}

Loading...