v1

latestOpenAPI 3.0.02026-07-14169146300.3 KB

Environments

Update the status of an action run

Updates the status of an ongoing action run.

patch/v1/projects/{ref}/actions/{run_id}/status

Path parameters

refstring required

Example:abcdefghijklmnopqrst

Project ref

run_idstring required

Example:run_01hq3q9m7y5q7e4a7x2c8m1p4n

Action Run ID

Request body

clone'CREATED' | 'DEAD' | 'EXITED' | 'PAUSED' | 'REMOVING' | 'RESTARTING' | 'RUNNING'

pull'CREATED' | 'DEAD' | 'EXITED' | 'PAUSED' | 'REMOVING' | 'RESTARTING' | 'RUNNING'

health'CREATED' | 'DEAD' | 'EXITED' | 'PAUSED' | 'REMOVING' | 'RESTARTING' | 'RUNNING'

configure'CREATED' | 'DEAD' | 'EXITED' | 'PAUSED' | 'REMOVING' | 'RESTARTING' | 'RUNNING'

migrate'CREATED' | 'DEAD' | 'EXITED' | 'PAUSED' | 'REMOVING' | 'RESTARTING' | 'RUNNING'

seed'CREATED' | 'DEAD' | 'EXITED' | 'PAUSED' | 'REMOVING' | 'RESTARTING' | 'RUNNING'

deploy'CREATED' | 'DEAD' | 'EXITED' | 'PAUSED' | 'REMOVING' | 'RESTARTING' | 'RUNNING'

Example request

{
  "clone": "RUNNING",
  "configure": "RUNNING",
  "migrate": "RUNNING",
  "deploy": "CREATED"
}

Response

message'ok' required