POST
/
v1
/
runs
Create Run
curl --request POST \
  --url https://api.cyberdesk.io/v1/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "machine_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pool_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "input_values": {},
  "file_inputs": [
    {
      "filename": "<string>",
      "content": "<string>",
      "target_path": "<string>",
      "cleanup_imports_after_run": false
    }
  ],
  "sensitive_input_values": {},
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "start_session": true,
  "session_alias": "<string>",
  "release_session_after": true
}'
{
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "machine_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "<string>",
  "status": "scheduling",
  "error": [
    "<string>"
  ],
  "output_data": {},
  "input_attachment_ids": [
    "<string>"
  ],
  "output_attachment_ids": [
    "<string>"
  ],
  "run_message_history": [
    {}
  ],
  "input_values": {},
  "pool_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "sensitive_input_aliases": {},
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "session_alias": "<string>",
  "release_session_after": true,
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Schema for creating a run

​
workflow_id
string<uuid>
required
​
machine_id
string<uuid> | null

Machine ID. If not provided, an available machine will be automatically selected.

​
pool_ids
string<uuid>[] | null

Pool IDs to filter available machines. Machine must belong to all of these pools (intersection). Ignored when machine_id is provided.

​
input_values
object | null

Input values for workflow variables

​
file_inputs
FileInput · object[] | null

Files to upload to the machine

​
sensitive_input_values
object | null

Sensitive input values. These are not stored and will be written to a secure vault and referenced by alias only.

​
session_id
string<uuid> | null

Join an existing session; overrides machine_id/pool_ids

​
start_session
boolean | null
default:false

Start a new session on the machine used by this run. Session ID will be this run's ID.

​
session_alias
string | null

Persist outputs under this alias for $ref in this session

​
release_session_after
boolean | null

Release the session after this run completes successfully

Response

Successful Response

Run response schema

​
workflow_id
string<uuid>
required
​
machine_id
string<uuid> | null
required
​
id
string<uuid>
required
​
status
enum<string>
required
Available options:
scheduling,
running,
success,
cancelled,
error
​
created_at
string<date-time>
required
​
user_id
string<uuid> | null
​
organization_id
string | null
​
error
string[] | null
​
output_data
object | null
​
input_attachment_ids
string[] | null
​
output_attachment_ids
string[] | null
​
run_message_history
Run Message History · object[] | null
​
input_values
object | null
​
pool_ids
string<uuid>[] | null
​
sensitive_input_aliases
object | null
​
session_id
string<uuid> | null
​
session_alias
string | null
​
release_session_after
boolean | null