Cortex

Cortex API Keys API

The API Keys API from Cortex — 2 operation(s) for api keys.

GitHub OpenAPI

Operations 5

GET /api/v1/auth/key List API keys #
POST /api/v1/auth/key Create API key #
DELETE /api/v1/auth/key/{cid} Delete API key #
GET /api/v1/auth/key/{cid} Get API key #
PUT /api/v1/auth/key/{cid} Update API key #

Documentation

📖
Documentation
https://docs.cortex.io/api
📖
APIReference
https://docs.cortex.io/api/readme/catalog-entities
📖
APIReference
https://docs.cortex.io/api/readme/scorecards
📖
APIReference
https://docs.cortex.io/api/readme/custom-data
📖
APIReference
https://docs.cortex.io/api/readme/initiatives
📖
APIReference
https://docs.cortex.io/api/readme/deploys
📖
APIReference
https://docs.cortex.io/api/readme/integrations/github

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cortex-idp/refs/heads/main/openapi/cortex-idp-api-keys-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/cortex-idp/refs/heads/main/collections/cortex-idp.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/cortex-idp/refs/heads/main/collections/cortex-idp.opencollection.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cortex-idp:cortex-idp-api-keys-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cortex-idp-api-keys-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: The Cortex REST API provides programmatic access to the data in the catalog, Scorecards, and more.
  title: Cortex API Keys API
  version: v1
servers:
- url: https://api.getcortexapp.com
  description: Cortex Cloud API host
security:
- bearerAuth: []
tags:
- name: API Keys
paths:
  /api/v1/auth/key:
    get:
      description: 'List API keys


        The API key used to make the request must have the `Edit API keys` permission'
      operationId: listApiKey
      parameters:
      - description: Number of results to return per page, between 1 and 1000. Default 250.
        in: query
        name: pageSize
        required: true
        schema:
          type: integer
          format: int32
          default: 250
      - description: Page number to return, 0-indexed. Default 0.
        in: query
        name: page
        required: true
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListApiKeyResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/ListApiKeyResponse'
          description: Successfully found API keys
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '429':
          $ref: '#/components/responses/TooManyRequests'
      summary: List API keys
      tags:
      - API Keys
      x-cortex-mcp-enabled: 'false'
    post:
      description: 'Create new API key.


        The API key used to make the request must have the `Edit API keys` permission'
      operationId: createApiKey
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateApiRequest'
          application/yaml:
            schema:
              $ref: '#/components/schemas/CreateApiRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateApiResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/CreateApiResponse'
          description: Successfully created API key
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Access denied
        '429':
          $ref: '#/components/responses/TooManyRequests'
      summary: Create API key
      tags:
      - API Keys
      x-cortex-mcp-enabled: 'false'
  /api/v1/auth/key/{cid}:
    delete:
      description: 'Delete API key


        The API key used to make the request must have the `Edit API keys` permission'
      operationId: deleteApiKey
      parameters:
      - description: The unique, auto-generated identifier for the API key
        example: ak1234567890abcdef
        in: path
        name: cid
        required: true
        schema:
          type: string
          description: The unique, auto-generated identifier for the API key
          example: ak1234567890abcdef
      responses:
        '200':
          description: Successfully deleted API key
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Access denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: API key not found
        '429':
          $ref: '#/components/responses/TooManyRequests'
      summary: Delete API key
      tags:
      - API Keys
      x-cortex-mcp-enabled: 'false'
    get:
      operationId: getApiKey
      parameters:
      - description: The unique, auto-generated identifier for the API key
        example: ak1234567890abcdef
        in: path
        name: cid
        required: true
        schema:
          type: string
          description: The unique, auto-generated identifier for the API key
          example: ak1234567890abcdef
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyDefinition'
            application/yaml:
              schema:
                $ref: '#/components/schemas/ApiKeyDefinition'
          description: Successfully found API key
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: API key not found
        '429':
          $ref: '#/components/responses/TooManyRequests'
      summary: Get API key
      tags:
      - API Keys
      x-cortex-mcp-enabled: 'false'
    put:
      description: 'Update API key


        The API key used to make the request must have the `Edit API keys` permission'
      operationId: updateApiKey
      parameters:
      - description: The unique, auto-generated identifier for the API key
        example: ak1234567890abcdef
        in: path
        name: cid
        required: true
        schema:
          type: string
          description: The unique, auto-generated identifier for the API key
          example: ak1234567890abcdef
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateApiRequest'
          application/yaml:
            schema:
              $ref: '#/components/schemas/UpdateApiRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyDefinition'
            application/yaml:
              schema:
                $ref: '#/components/schemas/ApiKeyDefinition'
          description: Successfully updated API key
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Access denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
            application/yaml:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: API key not found
        '429':
          $ref: '#/components/responses/TooManyRequests'
      summary: Update API key
      tags:
      - API Keys
      x-cortex-mcp-enabled: 'false'
components:
  schemas:
    ApiKeyRole:
      required:
      - type
      type: object
      properties:
        type:
          type: string
          description: The type of the role
          enum:
          - DEFAULT
          - CUSTOM
      description: Roles assigned to the API key
      discriminator:
        propertyName: type
      oneOf:
      - $ref: '#/components/schemas/DEFAULT'
      - $ref: '#/components/schemas/CUSTOM'
    ApiKeyDefinition:
      required:
      - cid
      - createdDate
      - last4
      - roles
      type: object
      properties:
        cid:
          type: string
          description: ID of the API key
          example: ak1234567890abcdef
        createdDate:
          type: string
          description: Creation date of the API key
          format: date-time
          example: '2025-01-15T22:47:30Z'
        description:
          type: string
          description: Description of the API key
          example: API Key used for entities scanner script
        expirationDate:
          type: string
          description: Expiration date of the API key
          format: date-time
        last4:
          type: string
          description: Last 4 characters of the API key
          example: 0kAg
        name:
          type: string
          description: Name of the API key
          example: Entities scanner
        roles:
          type: array
          description: Roles assigned to the API key
          items:
            $ref: '#/components/schemas/ApiKeyRole'
    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
    CUSTOM:
      type: object
      allOf:
      - $ref: '#/components/schemas/ApiKeyRole'
      - required:
        - tag
        - type
        type: object
        properties:
          tag:
            type: string
            description: Tag of the [custom role](https://docs.cortex.io/docs/walkthroughs/workspace-settings/permissioning/custom-roles)
          type:
            type: string
    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
    ListApiKeyResponse:
      required:
      - apiKeys
      - page
      - total
      - totalPages
      type: object
      properties:
        apiKeys:
          type: array
          description: List of API keys
          items:
            $ref: '#/components/schemas/ApiKeyDefinition'
        page:
          type: integer
          description: Current page number, 0-indexed
          format: int32
        total:
          type: integer
          description: Total number of results
          format: int32
        totalPages:
          type: integer
          description: Total number of pages
          format: int32
    CreateApiRequest:
      required:
      - name
      - roles
      type: object
      properties:
        description:
          type: string
          description: Description of the API key
          example: API Key used for entities scanner script
        expirationDate:
          type: string
          description: 'Expiration date of the API key. Format: ISO8601 with timezone offset'
          format: date-time
        name:
          type: string
          description: Name of the API key
          example: Entities scanner
        roles:
          type: array
          description: Roles assigned to the API key
          items:
            $ref: '#/components/schemas/ApiKeyRole'
    CreateApiResponse:
      required:
      - apiKey
      - roles
      type: object
      properties:
        apiKey:
          type: string
          description: Value of the API key created. **You will not be able to see this key again**
          example: 3WpQ3WpQ3WpQ3WpQ
        description:
          type: string
          description: Description of the API key
          example: API Key used for entities scanner script
        expirationDate:
          type: string
          description: Expiration date of the API key
          format: date-time
        name:
          type: string
          description: Name of the API key
          example: Entities scanner
        roles:
          type: array
          description: Roles assigned to the API key
          items:
            $ref: '#/components/schemas/ApiKeyRole'
    DEFAULT:
      type: object
      allOf:
      - $ref: '#/components/schemas/ApiKeyRole'
      - required:
        - role
        - type
        type: object
        properties:
          role:
            type: string
            description: The role of the API key
            enum:
            - READ_ONLY
            - USER
            - ADMIN
          type:
            type: string
    UpdateApiRequest:
      required:
      - name
      type: object
      properties:
        description:
          type: string
          description: Description of the API key
          example: API Key used for entities scanner script
        name:
          type: string
          description: Name of the API key
          example: Entities scanner
  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)