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

Humanitec Deployment API

Deployments represent updates to the running state of an Environment.Deployments are made by applying _Deltas_ to a state defined by an existing Deployment. The Environment’s from_deploy property defines the Deployment. This Deployment is usually but not always in the current Environment. If the Deployment is from another Environment, the state of that Environment will be "cloned" into the current Environment with the option to apply a Delta.

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

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

This API exposes 4 operations across 3 paths, and defines 6 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/.

4 operations 3 paths 6 schemas 3 GET1 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
Resource Areas
1

Paths & Operations 4

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

Deployment 4

Deployments represent updates to the running state of an Environment. Deployments are made by applying Deltas to a state defined by an existing Deployment. The Environment’s fromd…

GET
/orgs/{orgId}/apps/{appId}/envs/{envId}/deploys
List Deployments in an Environment.
listDeployments 4 params → 200404
POST
/orgs/{orgId}/apps/{appId}/envs/{envId}/deploys
Start a new Deployment.
createDeployment 3 params body → 201400404409
GET
/orgs/{orgId}/apps/{appId}/envs/{envId}/deploys/{deployId}
Get a specific Deployment.
getDeployment 4 params → 200404
GET
/orgs/{orgId}/apps/{appId}/envs/{envId}/deploys/{deployId}/errors
List errors that occurred in a Deployment.
listDeploymentErrors 4 params → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are DeploymentResponse (16 properties), DeploymentErrorResponse (6 properties), DeploymentRequest (5 properties), DeploymentPipelineReferenceResponse (4 properties). Each schema is shown below with its type and property counts.

DeploymentResponse
object
Deployments represent updates to the running state of an Environment. Deployments are made by applying Deltas to a state defined by an existing Deployment. The…
16 properties 11 required
DeploymentErrorResponse
object
Error happening during deployment.
6 properties 6 required
DeploymentPipelineReferenceRequest
object
4 properties
DeploymentRequest
object
Deployments represent updates to the running state of an Environment. Deployments are made by applying Deltas to a state defined by an existing Deployment. The…
5 properties
DeploymentPipelineReferenceResponse
object
4 properties 4 required
HumanitecErrorResponse
object
HumanitecError represents a standard Humanitec Error
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

humanitec-deployment-api-openapi.yml Raw ↑

Other APIs Humanitec publishes across the network.

Humanitec AccountType API
Humanitec ActiveResource API
Humanitec Agents API
Humanitec Application API
Humanitec Artefact API
Humanitec ArtefactVersion API
Humanitec AuditLogs API
Humanitec AutomationRule API
Humanitec Delta API
Humanitec DriverDefinition API
Humanitec Environment API
Humanitec EnvironmentPausedInfo API