users

Get User Workflow Status

Returns the current status of a workflow owned by a user.

get/v0/users/{user_id}/workflows/{workflow_id}

Request

Base URL
https://api.pantheon.io
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/pantheon/apis/pantheon-public-api-service/docs/v0/users/:user_id/workflows/:workflow_id/get.ts
A function with typed inputs. Its response is checked against the schema.

user_idstring required

User ID

workflow_idstring required

Workflow ID

active_descriptionstring

Active description of the workflow

resultstring

Result of the workflow (succeeded, failed, or null if still running)

stepinteger

Current step number in the workflow

{
  "active_description": "Deleting site",
  "final_task": {
    "reason": "Site deletion failed"
  },
  "result": "succeeded",
  "step": 3
}

No recorded changes to this operation across all 2 revisions of this API.