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

DriverDefinition describes the resource driver.Resource Drivers are code that fulfils the Humanitec Resource Driver Interface. This interface allows for certain actions to be performed on resources such as creation and destruction. Humanitec provides numerous Resource Drivers “out of the box”. It is also possible to use 3rd party Resource Drivers or write your own.

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

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

This API exposes 5 operations across 2 paths, and defines 4 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/.

5 operations 2 paths 4 schemas 1 DELETE2 GET1 POST1 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 5

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

DriverDefinition 5

DriverDefinition describes the resource driver. Resource Drivers are code that fulfils the Humanitec Resource Driver Interface. This interface allows for certain actions to be per…

GET
/orgs/{orgId}/resources/drivers
List Resource Drivers.
listResourceDrivers 1 param → 200500
POST
/orgs/{orgId}/resources/drivers
Register a new Resource Driver.
createResourceDriver 1 param body → 200400409500
GET
/orgs/{orgId}/resources/drivers/{driverId}
Get a Resource Driver.
getResourceDriver 2 params → 200404500
PUT
/orgs/{orgId}/resources/drivers/{driverId}
Update a Resource Driver.
updateResourceDriver 2 params body → 200400404500
DELETE
/orgs/{orgId}/resources/drivers/{driverId}
Delete a Resources Driver.
deleteResourceDriver 2 params → 204409500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are DriverDefinitionResponse (7 properties), CreateDriverRequestRequest (7 properties), UpdateDriverRequestRequest (6 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
CreateDriverRequestRequest
object
CreateDriverRequest describes the new resource driver registration request.
7 properties 5 required
DriverDefinitionResponse
object
DriverDefinition describes the resource driver. Resource Drivers are code that fulfils the Humanitec Resource Driver Interface. This interface allows for certa…
7 properties 5 required
UpdateDriverRequestRequest
object
UpdateDriverRequest describes the update driver details request.
6 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

humanitec-driverdefinition-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 Environment API
Humanitec EnvironmentPausedInfo API