Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Humanitec

Humanitec PipelineRuns API

Details of a Run within the Pipeline.

Documentation Provider Profile APIs.io OpenAPI GitHub

Humanitec PipelineRuns API is one of 45 APIs that Humanitec publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include PipelineRuns. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and authentication docs.

This API exposes 11 operations across 9 paths, and defines 10 schemas. It is described by OpenAPI 3.0.0, at version 0.28.24.

Requests are made against a single base URL, https://api.humanitec.io/.

11 operations 9 paths 10 schemas 1 DELETE6 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.28.24
Base URL
https://api.humanitec.io
Contact
Humanitec Support
Resource Areas
1

Paths & Operations 11

Across 9 paths, the API surfaces 11 operations — 1 DELETE, 6 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

PipelineRuns 11

Details of a Run within the Pipeline.

GET
/orgs/{orgId}/pipeline-runs
List all pipeline runs within the Org ordered newest to oldest. This can be filtered by app, pipeline, and status.
listPipelineRunsByOrg 10 params → 200400404
POST
/orgs/{orgId}/apps/{appId}/pipeline-runs
Create a Pipeline Run in the appropriate Pipeline based on the trigger and inputs.
createPipelineRunByTriggerCriteria 4 params body → 201204400404409422
GET
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs
List runs within a pipeline ordered newest to oldest.
listPipelineRuns 10 params → 200400404
POST
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs
Create a run within a pipeline.
createPipelineRun 5 params body → 201204400404409422
GET
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}
Get a run within an pipeline.
getPipelineRun 4 params → 200404
DELETE
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}
Deleting a completed Run within a Pipeline.
deletePipelineRun 5 params → 204400404409412
POST
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/cancel
Cancel a Run within an Pipeline.
cancelPipelineRun 5 params → 204400404409412
POST
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/restart
Restart a Run within an Pipeline by cloning it with the same trigger and inputs.
restartPipelineRun 5 params → 201400404409422
GET
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs
List the details of the jobs within a pipeline run.
listPipelineJobs 7 params → 200404
GET
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs/{jobId}
List the details of a Job including Step information
getPipelineJob 5 params → 200404
GET
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs/{jobId}/steps/{stepIndex}/logs
Get a page of log output for a given step within a job.
listPipelineStepLogs 7 params → 200307400404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are PipelineRun (20 properties), PipelineJobPartial (15 properties), PipelineStep (9 properties), PipelineRunCreateByDeploymentRequestCriteriaBody (7 properties). Each schema is shown below with its type and property counts.

HumanitecErrorResponse
object
HumanitecError represents a standard Humanitec Error
3 properties 2 required
ErrorResponse
object
A standard error response
3 properties 2 required
PipelineRunCreateBody
object
The parameters for creating a new Run for the Pipeline.
1 property 1 required
PipelineRunCreateByDeploymentRequestCriteriaBody
object
Trigger the pipeline that has a deploymentrequest trigger and criteria that match this target environment. If "deltaid" or "setid" is provided, the matching cr…
7 properties
PipelineStepLog
object
An item from the logs of a Step.
3 properties 3 required
PipelineRun
object
Details of a Run within the Pipeline.
20 properties 16 required
PipelineRunCreateByTriggerCriteriaBody
object
The parameters for creating a new Run based on trigger and inputs.
1 property 1 required
PipelineJobPartial
object
Partial details of a Job within the Run. The full details, including steps, can be retrieved using the GetPipelineJob operation.
15 properties 13 required
PipelineStep
object
A Step within a Job.
9 properties 8 required
PipelineJob
A response containing all of the details of an executing or completed Job including Step information.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

humanitec-pipelineruns-api-openapi.yml Raw ↑

Other APIs Humanitec publishes across the network.

Humanitec AccountType API
AE Profile APIs.io
Humanitec ActiveResource API
AE Profile APIs.io
Humanitec Agents API
AE Profile APIs.io
Humanitec Application API
AE Profile APIs.io
Humanitec Artefact API
AE Profile APIs.io
Humanitec ArtefactVersion API
AE Profile APIs.io
Humanitec AuditLogs API
AE Profile APIs.io
Humanitec AutomationRule API
AE Profile APIs.io
Humanitec Delta API
AE Profile APIs.io
Humanitec Deployment API
AE Profile APIs.io
Humanitec DriverDefinition API
AE Profile APIs.io
Humanitec Environment API
AE Profile APIs.io
#PipelineRuns
← Back to H APIs
API Details
ID
humanitec:humanitec-pipelineruns-api
Base URL
https://api.humanitec.io
Docs
https://developer.humanitec.com/platform-orchestrator/reference/api-references/
Provider
Humanitec
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network