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

A Deployment Set (or just "Set") defines all of the non-Environment specific configuration for Modules and External Resources. Each of these Modules or External Resources has a unique name.Deployment Sets are immutable and their ID is a cryptographic hash of their content. This means that a Deployment Set can be globally identified based on its ID. It also means that referencing a Deployment Set by ID will always return the same Deployment Set.Deployment Sets cannot be created directly, instead they are created by applying a Deployment Delta to an existing Deployment Set.**Basic Structure**``` { "id": , "modules" : { : { "profile": "spec": { } "externals": { : { "type": , "params": { } } } } } }```For details about how the Humanitec provided profiles work, see (Deployment Set Profiles)[].

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

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

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

5 operations 4 paths 17 schemas 4 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 5

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

Set 5

A Deployment Set (or just "Set") defines all of the non-Environment specific configuration for Modules and External Resources. Each of these Modules or External Resources has a un…

GET
/orgs/{orgId}/apps/{appId}/sets
Get all Deployment Sets
listSets 2 params → 200404
GET
/orgs/{orgId}/apps/{appId}/sets/{setId}
Get a Deployment Set
getSet 4 params → 200404
POST
/orgs/{orgId}/apps/{appId}/sets/{setId}
Apply a Deployment Delta to a Deployment Set
updateSet 3 params body → 200400404
GET
/orgs/{orgId}/apps/{appId}/sets/{setId}/resources
Get Resource Inputs for the given Deployment Set
getSetResourceInputs 3 params → 200404400
GET
/orgs/{orgId}/apps/{appId}/sets/{setId}/diff/{sourceSetId}
Get the difference between 2 Deployment Sets
getDiff 4 params → 200404

Schemas 17

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

DeltaMetadataRequest
object
8 properties
ModuleRequest
object
Module single workload data
4 properties
ModuleDeltasRequest
object
ModuleDeltas groups the different operations together.
3 properties
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
SetResponse
object
A Deployment Set (or just "Set") defines all of the non-Environment specific configuration for Modules and External Resources. Each of these Modules or Externa…
4 properties 4 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
PlainDeltaResponse
object
Similar to the delta response, except the id and metadata properties. Basic Structure { "modules" : { "add" : { : { } }, "remove": [ ], "update": { : [ ] } } }
2 properties 2 required
HumanitecErrorResponse
object
HumanitecError represents a standard Humanitec Error
3 properties 2 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
ResourceInputsResponse
object
A payload needed to generate a resource graph.
4 properties 2 required
EnvironmentID
string
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
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
PodStateResponse
object
PodState represents single pod status
5 properties 5 required
ModuleDeltasResponse
object
ModuleDeltas groups the different operations together.
3 properties 3 required
ControllerResponse
object
Controller represents deployment, stateful set etc
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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