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

RuntimeInfo object returned by the runtime endpoint. Represents a list post statuses grouped by modules and controllers (deployments and stateful sets).

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

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

This API exposes 3 operations across 3 paths, and defines 23 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/.

3 operations 3 paths 23 schemas 2 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 3

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

RuntimeInfo 3

RuntimeInfo object returned by the runtime endpoint. Represents a list post statuses grouped by modules and controllers (deployments and stateful sets).

GET
/orgs/{orgId}/apps/{appId}/envs/{envId}/runtime
Get Runtime information about the environment.
getRuntime 3 params → 200400404
GET
/orgs/{orgId}/apps/{appId}/runtime
Get Runtime information about specific multiple environments.
listRuntime 3 params → 200400
POST
/orgs/{orgId}/runtime/actions/check-connectivity
Provision and check the cluster connectivity in an environment
checkClusterConnectivity 1 param body → 200

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are ClusterConnectionCheckResourceSummary (8 properties), RuntimeInfoContainerStateTerminated (7 properties), RuntimeInfoModuleController (6 properties), ControllerResponse (6 properties). Each schema is shown below with its type and property counts.

ResourceDefinitions
object
Object that contains definition id and resource type
2 properties 2 required
RuntimeInfoModuleController
object
K8s controller.
6 properties 2 required
ClusterConnectionCheckResult
object
The result of testing the Kubernetes cluster connection
3 properties 3 required
RuntimeInfoPod
object
k8s pod.
5 properties 4 required
RuntimeInfoContainerStatus
object
Container status.
5 properties 5 required
RuntimeInfoContainerStateTerminated
object
Details about a terminated container.
7 properties
RuntimeInfoControllerStateWaiting
object
Details about a waiting container
2 properties
ControllerResponse
object
Controller represents deployment, stateful set etc
6 properties 6 required
ClusterConnectionCheckRequest
object
Detailed needed to test a Kubernetes cluster connection
4 properties 3 required
RuntimeInfoContainerStateRunning
object
Details about a running container.
1 property
HumanitecErrorResponse
object
HumanitecError represents a standard Humanitec Error
3 properties 2 required
RuntimeInfoModule
object
Module represents a collection of workload controllers (deployments/statefulsets/etc) for the module.
3 properties 3 required
RuntimeInfoStatusClass
string
Status class, statuses are aggregated into classes
RuntimeInfoStatus
string
Workload status.
ModuleResponse
object
Module represents a collection of workload controllers (deployments/statefulsets/etc) for the module
4 properties 3 required
RuntimeInfoContainerState
object
Details about the container's current condition.
3 properties
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
EnvironmentRuntimeInfoResponse
object
EnvironmentRuntimeInfo
4 properties 2 required
RuntimeInfoResponseV1
object
RuntimeInfo object returned by the runtime endpoint. Represents a list post statuses grouped by modules and controllers (deployments and stateful sets).
2 properties 2 required
ClusterConnectionCheckResourceSummary
object
8 properties 8 required
ClusterConnectionCheckResultCondition
object
A condition associated with a test result. The condition
3 properties 3 required
RuntimeInfoResponseV2
object
RuntimeInfo object returned by the runtime endpoint. Represents a list post statuses grouped by modules and controllers (deployments and stateful sets).
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

humanitec-runtimeinfo-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