WEweld
Orchestrations

Request Orchestration Run

Attempts to run the specified Orchestration immediately.

post/orchestrations/{id}/request_run

Request

  • Base URL
    https://connect.weld.app
  • URL
    https://connect.weld.app/orchestrations/{id}/request_run
  • Auth
    API key in header x-api-key

Path parameters

idstring required
Example:ewK8sDoLNI4CFR

The ID of the Orchestration to run.

Response

The scheduled Orchestration Run.

idstring required

The ID of the Orchestration Run.

orchestration_idstring required

The ID of the Orchestration this run belongs to.

status'CANCELED' | 'COMPLETED' | 'FAILED' | 'NOT_STARTED' | 'RUNNING' required

The status of the run.

due_atstring date-time required

The datetime when the run was due to start.

started_atstring date-time

The datetime when the run actually started.

finished_atstring date-time

The datetime when the run finished.

Example response

{
  "id": "ewK8sDoLNI4CFR",
  "orchestration_id": "3LIw2FdxoByya9",
  "status": "COMPLETED",
  "due_at": "2024-01-01T00:00:00.000Z",
  "started_at": "2024-01-01T00:00:05.000Z",
  "finished_at": "2024-01-01T00:05:00.000Z"
}

Changes

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