COcortex
Catalog Entities

Create or update entity

Changed on

Create a catalog entity using a descriptor YAML. By default (UPSERT mode), if the entity already exists (as referenced by the x-cortex-tag), this API will update the existing entity. In CREATE mode, the API will fail if the entity already exists.

post/api/v1/open-api

Request

  • Base URL
    https://api.getcortexapp.com
  • URL
    https://api.getcortexapp.com/api/v1/open-api
  • Auth
    HTTP bearer

Query parameters

dryRunboolean

When true, this endpoint only validates the descriptor contents and returns any errors or warnings.

githubPullRequestinteger

Add a comment with validation errors on the pull request with the given ID

mode'UPSERT' | 'CREATE'

Mode of operation: UPSERT (default) creates or updates existing entity, CREATE fails if entity already exists.

asyncUpdateWaitTimeMsinteger

Maximum time (milliseconds) to wait for asynchronous property updates. Default is zero.

Request body application/openapi;charset=UTF-8

string required

Response

Indicates that the entity was accepted and processed successfully

okboolean required

Changes