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

A Resource Definition Version represents a version of a Resource Definition.

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

Tagged areas include ResourceDefinitionVersion. 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 5 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/.

4 operations 4 paths 5 schemas 2 GET2 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 4

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

ResourceDefinitionVersion 4

A Resource Definition Version represents a version of a Resource Definition.

GET
/orgs/{orgId}/resources/defs/{defId}/versions
Get Versions of a Resource Definition.
listResourceDefinitionVersions 5 params → 200400404
GET
/orgs/{orgId}/resources/defs/{defId}/versions/{defVersionId}
Get a Resource Definition Version.
getResourceDefinitionVersion 3 params → 200404
POST
/orgs/{orgId}/resources/defs/{defId}/versions/{defVersionId}/actions/archive
Mark/unmark the Resource Definition Version as archived.
archiveResourceDefinitionVersion 3 params body → 204400404
POST
/orgs/{orgId}/resources/defs/{defId}/versions/{defVersionId}/actions/promote
Promote the Resource Definition Version as active.
promoteResourceDefinitionVersion 3 params → 204400404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ResourceDefinitionVersion (15 properties), ValuesSecretsRefsResponse (3 properties), ProvisionDependenciesResponse (3 properties), HumanitecErrorResponse (3 properties). Each schema is shown below with its type and property counts.

HumanitecErrorResponse
object
HumanitecError represents a standard Humanitec Error
3 properties 2 required
ProvisionDependenciesResponse
object
ProvisionDependencies defines resources which are needed to be co-provisioned with the current resource.
3 properties 1 required
ResourceDefinitionVersion
object
A Resource Definition Version represents a version of a Resource Definition.
15 properties 15 required
ValuesSecretsRefsResponse
object
ValuesSecretsRefs stores data that should be passed around split by sensitivity.
3 properties
ArchiveDefinitionVersionRequest
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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