Dependencies
Use these operations to interact with dependencies in Cortex.
Required permissions
Your API key must have the Edit entities
permission.
Operations
true
false
Number of results to return per page, between 1 and 1000. Default 250.
250
Page number to return, 0-indexed. Default 0.
0
GET /api/v1/catalog/{callerTag}/dependencies HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"calleeTag": "text",
"calleeType": "text",
"callerTag": "text",
"callerType": "text",
"description": "text",
"metadata": {},
"method": "text",
"path": "text"
}
If a dependency exists between the callee
and the caller
, returns metadata about the edge.
GET /api/v1/catalog/{callerTag}/dependencies/{calleeTag} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"calleeTag": "text",
"calleeType": "text",
"callerTag": "text",
"callerType": "text",
"description": "text",
"metadata": {},
"method": "text",
"path": "text"
}
The entity tag (x-cortex-tag) for the callee entity ("from" entity)
The entity tag (x-cortex-tag) for the caller entity ("to" entity)
HTTP Method
POST
POST /api/v1/catalog/{callerTag}/dependencies/{calleeTag} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
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"
}
This API allows you to create multiple dependencies for multiple entities at once.
PUT /api/v1/catalog/dependencies HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
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"
}
]
}
}
If a dependency exists between two entities, replace the metadata with the payload. Note: This only supports dependencies created via the API.
PUT /api/v1/catalog/{callerTag}/dependencies/{calleeTag} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
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"
}
Deletes a single dependency edge between the caller
and the callee
.
Note: This is only supported for edges created via the API.
DELETE /api/v1/catalog/{callerTag}/dependencies/{calleeTag} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"calleeTag": "text",
"calleeType": "text",
"callerTag": "text",
"callerType": "text",
"description": "text",
"metadata": {},
"method": "text",
"path": "text"
}
Deletes any outgoing dependencies from the entity. Note: this only deletes dependencies that were created via the API.
DELETE /api/v1/catalog/{callerTag}/dependencies HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"calleeTag": "text",
"calleeType": "text",
"callerTag": "text",
"callerType": "text",
"description": "text",
"metadata": {},
"method": "text",
"path": "text"
}
DELETE /api/v1/catalog/dependencies HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 120
{
"values": {
"ANY_ADDITIONAL_PROPERTY": [
{
"description": "text",
"metadata": {},
"method": "text",
"path": "text",
"tag": "text"
}
]
}
}
No content
Last updated
Was this helpful?