Sign in
latestOpenAPI 3.0.02026-08-10221235717.8 KB

e21ad140ec3c

public
PipelineRuns

Create a Pipeline Run in the appropriate Pipeline based on the trigger and inputs.

post/orgs/{orgId}/apps/{appId}/pipeline-runs

Path parameters

orgIdstring required

The Organization ID

appIdstring required

The Application 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

triggerstring required

The trigger to call

env_idstring

The target environment within the Application to deploy to.

environmentstring

The target environment within the Application to deploy to.

delta_idstring

A deployment delta to apply to the target environment. This delta must already exist. This field is mutually exclusive with "deployment_id" and "set_id".

deployment_idstring

An existing deployment to redeploy into the target environment. The deployment set and value set will be copied. This field is mutually exclusive with "delta_id" and "set_id".

set_idstring

A direct deployment set to apply to the target environment. This deployment set must already exist. This field is mutually exclusive with "delta_id" and "set_id".

value_set_version_idstring

The exact value set version to use when deploying to the target environment. This value set version must exist. This field can only be used when "delta_id" or "set_id" is specified.

commentstring

An optional comment to apply to the Deployment.

modestring

An optional deployment mode to apply to the Deployment. The set of allowed values is defined and validated by the deployment API.

Example request

{
  "trigger": "deployment_request",
  "env_id": "development",
  "delta_id": "0123456789abcdef0123456789abcdef01234567",
  "comment": "My deployment"
}

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"
}