Skip to main content
PATCH
/
v1
/
runs
/
{run_id}
Update Run
curl --request PATCH \
  --url https://api.cyberdesk.io/v1/runs/{run_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "scheduling",
  "error": [
    "<string>"
  ],
  "output_data": {},
  "output_attachment_ids": [
    "<string>"
  ],
  "run_message_history": [
    {}
  ],
  "input_values": {},
  "usage_metadata": {},
  "started_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z",
  "release_session_after": true
}
'
{
  "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"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
run_id
string<uuid>
required

Body

application/json

Schema for updating a run

​
status
enum<string> | null
Available options:
scheduling,
running,
success,
cancelled,
error
​
error
string[] | null
​
output_data
Output Data · object
​
output_attachment_ids
string[] | null
​
run_message_history
Run Message History · object[] | null
​
input_values
Input Values · object
​
usage_metadata
Usage Metadata · object
​
started_at
string<date-time> | null
​
ended_at
string<date-time> | null
​
release_session_after
boolean | null

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
Output Data · object
​
input_attachment_ids
string[] | null
​
output_attachment_ids
string[] | null
​
run_message_history
Run Message History · object[] | null
​
input_values
Input Values · object
​
pool_ids
string<uuid>[] | null
​
sensitive_input_aliases
Sensitive Input Aliases · object
​
usage_metadata
Usage Metadata · object

Arbitrary usage/billing metadata captured during a run (schema is flexible)

​
session_id
string<uuid> | null
​
session_alias
string | null
​
release_session_after
boolean | null
​
started_at
string<date-time> | null
​
ended_at
string<date-time> | null