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 Pipelines API

An object containing the details of a Pipeline.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 14 operations across 10 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/.

14 operations 10 paths 10 schemas 2 DELETE9 GET1 PATCH2 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 14

Across 10 paths, the API surfaces 14 operations — 2 DELETE, 9 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Pipelines 14

An object containing the details of a Pipeline.

GET
/orgs/{orgId}/pipelines
List all Pipelines within an Organization. This can be filtered by Application.
listPipelinesInOrg 6 params → 200400404
GET
/orgs/{orgId}/apps/{appId}/pipelines
List Pipelines within an Application.
listPipelines 6 params → 200400404
POST
/orgs/{orgId}/apps/{appId}/pipelines
Create a Pipeline within an Application.
createPipeline 3 params body → 201204400404409
GET
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}
Get a Pipeline within an Application.
getPipeline 4 params → 200404400
PATCH
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}
update a Pipeline within an Application.
updatePipeline 5 params body → 200204400404409412
DELETE
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}
Delete a pipeline within an application.
deletePipeline 4 params → 204202400404409412
GET
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/versions
List all versions of the pipeline
listPipelineVersions 5 params → 200400404
GET
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/schema
Get a pipeline schema.
getPipelineDefinition 5 params → 200404400
GET
/orgs/{orgId}/apps/{appId}/pipeline-criteria
List the trigger matching criteria defined for Pipelines in this Application.
listPipelineCriteriaInApp 6 params → 200400
POST
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/criteria
Create a new trigger matching criteria for this Pipeline.
createPipelineCriteria 3 params body → 201400404409
GET
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/criteria/{criteriaId}
Get the Pipeline Criteria with the given id.
getPipelineCriteria 4 params → 200400404
DELETE
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/criteria/{criteriaId}
Delete the Pipeline Criteria with the given id.
deletePipelineCriteria 4 params → 204400404
GET
/orgs/{orgId}/pipeline-schemas/latest
Gets the latest pipeline schema
getLatestPipelineDefinitionSchema 1 param → 200400
GET
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/batches/{batchType}
Read the current state of a trigger batch
GetBatch 4 params → 200404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Pipeline (10 properties), PipelineDeploymentRequestCriteria (8 properties), PipelineVersion (6 properties), PipelineDeploymentRequestCriteriaCreateBody (4 properties). Each schema is shown below with its type and property counts.

PipelineCriteriaCreateBody
object
1 property 1 required
PipelineDeploymentRequestCriteria
object
A deployment request matching criteria for a Pipeline.
8 properties 4 required
Batch
object
A batch of items that are being collected for a upcoming run.
2 properties 1 required
HumanitecErrorResponse
object
HumanitecError represents a standard Humanitec Error
3 properties 2 required
PipelineVersion
object
An object containing the details of a Pipeline.
6 properties 6 required
ErrorResponse
object
A standard error response
3 properties 2 required
PipelineCriteria
object
4 properties 4 required
BatchItem
object
2 properties 2 required
PipelineDeploymentRequestCriteriaCreateBody
object
The details required to create a new deployment request matching criteria for a Pipeline.
4 properties
Pipeline
object
An object containing the details of a Pipeline.
10 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

humanitec-pipelines-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
#Pipelines
← Back to H APIs
API Details
ID
humanitec:humanitec-pipelines-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