public
Pipelines

update a Pipeline within an Application.

Changed on
patch/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}

Request

  • Base URL
    https://api.humanitec.io
  • URL
    https://api.humanitec.io/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}
  • Auth
    none declared

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 update.

Headers

If-Matchstring

Indicate that the request should only succeed if there is an etag match

Request body application/x-yaml

object required

Response

Successful get response.

idstring required

The id of the Pipeline.

etagstring required

The current entity tag value for this Pipeline.

org_idstring required

The id of the Organization containing this Pipeline.

app_idstring required

The id of the Application containing this Pipeline.

namestring required

The name of the Pipeline.

statusstring required

The current status of the Pipeline.

versionstring required

The unique id of the current Pipeline Version.

created_atstring date-time required

The date and time when the Pipeline was created.

trigger_typesstring[] required

The list of trigger types in the current schema.

metadataobject

The map of key value pipeline additional information

Example response

{
  "id": "sample-pipeline",
  "etag": "1234567890abcdef",
  "org_id": "sample-org",
  "app_id": "sample-app",
  "name": "Sample Pipeline",
  "status": "active",
  "version": "01234567-89ab-cdef-0123-456789abcdef",
  "created_at": "2023-01-01T00:00:00Z",
  "trigger_types": [
    "pipeline_call"
  ]
}

Changes