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/.
Metadata
The identity and technical contract details declared by the specification.
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.
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…
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.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Humanitec 12
Other APIs Humanitec publishes across the network.