Retrieve custom data for entity by key

GET 
/api/v1/catalog/:tag/custom-data/:key

Retrieve custom data for entity by key

Request

Path Parameters

tag stringrequired

The entity tag (x-cortex-tag) that identifies the entity.

key stringrequired

Responses

200

Successfully retrieved custom data for key

application/json

Schema

Schema

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

Possible values: [YAML, API, INTEGRATION]

value objectrequired

Example (from schema)

{
  "dateUpdated": "2024-05-07T00:00:25.835Z",
  "description": "string",
  "id": 0,
  "key": "string",
  "source": "YAML",
  "value": {}
}

404

Custom data not found for given entity and key

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