Humanitec ActiveResource API
Active Resources represent the concrete resources provisioned for an Environment. They are provisioned on the first deployment after a dependency on a particular resource type is introduced into an Environment. In general, Active Resources are only deleted when their introductory Environment is deleted.Active Resources are provisioned based on a Resource Definition. The Resource Definition describes how to provision a concrete resource based on a Resource Type and metadata about the Environment (for example the Environment Type or the Application ID). The criteria for how to choose a Resource Definition is known as a Matching Criteria. If the Matching Criteria changes or the Resource Definition is deleted, the concrete resource represented by an Active Resource might be deleted and reprovisioned when a deployment occurs in the Environment.
Humanitec ActiveResource API is one of 45 APIs that Humanitec publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include ActiveResource. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and authentication docs.
This API exposes 4 operations across 4 paths, and defines 3 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 4
Across 4 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Active Resources represent the concrete resources provisioned for an Environment. They are provisioned on the first deployment after a dependency on a particular resource type is…
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ActiveResourceResponse (20 properties), HumanitecErrorResponse (3 properties), ActiveResourceTargetDefinitionRequest (1 property). 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.