Reference
DEV3 Cogvane REST API
Base URL /api/v1 · Authenticate with Authorization: Bearer n3k_... · OpenAPI 3.1 JSON
/api/v1/mescope: readThe workspace this key belongs to
/api/v1/usagescope: readRuns and operations used in the current billing period
/api/v1/nodesscope: flows:readNode catalogue
/api/v1/flowsscope: flows:readList flows
Parameters: status (query), q (query), page (query), limit (query)
/api/v1/flowsscope: flows:writeCreate a flow by importing JSON (credentials by name only)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"flow": {},
"credentialMap": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string"
}
},
"required": [
"flow"
],
"additionalProperties": false
}/api/v1/flows/{id}scope: flows:readGet a flow with its draft graph
Parameters: id (path)
/api/v1/flows/{id}scope: flows:writeUpdate the draft (needs the current draftRev)
Parameters: id (path)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"draftRev": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"graph": {
"type": "object",
"properties": {
"cogvaneFlow": {
"type": "number",
"const": 1
},
"nodes": {
"type": "array",
"items": {}
},
"edges": {
"type": "array",
"items": {}
}
},
"required": [
"nodes",
"edges"
],
"additionalProperties": false
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"timezone": {
"type": "string"
}
},
"required": [
"draftRev"
],
"additionalProperties": false
}/api/v1/flows/{id}/publishscope: flows:writePublish the draft as a new immutable version
Parameters: id (path)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"note": {
"type": "string",
"maxLength": 300
},
"expectedVersionNo": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"additionalProperties": false
}/api/v1/flows/{id}/activatescope: flows:writeActivate the published version (triggers go live)
Parameters: id (path)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}/api/v1/flows/{id}/pausescope: flows:writePause a flow
Parameters: id (path)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}/api/v1/flows/{id}/versionsscope: flows:readList published versions
Parameters: id (path)
/api/v1/flows/{id}/exportscope: flows:readExport a flow as JSON (credential names only)
Parameters: id (path), version (query)
/api/v1/runsscope: runs:readList runs
Parameters: flow (query), status (query), from (query), page (query), limit (query)
/api/v1/runs/{id}scope: runs:readRun with steps (redacted previews)
Parameters: id (path)
/api/v1/flows/{id}/runsscope: runs:writeStart a run of the published version (manual trigger)
Parameters: id (path)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"input": {},
"idempotencyKey": {
"type": "string",
"maxLength": 200
}
},
"additionalProperties": false
}/api/v1/runs/{id}/retryscope: runs:writeRetry a failed, timed-out or cancelled run
Parameters: id (path)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"fromStep": {
"type": "boolean"
}
},
"additionalProperties": false
}/api/v1/runs/{id}/cancelscope: runs:writeCancel a run
Parameters: id (path)
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {},
"additionalProperties": false
}/api/v1/credentialsscope: vault:listList credential names (values are never returned)