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

A Value Set Version can be used as a track record of Shared Values changes, to restore a previous version of a Shared Value or Value Set, or to purge a Shared Value if it shouldn't be accessible anymore.

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

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

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

10 operations 10 paths 9 schemas 4 GET6 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 10

Across 10 paths, the API surfaces 10 operations — 4 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

ValueSetVersion 10

A Value Set Version can be used as a track record of Shared Values changes, to restore a previous version of a Shared Value or Value Set, or to purge a Shared Value if it shouldn'…

GET
/orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions
List Value Set Versions in an Environment of an App
4 params → 200
GET
/orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions/{valueSetVersionId}
Get a single Value Set Version in an Environment of an App. The zero version id (00000000-0000-0000-0000-000000000000) will return the latest Value Set Version.
4 params → 200404
POST
/orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions/{valueSetVersionId}/purge/{key}
Purge the value of a specific Shared Value from the App Environment Version history.
5 params body → 204400404
POST
/orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions/{valueSetVersionId}/restore
Restore a Value Set Version in an Environment of an App
4 params body → 200404
POST
/orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions/{valueSetVersionId}/restore/{key}
Restore a specific key from the Value Set Version in an Environment of an App
5 params body → 200400404
GET
/orgs/{orgId}/apps/{appId}/value-set-versions
List Value Set Versions in the App
3 params → 200
GET
/orgs/{orgId}/apps/{appId}/value-set-versions/{valueSetVersionId}
Get a single Value Set Version from the App
3 params → 200404
POST
/orgs/{orgId}/apps/{appId}/value-set-versions/{valueSetVersionId}/purge/{key}
Purge the value of a specific Shared Value from the App Version history.
4 params body → 204400404
POST
/orgs/{orgId}/apps/{appId}/value-set-versions/{valueSetVersionId}/restore
Restore a Value Set Version in an App
3 params body → 200404
POST
/orgs/{orgId}/apps/{appId}/value-set-versions/{valueSetVersionId}/restore/{key}
Restore a specific key from the Value Set Version in an App
4 params body → 200400404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are ValueResponse (10 properties), ValueSetVersionResponse (9 properties), HumanitecErrorResponse (3 properties), JSONPatchResponse (3 properties). Each schema is shown below with its type and property counts.

ValueSetResponse
object
JSONPatchesResponse
array
HumanitecErrorResponse
object
HumanitecError represents a standard Humanitec Error
3 properties 2 required
ValueSetActionPayloadRequest
object
1 property
ValueSource
string
Source of the value, "app" for app level, "env" for app env level.
ValueSetVersionResultOf
string
ValueSetVersionResponse
object
A Value Set Version can be used as a track record of Shared Values changes, to restore a previous version of a Shared Value or Value Set, or to purge a Shared…
9 properties 9 required
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 properties 10 required
JSONPatchResponse
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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