POST
/
workspace
/
{ws_id}
/
playbooks
/
{id}
/
execute
curl --request POST \
  --url https://app.blinkops.com/api/v1/workspace/{ws_id}/playbooks/{id}/execute \
  --header 'BLINK-API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "execution_id": "a22f642a-f4fc-4c66-b978-6f1d1008e6ae"
}

Authorizations

Use your API key to access BlinkOps API. To generate an API key, please log in to your BlinkOps account and navigate to the API Keys section in the user settings page. Add the generated key to your request headers as BLINK-API-KEY.

Path Parameters

id
string
required

The ID of the workflow to execute.

ws_id
string
required

Workspace ID

Query Parameters

run_sync
boolean

Wether to run the workflow synchronously or not. If the workflow is executed synchronously, the whole execution's output will be returned instead of the execution's ID. Additionally, the request's execution time will be longer, according to the time it takes the workflow to execute. Consider adjusting the action step's timeout configuration accordingly.

timeout
integer

If the automation runs synchronously, the amount of seconds until the automation's run will timeout if it did not yet finish executing.

Body

application/json · object
Workflow's input parameters, JSON object containing key-value pairs.

The body is of type object.

Response

200
application/json
Execution id
execution_id
string