Skip to main content
POST
/
v1
/
runs
/
bulk
Bulk Create Runs
curl --request POST \
  --url https://api.cyberdesk.io/v1/runs/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "count": 123,
  "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": false
}
'
{
  "created_runs": [
    {
      "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "machine_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "scheduling",
      "created_at": "2023-11-07T05:31:56Z",
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organization_id": "<string>",
      "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": {},
      "usage_metadata": {},
      "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "session_alias": "<string>",
      "release_session_after": true,
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z"
    }
  ],
  "failed_count": 0,
  "errors": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string

Unique key for idempotent requests. If provided, the server ensures the request is processed at most once. Retries with the same key return the original response. SDKs auto-generate this for write requests.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json

Schema for bulk creating runs

​
workflow_id
string<uuid>
required
​
count
integer
required

Number of runs to create (max 1000)

Required range: x <= 1000
​
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
Input Values · object

Input values for workflow variables

​
file_inputs
FileInput · object[] | null

Files to upload to the machine

​
sensitive_input_values
Sensitive Input Values · object

Sensitive input values (supports nested objects) to store in the secure vault per run. Not persisted in our database. In workflow input_schema, sensitive root keys are validated under a '$' prefixed key.

​
session_id
string<uuid> | null

Join an existing session; overrides machine_id/pool_ids for all runs

​
start_session
boolean | null
default:false

Start a new session for these runs; a new UUID will be generated and set on all runs. The first run will attempt to reserve a machine.

Response

Successful Response

Response for bulk run creation

​
created_runs
RunResponse · object[]
required
​
failed_count
integer
default:0
​
errors
string[]