Dependencies

Use these operations to interact with dependencies in Cortex.

Required permissions

Your API key must have the Edit entities permission.

Operations

Retrieve all dependencies for an entity

get

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Path parameters

callerTagstringRequired

Query parameters

includeOutgoingbooleanOptionalDefault: true

includeIncomingbooleanOptionalDefault: false

pageSizeinteger · int32Required

Number of results to return per page, between 1 and 1000. Default 250.

Default: 250

pageinteger · int32Required

Page number to return, 0-indexed. Default 0.

Default: 0

Responses

200

Successfully found entity dependencies

application/json

404

Entity dependencies not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

get

/api/v1/catalog/{callerTag}/dependencies

HTTPcURLJavaScriptPython

GET /api/v1/catalog/{callerTag}/dependencies?pageSize=250&page=0 HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "calleeTag": "text",
  "calleeType": "text",
  "callerTag": "text",
  "callerType": "text",
  "description": "text",
  "metadata": {},
  "method": "text",
  "path": "text"
}

Retrieve dependency between entities

get

If a dependency exists between the callee and the caller, returns metadata about the edge.

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Path parameters

callerTagstringRequired

calleeTagstringRequired

Query parameters

methodstringOptional

pathstringOptional

Responses

200

Successfully found dependency

application/json

400

Invalid endpoint

application/json

404

Dependency not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

get

/api/v1/catalog/{callerTag}/dependencies/{calleeTag}

HTTPcURLJavaScriptPython

GET /api/v1/catalog/{callerTag}/dependencies/{calleeTag} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "calleeTag": "text",
  "calleeType": "text",
  "callerTag": "text",
  "callerType": "text",
  "description": "text",
  "metadata": {},
  "method": "text",
  "path": "text"
}

Create dependency from entity

post

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Path parameters

callerTagstringRequired

The entity tag (x-cortex-tag) for the callee entity ("from" entity)

calleeTagstringRequired

The entity tag (x-cortex-tag) for the caller entity ("to" entity)

Query parameters

methodstringOptional

HTTP Method

Example: POST

pathstringOptional

Body

application/json

descriptionstringOptional

metadataobjectOptional

Responses

201

Successfully created dependency

application/json

400

Invalid endpoint

application/json

404

Entity not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

post

/api/v1/catalog/{callerTag}/dependencies/{calleeTag}

HTTPcURLJavaScriptPython

POST /api/v1/catalog/{callerTag}/dependencies/{calleeTag} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "description": "text",
  "metadata": {}
}

{
  "calleeTag": "text",
  "calleeType": "text",
  "callerTag": "text",
  "callerType": "text",
  "description": "text",
  "metadata": {},
  "method": "text",
  "path": "text"
}

Create or update dependencies in bulk

put

This API allows you to create multiple dependencies for multiple entities at once.

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Body

application/json

Responses

200

Successfully created / updated dependencies

application/json

400

Cannot modify dependency that is defined in cortex.yaml

application/json

404

Entity not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

put

/api/v1/catalog/dependencies

HTTPcURLJavaScriptPython

PUT /api/v1/catalog/dependencies HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "values": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "description": "text",
        "metadata": {},
        "method": "text",
        "path": "text",
        "tag": "text"
      }
    ]
  }
}

{
  "values": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "description": "text",
        "metadata": {},
        "method": {},
        "path": "text",
        "tag": "text"
      }
    ]
  }
}

Update dependency between entities

put

If a dependency exists between two entities, replace the metadata with the payload. Note: This only supports dependencies created via the API.

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Path parameters

callerTagstringRequired

calleeTagstringRequired

Query parameters

methodstringOptional

pathstringOptional

Body

application/json

descriptionstringRequired

metadataobjectRequired

Responses

200

Successfully updated dependency

application/json

400

Invalid endpoint

application/json

404

Entity not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

put

/api/v1/catalog/{callerTag}/dependencies/{calleeTag}

HTTPcURLJavaScriptPython

PUT /api/v1/catalog/{callerTag}/dependencies/{calleeTag} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "description": "text",
  "metadata": {}
}

{
  "calleeTag": "text",
  "calleeType": "text",
  "callerTag": "text",
  "callerType": "text",
  "description": "text",
  "metadata": {},
  "method": "text",
  "path": "text"
}

Delete dependency

delete

Deletes a single dependency edge between the caller and the callee. Note: This is only supported for edges created via the API.

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Path parameters

callerTagstringRequired

calleeTagstringRequired

Query parameters

methodstringOptional

pathstringOptional

Responses

204

Successfully deleted dependency

application/json

400

Invalid endpoint

application/json

404

Dependency not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

delete

/api/v1/catalog/{callerTag}/dependencies/{calleeTag}

HTTPcURLJavaScriptPython

DELETE /api/v1/catalog/{callerTag}/dependencies/{calleeTag} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "calleeTag": "text",
  "calleeType": "text",
  "callerTag": "text",
  "callerType": "text",
  "description": "text",
  "metadata": {},
  "method": "text",
  "path": "text"
}

Delete dependencies from entity

delete

Deletes any outgoing dependencies from the entity. Note: this only deletes dependencies that were created via the API.

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Path parameters

callerTagstringRequired

Responses

204

Successfully deleted dependencies

application/json

404

Caller not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

delete

/api/v1/catalog/{callerTag}/dependencies

HTTPcURLJavaScriptPython

DELETE /api/v1/catalog/{callerTag}/dependencies HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "calleeTag": "text",
  "calleeType": "text",
  "callerTag": "text",
  "callerType": "text",
  "description": "text",
  "metadata": {},
  "method": "text",
  "path": "text"
}

Delete dependencies in bulk

delete

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Body

application/json

Responses

204

Successfully deleted dependencies

400

Cannot modify dependency that is defined in cortex.yaml

application/json

404

Entity not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

delete

/api/v1/catalog/dependencies

HTTPcURLJavaScriptPython

DELETE /api/v1/catalog/dependencies HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "values": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "description": "text",
        "metadata": {},
        "method": "text",
        "path": "text",
        "tag": "text"
      }
    ]
  }
}

No content