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

Environments are independent spaces where Applications can run. An Application is always deployed into an Environment.

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

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

This API exposes 6 operations across 3 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/.

6 operations 3 paths 6 schemas 1 DELETE2 GET1 PATCH1 POST1 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 6

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

Environment 6

Environments are independent spaces where Applications can run. An Application is always deployed into an Environment.

GET
/orgs/{orgId}/apps/{appId}/envs
List all Environments.
listEnvironments 2 params → 200
POST
/orgs/{orgId}/apps/{appId}/envs
Add a new Environment to an Application.
createEnvironment 2 params body → 201400404409
GET
/orgs/{orgId}/apps/{appId}/envs/{envId}
Get a specific Environment.
getEnvironment 3 params → 200404
PATCH
/orgs/{orgId}/apps/{appId}/envs/{envId}
Update a specific Environment.
updateEnvironment 3 params body → 200404
DELETE
/orgs/{orgId}/apps/{appId}/envs/{envId}
Delete a specific Environment.
deleteEnvironment 3 params → 204202400404
PUT
/orgs/{orgId}/apps/{appId}/envs/{envId}/from_deploy_id
Rebase to a different Deployment.
rebaseEnvironment 3 params body → 204400404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are DeploymentResponse (16 properties), EnvironmentResponse (10 properties), EnvironmentDefinitionRequest (4 properties), DeploymentPipelineReferenceResponse (4 properties). Each schema is shown below with its type and property counts.

DeploymentResponse
object
Deployments represent updates to the running state of an Environment. Deployments are made by applying Deltas to a state defined by an existing Deployment. The…
16 properties 11 required
HumanitecErrorResponse
object
HumanitecError represents a standard Humanitec Error
3 properties 2 required
DeploymentPipelineReferenceResponse
object
4 properties 4 required
EnvironmentDefinitionRequest
object
4 properties 2 required
EnvironmentResponse
object
Environments are independent spaces where Applications can run. An Application is always deployed into an Environment.
10 properties 7 required
EnvironmentBaseUpdateRequest
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

humanitec-environment-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 EnvironmentPausedInfo API