Strait Docs
API Reference

Workflow execution management

List workflow runs

GET
/v1/workflow-runs

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

project_id*string
status?string
Value in"pending" | "running" | "paused" | "completed" | "failed" | "timed_out" | "canceled"
limit?integer
Default50

Response Body

application/json

curl -X GET "http://localhost:8080/v1/workflow-runs?project_id=string"
[
  {
    "id": "string",
    "workflow_id": "string",
    "project_id": "string",
    "status": "pending",
    "triggered_by": "string",
    "workflow_version": 0,
    "max_parallel_steps": 0,
    "payload": {},
    "error": "string",
    "started_at": "2019-08-24T14:15:22Z",
    "finished_at": "2019-08-24T14:15:22Z",
    "expires_at": "2019-08-24T14:15:22Z",
    "retry_of_run_id": "string",
    "parent_workflow_run_id": "string",
    "parent_step_run_id": "string",
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "workflow_version_id": "string",
    "created_by": "string",
    "created_at": "2019-08-24T14:15:22Z"
  }
]

Get a workflow run

GET
/v1/workflow-runs/{workflowRunID}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

workflowRunID*string

Response Body

application/json

curl -X GET "http://localhost:8080/v1/workflow-runs/string"
{
  "id": "string",
  "workflow_id": "string",
  "project_id": "string",
  "status": "pending",
  "triggered_by": "string",
  "workflow_version": 0,
  "max_parallel_steps": 0,
  "payload": {},
  "error": "string",
  "started_at": "2019-08-24T14:15:22Z",
  "finished_at": "2019-08-24T14:15:22Z",
  "expires_at": "2019-08-24T14:15:22Z",
  "retry_of_run_id": "string",
  "parent_workflow_run_id": "string",
  "parent_step_run_id": "string",
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "workflow_version_id": "string",
  "created_by": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

Cancel a workflow run

DELETE
/v1/workflow-runs/{workflowRunID}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

workflowRunID*string

Response Body

curl -X DELETE "http://localhost:8080/v1/workflow-runs/string"
Empty

List step runs

GET
/v1/workflow-runs/{workflowRunID}/steps

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

workflowRunID*string

Response Body

application/json

curl -X GET "http://localhost:8080/v1/workflow-runs/string/steps"
[
  {
    "id": "string",
    "workflow_run_id": "string",
    "workflow_step_id": "string",
    "step_ref": "string",
    "job_run_id": "string",
    "attempt": 0,
    "status": "pending",
    "deps_completed": 0,
    "deps_required": 0,
    "output": {},
    "error": "string",
    "started_at": "2019-08-24T14:15:22Z",
    "finished_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z"
  }
]

Pause a workflow run

POST
/v1/workflow-runs/{workflowRunID}/pause

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

workflowRunID*string

Response Body

curl -X POST "http://localhost:8080/v1/workflow-runs/string/pause"
Empty

Resume a workflow run

POST
/v1/workflow-runs/{workflowRunID}/resume

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

workflowRunID*string

Response Body

curl -X POST "http://localhost:8080/v1/workflow-runs/string/resume"
Empty

Retry from first failed step

POST
/v1/workflow-runs/{workflowRunID}/retry

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

workflowRunID*string

Response Body

application/json

curl -X POST "http://localhost:8080/v1/workflow-runs/string/retry"
{
  "id": "string",
  "workflow_id": "string",
  "project_id": "string",
  "status": "pending",
  "triggered_by": "string",
  "workflow_version": 0,
  "max_parallel_steps": 0,
  "payload": {},
  "error": "string",
  "started_at": "2019-08-24T14:15:22Z",
  "finished_at": "2019-08-24T14:15:22Z",
  "expires_at": "2019-08-24T14:15:22Z",
  "retry_of_run_id": "string",
  "parent_workflow_run_id": "string",
  "parent_step_run_id": "string",
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "workflow_version_id": "string",
  "created_by": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

Approve an approval step

POST
/v1/workflow-runs/{workflowRunID}/steps/{stepRef}/approve

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

workflowRunID*string
stepRef*string

Response Body

curl -X POST "http://localhost:8080/v1/workflow-runs/string/steps/string/approve"
Empty

Skip a step

POST
/v1/workflow-runs/{workflowRunID}/steps/{stepRef}/skip

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

workflowRunID*string
stepRef*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

reason?string

Response Body

curl -X POST "http://localhost:8080/v1/workflow-runs/string/steps/string/skip" \  -H "Content-Type: application/json" \  -d '{}'
Empty

Force-complete a step

POST
/v1/workflow-runs/{workflowRunID}/steps/{stepRef}/force-complete

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

workflowRunID*string
stepRef*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

result?object

Response Body

curl -X POST "http://localhost:8080/v1/workflow-runs/string/steps/string/force-complete" \  -H "Content-Type: application/json" \  -d '{}'
Empty

Retry a single workflow step

POST
/v1/workflow-runs/{workflowRunID}/steps/{stepRef}/retry

Path Parameters

workflowRunID*string
stepRef*string

Response Body

application/json

curl -X POST "http://localhost:8080/v1/workflow-runs/string/steps/string/retry"
{
  "step_run": {
    "id": "string",
    "workflow_run_id": "string",
    "workflow_step_id": "string",
    "step_ref": "string",
    "job_run_id": "string",
    "attempt": 0,
    "status": "pending",
    "deps_completed": 0,
    "deps_required": 0,
    "output": {},
    "error": "string",
    "started_at": "2019-08-24T14:15:22Z",
    "finished_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z"
  }
}

Replay a step subtree

POST
/v1/workflow-runs/{workflowRunID}/steps/{stepRef}/replay-subtree

Path Parameters

workflowRunID*string
stepRef*string

Response Body

application/json

curl -X POST "http://localhost:8080/v1/workflow-runs/string/steps/string/replay-subtree"
{
  "reset_steps": 0
}

Bulk cancel workflow runs

POST
/v1/workflow-runs/bulk-cancel

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "http://localhost:8080/v1/workflow-runs/bulk-cancel" \  -H "Content-Type: application/json" \  -d '{    "workflow_run_ids": [      "string"    ]  }'
{
  "canceled": 0,
  "failed": 0
}

Bulk replay workflow runs

POST
/v1/workflow-runs/bulk-replay

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "http://localhost:8080/v1/workflow-runs/bulk-replay" \  -H "Content-Type: application/json" \  -d '{    "workflow_run_ids": [      "string"    ]  }'
{
  "replayed": 0,
  "failed": 0
}
Was this page helpful?
Edit on GitHub

Workflows

Workflow DAG definition and management

A P I Keys

Project-level API key management