Sign in
latestOpenAPI 3.0.02026-08-10221235717.8 KB

e21ad140ec3c

public
PipelineRuns

Create a run within a pipeline.

post/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs

Path parameters

orgIdstring required

The Organization ID

appIdstring required

The Application ID

pipelineIdstring required

The Pipeline ID

Query parameters

dry_runboolean

Optionally validate the request but do not persist the actual Pipeline Run.

Headers

Idempotency-Keystring

The HTTP Idempotency-Key

Request body

inputsobject required

The inputs provided for this Run.

Example request

{
  "inputs": {
    "fizz": "buzz"
  }
}

Response

Successful creation response.

idstring required

The unique id of the Run.

etagstring required

The current entity tag value for this Run.

org_idstring required

The id of the Organization containing this Run.

app_idstring required

The id of the Application containing this Run.

env_idsstring[] required

Environments linked to this Pipeline Run through input parameters or step executions.

pipeline_idstring required

The id of the Pipeline associated with the Run.

pipeline_versionstring required

The id of the Pipeline Version associated with the Run.

statusstring required

The current status of this Run.

status_messagestring required

A human-readable message indicating the reason for the status.

created_atstring date-time required

The date and time when this Run was first created.

created_bystring required

User id that created or triggered the Run.

executing_atstring date-time

The date and time when this Run entered executing status.

cancellation_requested_atstring date-time

The date and time when cancellation of this Run was requested.

completed_atstring date-time

The date and time when this Run entered a successful, failed, or cancelled status.

timeout_secondsinteger required

The timeout for this Run.

triggerstring required

The trigger type that was triggered this Run to start.

inputsobject required

The inputs that were provided for this Run.

run_asstring required

The user id that the pipeline run is executing as when it calls Humanitec APIs.

concurrency_groupstring

The optional concurrency group for this run within the application

waiting_forobject required

Aggregated events on which run's jobs are waiting for

Example response

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "etag": "1234567890abcdef",
  "org_id": "sample-org",
  "app_id": "sample-app",
  "env_ids": [
    "development"
  ],
  "pipeline_id": "sample-pipeline",
  "pipeline_version": "01234567-89ab-cdef-0123-456789abcdef",
  "status": "executing",
  "status_message": "Example text",
  "created_at": "2023-01-01T00:00:00Z",
  "created_by": "01234567-89ab-cdef-0123-456789abcdef",
  "executing_at": "2023-01-01T00:00:00Z",
  "cancellation_requested_at": "2023-01-01T00:00:00Z",
  "completed_at": "2023-01-01T00:00:00Z",
  "timeout_seconds": 3600,
  "trigger": "pipeline_call",
  "inputs": {
    "fizz": "buzz"
  },
  "run_as": "s-01234567-89ab-cdef-0123-456789abcdef",
  "concurrency_group": "my-group"
}