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

An Application is a collection of Workloads that work together. When deployed, all Workloads in an Application are deployed to the same namespace.Apps are the root of the configuration tree holding Environments, Deployments, Shared Values, and Secrets.

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

Tagged areas include Application. 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 2 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/.

5 operations 2 paths 6 schemas 1 DELETE2 GET1 PATCH1 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 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Application 5

An Application is a collection of Workloads that work together. When deployed, all Workloads in an Application are deployed to the same namespace. Apps are the root of the configu…

GET
/orgs/{orgId}/apps
List all Applications in an Organization.
listApplications 1 param → 200
POST
/orgs/{orgId}/apps
Add a new Application to an Organization
createApplication 1 param body → 201400401409
GET
/orgs/{orgId}/apps/{appId}
Get an existing Application
getApplication 2 params → 200404
PATCH
/orgs/{orgId}/apps/{appId}
Update metadata of an existing Application
patchApplication 2 params body → 200404
DELETE
/orgs/{orgId}/apps/{appId}
Delete an Application
deleteApplication 2 params → 204202401404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ApplicationResponse (9 properties), ApplicationCreationRequest (4 properties), HumanitecErrorResponse (3 properties), EnvironmentBaseRequest (3 properties). Each schema is shown below with its type and property counts.

EnvironmentBaseResponse
object
3 properties 3 required
EnvironmentBaseRequest
object
3 properties 3 required
HumanitecErrorResponse
object
HumanitecError represents a standard Humanitec Error
3 properties 2 required
ApplicationCreationRequest
object
4 properties 2 required
ApplicationPatchPayload
object
Patch request body to update Application metadata.
1 property 1 required
ApplicationResponse
object
An Application is a collection of Workloads that work together. When deployed, all Workloads in an Application are deployed to the same namespace. Apps are the…
9 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

humanitec-application-api-openapi.yml Raw ↑

Other APIs Humanitec publishes across the network.

Humanitec AccountType API
Humanitec ActiveResource API
Humanitec Agents 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
Humanitec EnvironmentPausedInfo API