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

A Deployment Delta (or just "Delta") describes the changes that must be applied to one Deployment Set to generate another Deployment Set. Deployment Deltas are the only way to create new Deployment Sets.Deployment Deltas can be created fully formed or combined together via PATCHing. They can also be generated from the difference between two Deployment Sets.**Basic Structure**``` { "id": , "metadata": { } "modules" : { "add" : { : { } }, "remove": [ ], "update": { : [ ] } } }```

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

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

This API exposes 8 operations across 5 paths, and defines 16 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/.

8 operations 5 paths 16 schemas 2 GET1 PATCH1 POST4 PUT

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 8

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

Delta 8

A Deployment Delta (or just "Delta") describes the changes that must be applied to one Deployment Set to generate another Deployment Set. Deployment Deltas are the only way to cre…

GET
/orgs/{orgId}/apps/{appId}/deltas
List Deltas in an Application
listDeltas 4 params → 200
POST
/orgs/{orgId}/apps/{appId}/deltas
Create a new Delta
createDelta 2 params body → 200400
GET
/orgs/{orgId}/apps/{appId}/deltas/{deltaId}
Fetch an existing Delta
getDelta 3 params → 200404
PATCH
/orgs/{orgId}/apps/{appId}/deltas/{deltaId}
Update an existing Delta
patchDelta 3 params body → 200400404
PUT
/orgs/{orgId}/apps/{appId}/deltas/{deltaId}
Update an existing Delta
putDelta 3 params body → 204400404
PUT
/orgs/{orgId}/apps/{appId}/deltas/{deltaId}/metadata/archived
Mark a Delta as "archived"
archiveDelta 3 params body → 204400404
PUT
/orgs/{orgId}/apps/{appId}/deltas/{deltaId}/metadata/env_id
Change the Environment of a Delta
changeEnvOfDelta 3 params body → 204400404
PUT
/orgs/{orgId}/apps/{appId}/deltas/{deltaId}/metadata/name
Change the name of a Delta
changeNameOfDelta 3 params body → 204400404

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are DeltaMetadataRequest (8 properties), DeltaMetadataResponse (8 properties), ControllerResponse (6 properties), PodStateResponse (5 properties). Each schema is shown below with its type and property counts.

DeployConditionResponse
object
A deploy condition for the workload Possible values for "when" are: - "before", deployed before other workloads - "deploy", deployed in-parallel with other wor…
3 properties 3 required
DeployConditionRequest
object
A deploy condition for the workload Possible values for "when" are: - "before", deployed before other workloads - "deploy", deployed in-parallel with other wor…
3 properties
ModuleRequest
object
Module single workload data
4 properties
DeltaMetadataRequest
object
8 properties
EnvironmentID
string
ModuleDeltasRequest
object
ModuleDeltas groups the different operations together.
3 properties
DeltaMetadataResponse
object
8 properties 4 required
PodStateResponse
object
PodState represents single pod status
5 properties 5 required
UpdateActionResponse
object
A representation of the main object defined in JSON Patch specified in RFC 6902 from the IETF. The main differences are: Only add, remove and replace are suppo…
4 properties 2 required
HumanitecErrorResponse
object
HumanitecError represents a standard Humanitec Error
3 properties 2 required
DeltaResponse
object
A Deployment Delta (or just "Delta") describes the changes that must be applied to one Deployment Set to generate another Deployment Set. Deployment Deltas are…
4 properties 4 required
ModuleDeltasResponse
object
ModuleDeltas groups the different operations together.
3 properties 3 required
UpdateActionRequest
object
A representation of the main object defined in JSON Patch specified in RFC 6902 from the IETF. The main differences are: Only add, remove and replace are suppo…
4 properties
ModuleResponse
object
Module represents a collection of workload controllers (deployments/statefulsets/etc) for the module
4 properties 3 required
DeltaRequest
object
A Deployment Delta (or just "Delta") describes the changes that must be applied to one Deployment Set to generate another Deployment Set. Deployment Deltas are…
4 properties
ControllerResponse
object
Controller represents deployment, stateful set etc
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

humanitec-delta-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 Deployment API
Humanitec DriverDefinition API
Humanitec Environment API
Humanitec EnvironmentPausedInfo API