Shared Values can be used to manage variables and configuration that might vary between environments. They are also the way that secrets can be stored securely.Shared Values are by default shared across all environments in an application. However, they can be overridden on an Environment by Environment basis.For example: There might be 2 API keys that are used in an application. One development key used in the development and staging environments and another used for production. The development API key would be set at the Application level. The value would then be overridden at the Environment level for the production Environment.
Humanitec Value API is one of 45 APIs that Humanitec publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Value. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and authentication docs.
This API exposes
12 operations
across 4 paths,
and defines 7 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/.
12 operations4 paths7 schemas4 DELETE2 GET2 PATCH2 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Across 4 paths, the API surfaces 12 operations — 4 DELETE, 2 GET, 2 PATCH, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Value 12
Shared Values can be used to manage variables and configuration that might vary between environments. They are also the way that secrets can be stored securely. Shared Values are…
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ValueResponse (10 properties), ValueEditPayloadRequest (5 properties), ValueCreatePayloadRequest (5 properties), SecretReference (4 properties). Each schema is shown below with its type and property counts.
ValueCreatePayloadRequest
object
5 properties2 required
ValueEditPayloadRequest
object
5 properties1 required
HumanitecErrorResponse
object
HumanitecError represents a standard Humanitec Error
3 properties2 required
ValueSource
string
Source of the value, "app" for app level, "env" for app env level.
SecretReference
object
It stores sensitive value in the organization primary store or a reference to a sensitive value stored in a store registered under the organization.
4 properties
ValuePatchPayloadRequest
object
3 properties
ValueResponse
object
Shared Values can be used to manage variables and configuration that might vary between environments. They are also the way that secrets can be stored securely…
10 properties10 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
