Cortex Catalog API

The Catalog API from Cortex — 8 operation(s) for catalog.

OpenAPI Specification

cortex-catalog-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Cortex REST Catalog API
  version: '1.0'
  description: Minimal OpenAPI description of the Cortex REST API covering catalog entities, scorecards, and teams. Generated from Cortex public documentation.
  x-generated-from: https://docs.cortex.io/
  x-generated-by: claude-crawl-2026-05-08
servers:
- url: https://api.getcortexapp.com
  description: Cortex API
security:
- bearerAuth: []
tags:
- name: Catalog
paths:
  /api/v1/catalog:
    get:
      tags:
      - Catalog
      summary: List catalog entities
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
    delete:
      tags:
      - Catalog
      summary: Delete entities by type
      responses:
        '204':
          description: No Content
  /api/v1/catalog/descriptors:
    get:
      tags:
      - Catalog
      summary: List entity descriptors
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
  /api/v1/catalog/{tagOrId}:
    parameters:
    - $ref: '#/components/parameters/TagOrId'
    get:
      tags:
      - Catalog
      summary: Retrieve entity details
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
    delete:
      tags:
      - Catalog
      summary: Delete an entity
      responses:
        '204':
          description: No Content
  /api/v1/catalog/{tagOrId}/openapi:
    parameters:
    - $ref: '#/components/parameters/TagOrId'
    get:
      tags:
      - Catalog
      summary: Retrieve entity OpenAPI descriptor
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
  /api/v1/catalog/{tagOrId}/scorecards:
    parameters:
    - $ref: '#/components/parameters/TagOrId'
    get:
      tags:
      - Catalog
      summary: Retrieve scorecard scores for an entity
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
  /api/v1/catalog/{tagOrId}/archive:
    parameters:
    - $ref: '#/components/parameters/TagOrId'
    put:
      tags:
      - Catalog
      summary: Archive an entity
      responses:
        '200':
          description: OK
  /api/v1/catalog/{tagOrId}/unarchive:
    parameters:
    - $ref: '#/components/parameters/TagOrId'
    put:
      tags:
      - Catalog
      summary: Unarchive an entity
      responses:
        '200':
          description: OK
  /api/v1/open-api:
    post:
      tags:
      - Catalog
      summary: Create or update entity from OpenAPI descriptor
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: OK
    patch:
      tags:
      - Catalog
      summary: Patch entity from OpenAPI descriptor
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: OK
components:
  parameters:
    TagOrId:
      name: tagOrId
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer