COcortex
Catalog Entities

Create or patch entity

Changed on

Creates or updates an entity using OpenAPI. If the YAML refers to an entity that already exists (as referenced by the x-cortex-tag), this API will merge the specified changes into the existing entity.

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

deleteMarkerValuestring

Delete keys with this value from the merged yaml, e.g. __delete__, if any values match this, they will not be included in merged YAML. For example my_value: __delete__ will remove my_value from the merged YAML.

appendArraysboolean

Default merge behavior is to replace arrays, set this to true to append arrays instead. For simple types, duplicate values will be removed from the merged array.

failIfEntityDoesNotExistboolean

Default behavior is to upsert the entity, set failIfEntityDoesNotExist=true to fail (404) if the entity specified in x-cortex-tag does not exist.

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 body was accepted, and the referenced x-cortex-tag existed and patched successfully

okboolean required

Changes