Cortex Custom Data [Advanced] API

openapi: 3.2.0
info:
  description: The Cortex REST API provides programmatic access to the data in the catalog, Scorecards, and more.
  title: Cortex Custom Data [Advanced] API
  version: v1
servers:
- url: https://api.getcortexapp.com
  description: Cortex Cloud API host
security:
- bearerAuth: []
tags:
- name: Custom Data [Advanced]
paths:
  /api/v1/catalog/custom-data:
    delete:
      description: Use this endpoint when attempting to delete custom data where the key contains non-alphanumeric characters. Otherwise, use the standard API under `Custom Data`.
      operationId: getCustomDataForEntityByKeyAdvanced
      parameters:
      - in: query
        name: tag
        required: true
        schema:
          type: string
      - in: query
        name: key
        required: true
        schema:
          type: string
      - in: query
        name: force
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: Successfully deleted custom data
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Entity not found
        '429':
          $ref: '#/components/responses/TooManyRequests'
      summary: Delete custom data by key for entity
      tags:
      - Custom Data [Advanced]
      x-cortex-mcp-description: Cortex Custom Data (Advanced) - Read an entity's custom data when the tag or key cannot sit in a path segment
      x-cortex-mcp-enabled: 'false'
    get:
      description: Use this endpoint when attempting to delete custom data where the key contains non-alphanumeric characters. Otherwise, use the standard API under `Custom Data`.
      operationId: retrieveCustomDataForEntityAdvanced
      parameters:
      - description: Entity tag (x-cortex-tag), supports non-alphanumeric characters
        in: query
        name: tag
        required: true
        schema:
          type: string
      - description: When set, returns the entity's value at this key. Otherwise, returns all custom data key/values for the entity.
        in: query
        name: key
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomData'
          description: Successfully retrieved custom data
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Entity not found
        '429':
          $ref: '#/components/responses/TooManyRequests'
      summary: Retrieve custom data for entity
      tags:
      - Custom Data [Advanced]
      x-cortex-mcp-description: List an entity's custom data, taking the entity tag as a query parameter. Use this form when the tag contains characters that cannot sit in a path segment; otherwise use getCustomDataForEntity.
      x-cortex-mcp-enabled: 'true'
    post:
      operationId: addCustomDataForEntityAdvanced
      parameters:
      - in: query
        name: tag
        required: true
        schema:
          type: string
      - description: When true, overrides values that were defined in the catalog descriptor. Will be overwritten the next time the catalog descriptor is processed.
        in: query
        name: force
        required: false
        schema:
          type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataCreateRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomData'
          description: Successfully created data
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Invalid custom data request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Entity not found
        '429':
          $ref: '#/components/responses/TooManyRequests'
      summary: Add custom data for entity
      tags:
      - Custom Data [Advanced]
      x-cortex-mcp-description: 'Set one custom data key on an entity whose tag is passed as a query parameter. Use this form when the tag contains characters that cannot go in a path segment; otherwise use addCustomDataForEntity. Works the same way: upsert by key, and overwriting a key from another source needs force=true.'
      x-cortex-mcp-enabled: 'true'
components:
  schemas:
    DataCreateRequest:
      required:
      - key
      - value
      type: object
      properties:
        description:
          type: string
        key:
          type: string
          description: Custom data key for the entity
          example: my-key
        value:
          $ref: '#/components/schemas/JsonNode'
    CustomData:
      required:
      - dateUpdated
      - key
      - source
      - value
      type: object
      properties:
        dateUpdated:
          type: string
          format: date-time
        description:
          type: string
        id:
          type: integer
          format: int64
        key:
          type: string
        source:
          type: string
          enum:
          - YAML
          - API
          - INTEGRATION
        value:
          $ref: '#/components/schemas/JsonNode'
    ErrorResponse:
      required:
      - message
      - type
      type: object
      properties:
        details:
          type: string
        errorCode:
          type: string
        gatewayHttpStatus:
          type: integer
          format: int32
        httpStatus:
          type: integer
          format: int32
        message:
          type: string
        requestId:
          type: string
        type:
          type: string
          enum:
          - 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
          - TOO_MANY_REQUESTS
    JsonNode:
      type: object
    TooManyRequestsProblemDetail:
      required:
      - type
      - title
      - status
      type: object
      properties:
        detail:
          type: string
        instance:
          type: string
          format: uri-reference
        retryAfter:
          minimum: 0
          type: integer
          description: The number of seconds until the rate limiting resets.
          format: int32
        status:
          maximum: 599
          minimum: 100
          type: integer
          format: int32
          enum:
          - 429
        title:
          type: string
        type:
          type: string
          format: uri-reference
  responses:
    TooManyRequests:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/TooManyRequestsProblemDetail'
      description: The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
      headers:
        Retry-After:
          description: The number of seconds until the rate limiting resets.
          schema:
            minimum: 0
            type: integer
            format: int32
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      description: 'All requests to the Cortex API need to provide an `Authorization: Bearer <token>` header, where `<token>` is an API key created in the Settings page of your workspace.'
      scheme: bearer
      type: http
x-provenance:
  method: harvested
  publisher: Cortex
  source: https://docs.cortex.io/openapi/cortex_swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)