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

A Resource Definitions describes how and when a resource should be provisioned. It links a driver (the how) along with a Matching Criteria (the when) to a Resource Type. This allows Humanitec to invoke a particular driver for the required Resource Type in the context of a particular Application and Environment.The schema for the `driver_inputs` is defined by the `input_schema` property on the DriverDefinition identified by the `driver_type` property.

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

Tagged areas include ResourceDefinition. 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 5 paths, and defines 13 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 5 paths 13 schemas 2 DELETE3 GET1 PATCH2 POST2 PUT

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 5 paths, the API surfaces 10 operations — 2 DELETE, 3 GET, 1 PATCH, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

ResourceDefinition 10

A Resource Definitions describes how and when a resource should be provisioned. It links a driver (the how) along with a Matching Criteria (the when) to a Resource Type. This allo…

GET
/orgs/{orgId}/resources/defs
List Resource Definitions.
listResourceDefinitions 8 params → 200500
POST
/orgs/{orgId}/resources/defs
Create a new Resource Definition.
createResourceDefinition 1 param body → 200400409500
GET
/orgs/{orgId}/resources/defs/{defId}
Get a Resource Definition.
getResourceDefinition 3 params → 200404500
PUT
/orgs/{orgId}/resources/defs/{defId}
Update a Resource Definition.
updateResourceDefinition 2 params body → 200400404500
DELETE
/orgs/{orgId}/resources/defs/{defId}
Delete a Resource Definition.
deleteResourceDefinition 3 params → 204404409500
PATCH
/orgs/{orgId}/resources/defs/{defId}
Update a Resource Definition.
patchResourceDefinition 2 params body → 200400404500
PUT
/orgs/{orgId}/resources/defs/{defId}/criteria
Update all Matching Criteria of a Resource Definition.
updateResourceDefinitionCriteria 2 params body → 200400404409500
POST
/orgs/{orgId}/resources/defs/{defId}/criteria
Add a new Matching Criteria to a Resource Definition.
createResourceDefinitionCriteria 2 params body → 200400404409500
DELETE
/orgs/{orgId}/resources/defs/{defId}/criteria/{criteriaId}
Delete a Matching Criteria from a Resource Definition.
deleteResourceDefinitionCriteria 4 params → 204404409500
GET
/orgs/{orgId}/resources/defs/{defId}/resources
List Active Resources provisioned via a specific Resource Definition.
listActiveResourceByDefinition 2 params → 200500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ActiveResourceResponse (20 properties), ResourceDefinitionResponse (16 properties), CreateResourceDefinitionRequestRequest (8 properties), MatchingCriteriaResponse (6 properties). Each schema is shown below with its type and property counts.

CreateResourceDefinitionRequestRequest
object
CreateResourceDefinitionRequest describes a new ResourceDefinition request.
8 properties 4 required
ActiveResourceResponse
object
Active Resources represent the concrete resources provisioned for an Environment. They are provisioned on the first deployment after a dependency on a particul…
20 properties 17 required
ValuesSecretsRefsRequest
object
ValuesSecretsRefs stores data that should be passed around split by sensitivity.
3 properties
ProvisionDependenciesRequest
object
ProvisionDependencies defines resources which are needed to be co-provisioned with the current resource.
3 properties
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
UpdateResourceDefinitionRequestRequest
object
UpdateResourceDefinitionRequest describes a ResourceDefinition change request.
6 properties 1 required
PatchResourceDefinitionRequestRequest
object
PatchResourceDefinitionRequest describes a ResourceDefinition change request.
5 properties
MatchingCriteriaRuleRequest
object
MatchingCriteriaRule describes Matching Criteria rules.
5 properties
ResourceDefinitionChangeResponse
object
ResourceDefinitionChange describes the effects of a Resource Definition or Matching Criteria update/deletion.
5 properties 5 required
MatchingCriteriaResponse
object
Matching Criteria are a set of rules used to choose which Resource Definition to use to provision a particular Resource Type. Matching criteria are made up in…
6 properties 2 required
ResourceDefinitionResponse
object
A Resource Definitions describes how and when a resource should be provisioned. It links a driver (the how) along with a Matching Criteria (the when) to a Reso…
16 properties 10 required
ValuesSecretsRefsResponse
object
ValuesSecretsRefs stores data that should be passed around split by sensitivity.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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