Cortex V6 (6.4.0)

Download OpenAPI specification:Download

Cortex V6 REST apis for managing: Agents, Connections, Managed content, Secrets, Sessions, Skills, and Tasks

Agent and Skill Activations

Operations for granting/revoking access to different internal resources

Find out more about RBAC within Cortex

List agent and skill activations/ecxecutions

List activations in a project

Authorizations:

BearerAuth

path Parameters

projectId

required

string

query Parameters

filter	string
limit	number <double>
skip	number <double>
sort	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"activations": null
}

Get activationId and project

Get activation by activationId and project

Authorizations:

BearerAuth

path Parameters

projectId required	string
activationId required	string

query Parameters

verbose	string
report	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null
}

Get agent's activations

Get activation by agent name and activationId

Authorizations:

BearerAuth

path Parameters

projectId required	string
agentName required	string
activationId required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null
}

List activations by agent name

List activation by agent name

Authorizations:

BearerAuth

path Parameters

projectId required	string
agentName required	string

query Parameters

filter	string
limit	number <double>
skip	number <double>
sort	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"activations": null
}

Agents

Agents orchestrate skills and publish service endpoints

Find out more on Agents

List Agents within a project

Gets a list of agents within a project

Authorizations:

BearerAuth

path Parameters

projectId

required

string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0,
"skills": [{"name": "string",
"_projectId": "string",
"title": "string",
"description": "string",
"tags": [{"label": "string",
"value": "string"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"deleted": true,
"version": 0
}
]
}

Save an Agent within a project

Save an agent within a project

Authorizations:

BearerAuth

path Parameters

projectId

required

string

Request Body schema: application/json

Any of

name required	string
type required	string
image required	string
description	string
command	Array of strings
	string or number
scaleCount	number <double>
k8sResources	Array of any
environmentVariables	any

Responses

Request samples

Payload

Content type

application/json

Example

AgentSaveRequest

{"name": "string",
"type": "string",
"image": "string",
"description": "string",
"command": ["string"
],
"port": "string",
"scaleCount": 0,
"k8sResources": [null
],
"environmentVariables": null
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0,
"version": 0,
"created": "2019-08-24T14:15:22Z"
}

Describe an Agent within a project

Describes an agent within a project

Authorizations:

BearerAuth

path Parameters

projectId required	string
name required	string

query Parameters

verbose

boolean

Responses

Response samples

200

Content type

application/json

{"name": "string",
"camel": "string",
"title": "string",
"description": "string",
"inputs": [null
],
"outputs": [null
],
"properties": [null
],
"tags": [{"label": "string",
"value": "string"
}
]
}

Delete an Agent within a project

Deletes an agent within a project

Authorizations:

BearerAuth

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0
}

Redeploy an Agent to kubernetes

Upsert kubernetes agent resource and start pods if needed

Authorizations:

BearerAuth

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0
}

Undeploy an Agent from kubernetes

Remove kubernetes agent resource and stop existing pods

Authorizations:

BearerAuth

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0
}

Get Agent version information

Get version details for an agent, including: version, updatedAt, and author

Authorizations:

BearerAuth

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0,
"versions": [{"version": 0,
"updatedAt": "2019-08-24T14:15:22Z",
"author": "string"
}
]
}

Get agent dependencies

Get dependencies of an agent

Authorizations:

BearerAuth

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0,
"dependencies": null
}

List an agent's snapshots

Authorizations:

BearerAuth

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0,
"snapshots": [{"snapshotId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"agentName": "string",
"createdBy": "2019-08-24T14:15:22Z",
"title": "string",
"isTip": true,
"agent": null,
"dependencies": null
}
]
}

Create agent snapshot

Create an agent snapshot for the selected agent/

Authorizations:

BearerAuth

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0,
"snapshotId": "string"
}

Get a snapshot by id

Get an snapshot using it's unique id.

Authorizations:

BearerAuth

path Parameters

projectId required	string
snapshotId required	string

query Parameters

verbose	boolean
deps	boolean
output	string

Responses

Response samples

200

Content type

application/json

Example

SnapshotGetResponse

{"snapshotId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"agentName": "string",
"createdBy": "2019-08-24T14:15:22Z",
"title": "string",
"isTip": true,
"agent": null,
"dependencies": null,
"success": true,
"message": "string",
"details": null,
"code": 0
}

Deletes an snapshot within a project

Authorizations:

BearerAuth

path Parameters

projectId required	string
snapshotId required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0
}

Invoke and agent's service asynchronously, returns an activationId

Invoke agent service

Authorizations:

BearerAuth

path Parameters

projectId required	string project
agentName required	string agent name
serviceName required	string service to invoke

query Parameters

sync	string true\|false execute synchronously if supported (default: false)
scheduleCron	string Schedule agent to invoke to repeat each cron interval
scheduleName	string name of schedule (default: )

Request Body schema: application/json

sessionId	string
payload	object
properties	object
correlationId	string

Responses

Request samples

Payload

Content type

application/json

{"sessionId": "string",
"payload": {"property1": null,
"property2": null
},
"properties": {"property1": null,
"property2": null
},
"correlationId": "string"
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"activationId": "string",
"response": {"property1": null,
"property2": null
}
}

Get agent service execution plan and diagram in dot notation

Get agent service execution plan

Authorizations:

BearerAuth

path Parameters

projectId required	string
agentName required	string
serviceName required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"plan": null,
"diagram": "string"
}

Get agent's activations

Get activation by agent name and activationId

Authorizations:

BearerAuth

path Parameters

projectId required	string
agentName required	string
activationId required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null
}

List activations by agent name

List activation by agent name

Authorizations:

BearerAuth

path Parameters

projectId required	string
agentName required	string

query Parameters

filter	string
limit	number <double>
skip	number <double>
sort	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"activations": null
}

Connections

Create and manage connections to Data Sources such as files, databases, and cloud storage; connections are used to create datasets in Fabric.

Find out more about connections within Cortex

Fetch a connection type by name

Get connection type by name

path Parameters

name

required

string

Name of an existing connection type to fetch

Responses

Response samples

200

Content type

application/json

{"group": "string",
"type": "string",
"typeIcon": "string",
"groupIcon": "string",
"contentType": ["string"
],
"dataConnectors": ["string"
],
"title": "string",
"name": "string",
"description": "string",
"tags": [{"_id": null,
"label": "string",
"value": "string"
}
],
"_id": null,
"hidden": true,
"connectionParams": [{"validValues": [null
],
"name": "string",
"title": "string",
"description": "string",
"type": "string",
"required": true,
"secure": true,
"defaultValue": null,
"validation": "string",
"errorMessage": "string"
}
],
"connectionQueryParams": [null
],
"connectionWriteParams": [null
]
}

List Connection Types

Fetch supported connection types

query Parameters

filter	string Mongo Filter to filter request
skip	number <double> Skip number
limit	number <double> Limit the number of objects
sort	string Sort criteria

Responses

Response samples

200

Content type

application/json

{"success": true,
"connectionTypes": [{"group": "string",
"type": "string",
"typeIcon": "string",
"groupIcon": "string",
"contentType": ["string"
],
"dataConnectors": ["string"
],
"title": "string",
"name": "string",
"description": "string",
"tags": [{"_id": null,
"label": "string",
"value": "string"
}
],
"_id": null,
"hidden": true,
"connectionParams": [{"validValues": [null
],
"name": "string",
"title": "string",
"description": "string",
"type": "string",
"required": true,
"secure": true,
"defaultValue": null,
"validation": "string",
"errorMessage": "string"
}
],
"connectionQueryParams": [null
],
"connectionWriteParams": [null
]
}
]
}

List connections

path Parameters

projectId

required

string

Responses

Response samples

200

Content type

application/json

{"success": true,
"connections": [{"_id": null,
"name": "string",
"title": "string",
"description": "string",
"connectionType": "string",
"allowWrite": true,
"params": [{"name": "string",
"value": "string",
"_id": null
}
],
"contentType": "string",
"camel": "string",
"allowRead": true,
"tags": [{"_id": null,
"label": "string",
"value": "string"
}
],
"createdAt": null,
"updatedAt": null,
"_version": 0
}
],
"message": "string",
"details": [null
]
}

Create a connection

path Parameters

projectId

required

string

Request Body schema: application/json

_id	any
name required	string
title required	string
description	string
connectionType	string
allowWrite	boolean
	Array of objects (_Params)
contentType	string or null
camel	string
allowRead	boolean
	Array of objects (Tag1)
createdAt	any
updatedAt	any
_version	number <double>

Responses

Request samples

Payload

Content type

application/json

{"_id": null,
"name": "string",
"title": "string",
"description": "string",
"connectionType": "string",
"allowWrite": true,
"params": [{"name": "string",
"value": "string",
"_id": null
}
],
"contentType": "string",
"camel": "string",
"allowRead": true,
"tags": [{"_id": null,
"label": "string",
"value": "string"
}
],
"createdAt": null,
"updatedAt": null,
"_version": 0
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0
}

Get connection by name

Fetch a connection

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"_id": null,
"name": "string",
"title": "string",
"description": "string",
"connectionType": "string",
"allowWrite": true,
"params": [{"name": "string",
"value": "string",
"_id": null
}
],
"contentType": "string",
"camel": "string",
"allowRead": true,
"tags": [{"_id": null,
"label": "string",
"value": "string"
}
],
"createdAt": null,
"updatedAt": null,
"_version": 0
}

Delete a connection

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string"
}

Health check

Platform Healthchecks and information endpoints

Check service statuses, and fail if any are unhealthy

Get service status for all platform services, return 500 status code if any services are unhealthy. This request is unauthenticated.

Responses

Response samples

200
500

Content type

application/json

{"version": "string",
"healths": [{"health": null,
"version": "string",
"name": "string",
"healthy": true,
"message": "string"
}
],
"deployType": "string",
"endpoints": null,
"serverTs": 0
}

Check service statuses, do not fail if any are unhealthy

Get service status for all platform services, return a 218 status code if unhealthy. This request is unauthenticated. This allows for http clients to safely fetch status and not throw a request error, if there are any unhealthy services.

Responses

Response samples

200
218

Content type

application/json

{"version": "string",
"healths": [{"health": null,
"version": "string",
"name": "string",
"healthy": true,
"message": "string"
}
],
"deployType": "string",
"endpoints": null,
"serverTs": 0
}

Check service statuses, do not fail if any are unhealthy

Get service status for all platform services, return a 218 status code if unhealthy. Require authentication This allows for http clients to safely fetch status and not throw a request error, if there are any unhealthy services. Include endpoints object containing useful URLs

Authorizations:

BearerAuth

Responses

Response samples

200
218

Content type

application/json

{"version": "string",
"healths": [{"health": null,
"version": "string",
"name": "string",
"healthy": true,
"message": "string"
}
],
"deployType": "string",
"endpoints": null,
"serverTs": 0
}

Impact Assessments

Create and manage Impact Assessments

Find out more on assessments

List resource types

List known assessment resource types

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0,
"data": ["string"
]
}

List assessed resources

List assessed resource by project or resource type

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0,
"data": ["string"
]
}

Create assessment for component

Create an assessment for a given resource type, scope (project), and component

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0
}

List assessments

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0,
"data": [{"name": "string",
"title": "string",
"tags": [{"label": "string",
"value": "string"
}
],
"_createAt": "2019-08-24T14:15:22Z",
"_updatedAt": "2019-08-24T14:15:22Z",
"_createdBy": "string",
"description": "string",
"scope": ["string"
],
"componentTypes": ["string"
],
"componentName": "string",
"resportCount": 0
}
]
}

Get assessment

Get assessments by name

path Parameters

name

required

string

Responses

Response samples

200

Content type

application/json

{"name": "string",
"title": "string",
"tags": [{"label": "string",
"value": "string"
}
],
"_createAt": "2019-08-24T14:15:22Z",
"_updatedAt": "2019-08-24T14:15:22Z",
"_createdBy": "string",
"description": "string",
"scope": ["string"
],
"componentTypes": ["string"
],
"componentName": "string",
"resportCount": 0
}

Deletes an assessment

path Parameters

name

required

string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0
}

Run assessment

Run an assessment against its: types, components, and scopes

path Parameters

name

required

string

Responses

Response samples

200

Content type

application/json

{"name": "string",
"title": "string",
"tags": [{"label": "string",
"value": "string"
}
],
"_createAt": "2019-08-24T14:15:22Z",
"_updatedAt": "2019-08-24T14:15:22Z",
"_createdBy": "string",
"description": "string",
"scope": ["string"
],
"componentTypes": ["string"
],
"componentName": "string",
"resportCount": 0
}

List an assessment's reports

List reports for a given assessment

path Parameters

name

required

string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0,
"data": [{"name": "string",
"title": "string",
"tags": [{"label": "string",
"value": "string"
}
],
"_createAt": "2019-08-24T14:15:22Z",
"_updatedAt": "2019-08-24T14:15:22Z",
"_createdBy": "string",
"description": "string",
"assessmentId": "string",
"reportId": "string",
"totalCount": null,
"summary": null,
"detail": null,
"params": null
}
]
}

Get assessment report

Get report for a given reportId and assessment

path Parameters

name required	string
reportId required	string

Responses

Response samples

200

Content type

application/json

{"name": "string",
"title": "string",
"tags": [{"label": "string",
"value": "string"
}
],
"_createAt": "2019-08-24T14:15:22Z",
"_updatedAt": "2019-08-24T14:15:22Z",
"_createdBy": "string",
"description": "string",
"assessmentId": "string",
"reportId": "string",
"totalCount": null,
"summary": null,
"detail": null,
"params": null
}

Export assessment report as CSV text

Export assessment report formatted as CSV text

path Parameters

name required	string
reportId required	string

Responses

Response samples

200

Content type

application/json

"string"

Managed Content

Managed Content provides access to Cortex-managed file storage.

Find out more about Managed Content within Cortex

Download content by key

Get details of previously uploaded content

path Parameters

projectId required	string
key required	string

Responses

Response samples

200

Content type

application/json

null

Content key exits

Check if content exists

path Parameters

projectId required	string
key required	string

Responses

Response samples

200

Content type

application/json

null

UploadContent

Download previously uploaded content //

path Parameters

projectId required	string
key required	string

Responses

Response samples

200

Content type

application/json

null

Delete content by key

Delete content

path Parameters

projectId required	string
key required	string

Responses

Response samples

200

Content type

application/json

null

List content in project

List all object (up to 10000) in ManagedContent

path Parameters

projectId

required

string

Responses

Response samples

200

Content type

application/json

null

Model Experiments/Runs

Manage model experiments and runs during model building and evaluation

Find out more about model apis within Cortex

Gets a list of models within a project

path Parameters

projectId

required

string

Responses

Response samples

200

Content type

application/json

{"success": true,
"models": [{"name": "string",
"title": "string",
"description": "string",
"type": "string",
"status": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"deleted": true,
"version": 0,
"tags": [{"label": "string",
"value": "string",
"_id": "string"
}
]
}
]
}

Create or update a model within a project

path Parameters

projectId

required

string

Request Body schema: application/json

Any of

name required	string
type required	string
status required	string
title required	string
source	string
mode	string
camel	string
description	string
	Array of objects (Tag2)
	Array of objects (Properties)

Responses

Request samples

Payload

Content type

application/json

Example

PostModelReq

{"name": "string",
"type": "string",
"status": "string",
"title": "string",
"source": "string",
"mode": "string",
"camel": "string",
"description": "string",
"tags": [{"label": "string",
"value": "string",
"_id": "string"
}
],
"properties": [{"validValues": ["string"
],
"name": "string",
"type": "string",
"value": "string",
"required": true,
"secure": true
}
]
}

Response samples

200

Content type

application/json

{"success": true,
"version": 0,
"created": "2019-08-24T14:15:22Z",
"id": "string",
"modelId": "string"
}

Describe a model within a project

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"name": "string",
"type": "string",
"status": "string",
"title": "string",
"camel": "string",
"tags": [{"label": "string",
"value": "string",
"_id": "string"
}
],
"properties": [{"validValues": ["string"
],
"name": "string",
"type": "string",
"value": "string",
"required": true,
"secure": true
}
],
"description": "string",
"source": "string",
"mode": "string"
}

Delete a model within a project

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string"
}

List runs for a model within a project

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"runs": [{"_id": "string",
"runId": "string",
"_projectId": "string",
"experimentName": "string",
"startTime": 0,
"endTime": 0,
"took": 0,
"_createdAt": "2019-08-24T14:15:22Z",
"_updatedAt": "2019-08-24T14:15:22Z",
"artifacts": null,
"params": null,
"metrics": null,
"meta": null
}
]
}

Publish a model within a project

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string"
}

Unpublish a model within a project

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string"
}

Gets a list of experiments within a project

path Parameters

projectId

required

string

Responses

Response samples

200

Content type

application/json

{"experiments": [{"_version": 0,
"name": "string",
"title": "string",
"description": "string",
"meta": null,
"tags": [{"label": "string",
"value": "string",
"_id": "string"
}
],
"modelId": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}
]
}

Create or update an experiment within a project

path Parameters

projectId

required

string

Request Body schema: application/json

Any of

name required	string
required	Array of objects (Tag2)
title	string
description	string
meta	any
modelId	string

Responses

Request samples

Payload

Content type

application/json

Example

ExperimentPostReq

{"name": "string",
"tags": [{"label": "string",
"value": "string",
"_id": "string"
}
],
"title": "string",
"description": "string",
"meta": null,
"modelId": "string"
}

Response samples

200

Content type

application/json

{"_version": 0,
"name": "string",
"_projectId": "string",
"tags": [{"label": "string",
"value": "string",
"_id": "string"
}
],
"title": "string",
"description": "string",
"meta": null,
"modelId": "string"
}

Describe an experiment within a project

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"_version": 0,
"name": "string",
"title": "string",
"description": "string",
"meta": null,
"tags": [{"label": "string",
"value": "string",
"_id": "string"
}
],
"modelId": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}

Delete an experiment within a project

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string"
}

List runs for a experiment within a project

List runs for an experiment within a project

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"runs": [{"_id": "string",
"runId": "string",
"_projectId": "string",
"experimentName": "string",
"_createdAt": "2019-08-24T14:15:22Z",
"_updatedAt": "2019-08-24T14:15:22Z",
"startTime": 0,
"endTime": 0,
"took": 0,
"artifacts": null,
"metrics": null,
"meta": null,
"params": null
}
]
}

Create run for an experiment within a project

path Parameters

projectId required	string
name required	string

Request Body schema: application/json

Any of

_id required	string
runId required	string
_projectId required	string
experimentName required	string
startTime	number <double>
endTime	number <double>
took	number <double>
_createdAt required	string <date-time>
_updatedAt required	string <date-time>
artifacts	any
metrics	any
meta	any
params	any

Responses

Request samples

Payload

Content type

application/json

Example

RunPostRes

{"_id": "string",
"runId": "string",
"_projectId": "string",
"experimentName": "string",
"startTime": 0,
"endTime": 0,
"took": 0,
"_createdAt": "2019-08-24T14:15:22Z",
"_updatedAt": "2019-08-24T14:15:22Z",
"artifacts": null,
"metrics": null,
"meta": null,
"params": null
}

Response samples

200

Content type

application/json

{"startTime": 0,
"endTime": 0,
"took": 0,
"artifacts": null,
"metrics": null,
"meta": null,
"params": null
}

Delete runs for an experiment within a project

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"message": "string"
}

Describe an experiment-run within a project

path Parameters

projectId required	string
name required	string
runId required	string

Responses

Response samples

200

Content type

application/json

{"_id": "string",
"runId": "string",
"_projectId": "string",
"experimentName": "string",
"startTime": 0,
"endTime": 0,
"took": 0,
"_createdAt": "2019-08-24T14:15:22Z",
"_updatedAt": "2019-08-24T14:15:22Z",
"artifacts": null,
"params": null,
"metrics": null,
"meta": null
}

Update an experiment-run within a project

path Parameters

projectId required	string
name required	string
runId required	string

Request Body schema: application/json

Any of

_id required	string
runId required	string
_projectId required	string
experimentName required	string
startTime	number <double>
endTime	number <double>
took	number <double>
_createdAt required	string <date-time>
_updatedAt required	string <date-time>
metrics	any
meta	any
params	any

Responses

Request samples

Payload

Content type

application/json

Example

UpdateRunReq

{"_id": "string",
"runId": "string",
"_projectId": "string",
"experimentName": "string",
"startTime": 0,
"endTime": 0,
"took": 0,
"_createdAt": "2019-08-24T14:15:22Z",
"_updatedAt": "2019-08-24T14:15:22Z",
"metrics": null,
"meta": null,
"params": null
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string"
}

Delete an experiment-run within a project

path Parameters

projectId required	string
name required	string
runId required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string"
}

Update a metric of an experiment-run within a project

path Parameters

projectId required	string
name required	string
runId required	string
metric required	string

Request Body schema: application/json

Any of

value

required

any

Responses

Request samples

Payload

Content type

application/json

Example

UpdateRunDataReq

{"value": null
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string"
}

Update a param of an experiment-run within a project

path Parameters

projectId required	string
name required	string
runId required	string
param required	string

Request Body schema: application/json

Any of

value

required

any

Responses

Request samples

Payload

Content type

application/json

Example

UpdateRunDataReq

{"value": null
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string"
}

Update a meta of an experiment-run within a project

path Parameters

projectId required	string
name required	string
runId required	string
meta required	string

Request Body schema: application/json

Any of

value

required

any

Responses

Request samples

Payload

Content type

application/json

Example

UpdateRunDataReq

{"value": null
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string"
}

Get an artifact of an experiment-run within a project

path Parameters

projectId required	string
name required	string
runId required	string
artifact required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string"
}

Delete an artifact of an experiment-run within a project

path Parameters

projectId required	string
name required	string
runId required	string
artifact required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string"
}

Secrets

Manage secure values within Fabric stored as secrets.

Find out more about secrets in Fabric.

Gets a list of secret names within a project

path Parameters

projectId

required

string

query Parameters

list	boolean recursively list secrets
keys	string Comma separated list of secret key names

Responses

Response samples

200

Content type

application/json

{"data": [null
]
}

GetSecretListByKey

List individual secrets

path Parameters

projectId required	string
key required	string

query Parameters

list

boolean

Responses

Response samples

200

Content type

application/json

{"data": [null
]
}

StoreSecretList

Store a list of secret and key pairs

Authorizations:

BearerAuth

path Parameters

projectId required	string
key required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
]
}

DeleteSecret

Delete a specified set of secret keys

Authorizations:

BearerAuth

path Parameters

projectId required	string
key required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
]
}

Sessions

Create sessions to cache and share data between skills and agents

Find out more about sessions in Fabric.

List sessions by project

List sessions by projectId sdsdsdsd dsd ssdsdsds

Authorizations:

None

path Parameters

projectId

required

string

query Parameters

limit

number <double>

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"sessions": [{"sessionId": "string",
"ttl": 0,
"description": "string"
}
]
}

Start a new session for the provided sessionId, use this to set a default ttl for all values

Create session in project

Authorizations:

NoneNone

path Parameters

projectId

required

string

Request Body schema: application/json

sessionId	string
ttl	number <double>
description	string
state	object

Responses

Request samples

Payload

Content type

application/json

{"sessionId": "string",
"ttl": 0,
"description": "string",
"state": {"property1": null,
"property2": null
}
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"state": null,
"ttl": "string",
"description": "string"
}

Get session state

Get session state by projectId and sessionId

Authorizations:

NoneNone

path Parameters

projectId required	string
sessionId required	string

query Parameters

subKey

string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"state": null,
"ttl": "string",
"description": "string"
}

Update session state with new values, key values are merged

Update sessions state by projectId and sessionId

Authorizations:

NoneNone

path Parameters

projectId required	string
sessionId required	string

Request Body schema: application/json

any

Responses

Request samples

Payload

Content type

application/json

null

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"state": null,
"ttl": "string",
"description": "string"
}

Delete session by sessionId

Delete session by projectId and sessionId

Authorizations:

NoneNone

path Parameters

projectId required	string
sessionId required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null
}

Skills and Actions

Skills wrap and route messages to actions, these are the smallest computational building blocks

Find out more on Skills and Actions

Gets a list of skills within a project

Authorizations:

BearerAuth

path Parameters

projectId

required

string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0,
"skills": [{"name": "string",
"_projectId": "string",
"title": "string",
"description": "string",
"tags": [{"label": "string",
"value": "string"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"deleted": true,
"version": 0
}
]
}

Save a skill within a project

Authorizations:

BearerAuth

path Parameters

projectId

required

string

Request Body schema: application/json

Any of

name required	string
type required	string
image required	string
description	string
command	Array of strings
	string or number
scaleCount	number <double>
k8sResources	Array of any
environmentVariables	any

Responses

Request samples

Payload

Content type

application/json

Example

SaveSkillRequest

{"name": "string",
"type": "string",
"image": "string",
"description": "string",
"command": ["string"
],
"port": "string",
"scaleCount": 0,
"k8sResources": [null
],
"environmentVariables": null
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0,
"version": 0
}

Describes a skill within a project

Authorizations:

BearerAuth

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"name": "string",
"camel": "string",
"title": "string",
"description": "string",
"inputs": [null
],
"outputs": [null
],
"properties": [null
],
"tags": [{"label": "string",
"value": "string"
}
],
"actions": [null
]
}

Deletes a skill within a project

Authorizations:

BearerAuth

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0
}

Get skill logs for an action within a project

Authorizations:

BearerAuth

path Parameters

projectId required	string
name required	string
actionName required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0,
"logs": [null
]
}

Redeploy a skill to kubernetes

Upsert kubernetes skill resource and start pods if needed

Authorizations:

BearerAuth

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0
}

Undeploy a skill from kubernetes

Remove kubernetes skill resource and stop existing pods

Authorizations:

BearerAuth

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0
}

Gets a list of actions within a project

Authorizations:

BearerAuth

path Parameters

projectId

required

string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0,
"actions": [{"name": "string",
"type": "string",
"image": "string",
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"deleted": true,
"version": 0
}
]
}

Save an action within a project

Authorizations:

BearerAuth

path Parameters

projectId

required

string

Request Body schema: application/json

Any of

name required	string
type required	string
image required	string
description	string
command	Array of strings
	string or number
scaleCount	number <double>
k8sResources	Array of any
environmentVariables	any

Responses

Request samples

Payload

Content type

application/json

Example

SaveActionRequest

{"name": "string",
"type": "string",
"image": "string",
"description": "string",
"command": ["string"
],
"port": "string",
"scaleCount": 0,
"k8sResources": [null
],
"environmentVariables": null
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0,
"version": 0
}

Describes an action within a project

Authorizations:

BearerAuth

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0,
"action": {"_isDeleted": true,
"_projectId": "string",
"_createdBy": "string",
"name": "string",
"description": "string",
"image": "string",
"type": "string",
"command": ["string"
],
"port": "string",
"scaleCount": 0,
"k8sResources": [null
],
"environmentVariables": null,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"_version": 0
}
}

Deletes an action within a project

Authorizations:

BearerAuth

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0
}

Invoke and skill asynchronously, returns an activationId

Invoke skill

Authorizations:

BearerAuth

path Parameters

projectId required	string project
skillName required	string skill name
inputName required	string skill input to invoke

query Parameters

sync	string true\|false execute synchronously if supported (default: false)

Request Body schema: application/json

sessionId	string
payload	object
properties	object
correlationId	string

Responses

Request samples

Payload

Content type

application/json

{"sessionId": "string",
"payload": {"property1": null,
"property2": null
},
"properties": {"property1": null,
"property2": null
},
"correlationId": "string"
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"activationId": "string",
"response": {"property1": null,
"property2": null
}
}

Tasks

Managed Job Skill executions: list, get logs, manage schedules, and delete.

Find out more about tasks in Fabric.

List tasks in project

Authorizations:

BearerAuth

path Parameters

projectId

required

string

query Parameters

actionName	string
limit	number <double>
skillName	string
scheduled	string
filter	string
skip	number <double>
sort	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"tasks": null
}

Get task by taskId

Authorizations:

BearerAuth

path Parameters

projectId required	string
taskId required	string

query Parameters

k8s

string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"task": null
}

Delete task by taskId

Delete task by taskId, removes kubernetes task, job, and pod from cluster

Authorizations:

BearerAuth

path Parameters

projectId required	string Project name
taskId required	string task id generated by kubernetes.

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null
}

Get task logs by taskId

Authorizations:

BearerAuth

path Parameters

projectId required	string
taskId required	string task id generated by kubernetes

query Parameters

raw	string download log data without JSON metadata.

Responses

Response samples

200

Content type

application/json

Example

"string"

Pause scheduled task by taskId

Pause scheduled task by taskId, new jobs will not be scheduled until task is resumed, existing jobs will continue running until completion.

Authorizations:

BearerAuth

path Parameters

projectId required	string
taskId required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null
}

Pause scheduled task by taskId

Resume paused scheduled task by taskId, resume scheduling future jobs, missed schedules will not be scheduled.

Authorizations:

BearerAuth

path Parameters

projectId required	string
taskId required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null
}

Types

Types defined the expected structure of message passed to Agent endpoints/services

Find out more on Types

get taxonomies (common across all tenants)

Authorizations:

BearerAuth

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0,
"taxonomies": [{"key": "string",
"value": "string"
}
]
}

Save a type within a project

Authorizations:

BearerAuth

path Parameters

projectId

required

string

Request Body schema: application/json

Any of

name required	string
camel required	string
title required	string
description required	string
required	Array of objects (Tag)
parameters required	Array of any

Responses

Request samples

Payload

Content type

application/json

Example

SaveTypeBody

{"name": "string",
"camel": "string",
"title": "string",
"description": "string",
"tags": [{"label": "string",
"value": "string"
}
],
"parameters": [null
]
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0
}

Get list of types within a project

Authorizations:

BearerAuth

path Parameters

projectId

required

string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0,
"types": [{"name": "string",
"_projectId": "string",
"title": "string",
"description": "string",
"tags": [{"label": "string",
"value": "string"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"deleted": true,
"version": 0
}
]
}

Get a type within a project

Authorizations:

BearerAuth

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"_id": "string",
"_projectId": "string",
"_createdBy": "string",
"camel": "string",
"name": "string",
"title": "string",
"description": "string",
"tags": [{"label": "string",
"value": "string"
}
],
"parameters": ["string"
],
"_createdAt": "2019-08-24T14:15:22Z",
"_updatedAt": "2019-08-24T14:15:22Z",
"_version": 0
}

Delete a type within a project

Authorizations:

BearerAuth

path Parameters

projectId required	string
name required	string

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"details": null,
"code": 0
}

User Accounts/Roles

Operations for granting/revoking access to different internal resources

Find out more about RBAC within Cortex

ListRoles

List roles

query Parameters

project

string

List roles with access to a specific project

Responses

Response samples

200

Content type

application/json

{"roles": ["string"
]
}

CreateRole

Creates a role with an initial set of grants

Request Body schema: application/json

role required	string
project required	string
resource required	string
actions required	Array of strings
effect required	string

Responses

Request samples

Payload

Content type

application/json

{"role": "string",
"project": "string",
"resource": "string",
"actions": ["string"
],
"effect": "string"
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
]
}

AssignRolesToProject

Assign roles to a project

Request Body schema: application/json

project required	string
roles required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"project": "string",
"roles": ["string"
]
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
]
}

UnassignRolesFromProject

Unassign roles from a project

Request Body schema: application/json

project required	string
roles required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"project": "string",
"roles": ["string"
]
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
]
}

ListExternalGroups

List all external group to role mappings

Responses

Response samples

200

Content type

application/json

{"group": "string",
"roles": ["string"
]
}

GetExternalGroup

Get role mappings for an external group

path Parameters

external

required

string

Name of the external group to retrieve

query Parameters

roles	boolean Include role grants
users	boolean Include users

Responses

Response samples

200

Content type

application/json

{"externalGroup": "string",
"users": ["string"
],
"roles": [{"role": "string",
"projects": ["string"
],
"externalGroups": ["string"
],
"grants": [{"project": "string",
"resource": "string",
"actions": ["string"
],
"effect": "string"
}
],
"users": ["string"
]
}
]
}

DeleteExternalGroup

Delete an external group to role mapping

path Parameters

external

required

string

Name of the external group

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
]
}

GetRole

Describe a role and optionally include grants and users

path Parameters

role

required

string

Name of the role to describe

query Parameters

grants	boolean Include grants
users	boolean Include users

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
],
"role": {"role": "string",
"projects": ["string"
],
"externalGroups": ["string"
],
"grants": [{"project": "string",
"resource": "string",
"actions": ["string"
],
"effect": "string"
}
],
"users": ["string"
]
}
}

DeleteRole

Deletes a role and all grants/assignments

path Parameters

role

required

string

Name of the role to be removed

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
]
}

GetUsersForRole

Describe a role and include the users associated with the role

path Parameters

role

required

string

Name of the role

query Parameters

users

boolean

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
],
"role": {"role": "string",
"projects": ["string"
],
"externalGroups": ["string"
],
"grants": [{"project": "string",
"resource": "string",
"actions": ["string"
],
"effect": "string"
}
],
"users": ["string"
]
}
}

AssignUsersToRole

Assign users to a role

path Parameters

role

required

string

Name of the role to assign users to

Request Body schema: application/json

users

required

Array of strings

List of users to be assigned to the role

Responses

Request samples

Payload

Content type

application/json

{"users": ["string"
]
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
]
}

UnassignUsersFromRole

Unassign users from a role

path Parameters

role

required

string

Name of the role to remove users from

Request Body schema: application/json

users

required

Array of strings

List of users to be removed from the role

Responses

Request samples

Payload

Content type

application/json

{"users": ["string"
]
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
]
}

GetGrantsForRole

Describe a role and include the associated grants

path Parameters

role

required

string

Name of the role to fetch

query Parameters

grants

boolean

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
],
"role": {"role": "string",
"projects": ["string"
],
"externalGroups": ["string"
],
"grants": [{"project": "string",
"resource": "string",
"actions": ["string"
],
"effect": "string"
}
],
"users": ["string"
]
}
}

CreateRoleGrant

Creates a grant associated with a role, will create a role if no grants exist

path Parameters

role

required

string

Name of the role to assign the grant to

Request Body schema: application/json

project required	string
resource required	string
actions required	Array of strings
effect required	string

Responses

Request samples

Payload

Content type

application/json

{"project": "string",
"resource": "string",
"actions": ["string"
],
"effect": "string"
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
]
}

DeleteRoleGrant

Deletes a grant associated with a role (grant * * * * deletes all but leaves assignments until role is deleted)

path Parameters

role

required

string

Name of the role to remove the grant from

Request Body schema: application/json

project required	string
resource required	string
actions required	Array of strings
effect required	string

Responses

Request samples

Payload

Content type

application/json

{"project": "string",
"resource": "string",
"actions": ["string"
],
"effect": "string"
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
]
}

CreateExternalGroupMapping

Create a cortex role to external group mapping

path Parameters

role

required

string

Name of the cortex role to assign

Request Body schema: application/json

externalGroup

required

string

Responses

Request samples

Payload

Content type

application/json

{"externalGroup": "string"
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
]
}

DeleteExternalGroupMapping

Delete a mapping for an external group to internal role

path Parameters

role required	string Name of the cortex role
external required	string Name of the external group to grant access

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
]
}

AssignUsersToProject

Assign users to a project

Request Body schema: application/json

project required	string
users required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"project": "string",
"users": ["string"
]
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
]
}

UnassignUsersFromProject

Unassign users from a project

Request Body schema: application/json

project required	string
users required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"project": "string",
"users": ["string"
]
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
]
}

ListUserGrants

Lists grants and roles associated with self (params --grants and --roles)

query Parameters

grants	boolean include grants
roles	boolean include roles

Responses

Response samples

200

Content type

application/json

{"user": "string",
"projects": ["string"
],
"grants": [{"project": "string",
"resource": "string",
"actions": ["string"
],
"effect": "string"
}
],
"roles": [{"role": "string",
"projects": ["string"
],
"externalGroups": ["string"
],
"grants": [{"project": "string",
"resource": "string",
"actions": ["string"
],
"effect": "string"
}
],
"users": ["string"
]
}
],
"externalGroups": ["string"
]
}

GetUserGrants

Lists grants and roles associated with a user (params --grants and --roles)

path Parameters

user

required

string

Username to list RBAC permissions and roles

Responses

Response samples

200

Content type

application/json

{"user": "string",
"projects": ["string"
],
"grants": [{"project": "string",
"resource": "string",
"actions": ["string"
],
"effect": "string"
}
],
"roles": [{"role": "string",
"projects": ["string"
],
"externalGroups": ["string"
],
"grants": [{"project": "string",
"resource": "string",
"actions": ["string"
],
"effect": "string"
}
],
"users": ["string"
]
}
],
"externalGroups": ["string"
]
}

CreateUserGrant

Creates a grant associated with a user

path Parameters

user

required

string

Username to add grants onto

Request Body schema: application/json

project required	string
resource required	string
actions required	Array of strings
effect required	string

Responses

Request samples

Payload

Content type

application/json

{"project": "string",
"resource": "string",
"actions": ["string"
],
"effect": "string"
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
]
}

DeleteUserGrant

Deletes a grant or all grants associated with a user (grant * * * * deletes all).

path Parameters

user

required

string

Name of the user to remove grants from

Request Body schema: application/json

project required	string
resource required	string
actions required	Array of strings
effect required	string

Responses

Request samples

Payload

Content type

application/json

{"project": "string",
"resource": "string",
"actions": ["string"
],
"effect": "string"
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
]
}

DockerAuth

Endpoint for configuring a Docker Registry to use Cortex as the authentication provider. https://cognitivescale.github.io/cortex-charts/docs/infrastructure/private-registry#configure-docker-registry-with-fabric-token-auth https://docs.docker.com/registry/spec/auth/token/

Responses

Response samples

200

Content type

application/json

{"token": "string"
}

Retrieves config for generating personal access tokens

Retrieves config for generating personal access token

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
],
"config": {"audience": "string",
"jwk": {"crv": "string",
"x": "string",
"d": "string",
"kty": "string",
"kid": "string",
"alg": "string"
},
"issuer": "string",
"service": true,
"url": "string",
"username": "string"
}
}

ListServiceUsers

List all service/anonymous users that exist across all projects within cortex but not in an external IdP

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
],
"users": ["string"
]
}

CreateServiceUser

Create a service user/identity within cortex that can query cortex api's, rbac/roles must be added/controlled separately.

path Parameters

user

required

string

Name of the user to create

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
],
"config": {"audience": "string",
"jwk": {"crv": "string",
"x": "string",
"d": "string",
"kty": "string",
"kid": "string",
"alg": "string"
},
"issuer": "string",
"service": true,
"url": "string",
"username": "string"
},
"token": "string"
}

DeleteServiceUser

Delete a service user

path Parameters

user

required

string

Name of the service user to delete

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"code": 0,
"details": [null
]
}