# Humanitec Set API

**Canonical:** https://apis.io/apis/humanitec/humanitec-set-api/  
**Provider:** Humanitec — https://apis.io/providers/humanitec/  
**Base URL:** https://api.humanitec.io  
**Documentation:** https://developer.humanitec.com/platform-orchestrator/reference/api-references/

Humanitec Set API is one of 45 APIs that [Humanitec](https://apis.io/providers/humanitec/) publishes on the [APIs.io](https://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.

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": <ID of the Deployment Set>, "modules" : { <ID of Module> : { "profile": <Defines how the optional "spec" property is interpreted> "spec": { <Properties that depend on the "profile" property.> } "externals": { <External Resource Name> : { "type": <Resource Type>, "params": { <Properties which parametrize the resource depending on the Resource Type.> } } } } } } ``` For details about how the Humanitec provided profiles work, see (Deployment Set Profiles)[]. <SchemaDefinition schemaRef="#/components/schemas/SetRequest" />

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/humanitec/refs/heads/main/openapi/humanitec-set-api-openapi.yml
- **Documentation** — https://developer.humanitec.com/platform-orchestrator/reference/api-references/
- **GettingStarted** — https://developer.humanitec.com/introduction/overview/
- **Authentication** — https://developer.humanitec.com/platform-orchestrator/security/api-tokens/
- **Rules** — https://raw.githubusercontent.com/api-evangelist/humanitec/refs/heads/main/humanitec-rules.yml

## Other Humanitec APIs (12)

- [Humanitec AccountType API](https://apis.io/apis/humanitec/humanitec-accounttype-api/)
- [Humanitec ActiveResource API](https://apis.io/apis/humanitec/humanitec-activeresource-api/)
- [Humanitec Agents API](https://apis.io/apis/humanitec/humanitec-agents-api/)
- [Humanitec Application API](https://apis.io/apis/humanitec/humanitec-application-api/)
- [Humanitec Artefact API](https://apis.io/apis/humanitec/humanitec-artefact-api/)
- [Humanitec ArtefactVersion API](https://apis.io/apis/humanitec/humanitec-artefactversion-api/)
- [Humanitec AuditLogs API](https://apis.io/apis/humanitec/humanitec-auditlogs-api/)
- [Humanitec AutomationRule API](https://apis.io/apis/humanitec/humanitec-automationrule-api/)
- [Humanitec Delta API](https://apis.io/apis/humanitec/humanitec-delta-api/)
- [Humanitec Deployment API](https://apis.io/apis/humanitec/humanitec-deployment-api/)
- [Humanitec DriverDefinition API](https://apis.io/apis/humanitec/humanitec-driverdefinition-api/)
- [Humanitec Environment API](https://apis.io/apis/humanitec/humanitec-environment-api/)

## Tags

Set

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/humanitec/humanitec-set-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/humanitec/.
