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

Artefacts can be registered with Humanitec. Continuous Integration (CI) pipelines notify Humanitec when a new version of an Artefact becomes available. Humanitec tracks the Artefact along with metadata about how it was built.

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

Tagged areas include Artefact. 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 3 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 3 schemas 1 DELETE3 GET

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 — 1 DELETE, 3 GET. Each is listed below with its method, path, parameters, and response codes.

Artefact 4

Artefacts can be registered with Humanitec. Continuous Integration (CI) pipelines notify Humanitec when a new version of an Artefact becomes available. Humanitec tracks the Artefa…

GET
/orgs/{orgId}/artefact-versions/{artefactVersionId}/workload-spec
Get the spec of this Workload Artefact Version
getWorkloadArtefactVersionSpec 3 params → 200400404
GET
/orgs/{orgId}/artefact-versions/{artefactVersionId}/workload-deployment-set
Get the Humanitec module definition of this Workload Artefact Version as a deployment set
getWorkloadArtefactVersionDeploymentSet 3 params → 200400404
GET
/orgs/{orgId}/artefacts
List all Artefacts.
listArtefacts 3 params → 200
DELETE
/orgs/{orgId}/artefacts/{artefactId}
Delete Artefact and all related Artefact Versions
deleteArtefact 2 params → 204403404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ArtefactResponse (7 properties), HumanitecErrorResponse (3 properties), WorkloadArtefactVersionDeploymentSet (2 properties). Each schema is shown below with its type and property counts.

HumanitecErrorResponse
object
HumanitecError represents a standard Humanitec Error
3 properties 2 required
WorkloadArtefactVersionDeploymentSet
object
Humanitec definition for a Workload Artefact.
2 properties 2 required
ArtefactResponse
object
Artefacts can be registered with Humanitec. Continuous Integration (CI) pipelines notify Humanitec when a new version of an Artefact becomes available. Humanit…
7 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

humanitec-artefact-api-openapi.yml Raw ↑

Other APIs Humanitec publishes across the network.

Humanitec AccountType API
Humanitec ActiveResource API
Humanitec Agents API
Humanitec Application API
Humanitec ArtefactVersion API
Humanitec AuditLogs API
Humanitec AutomationRule API
Humanitec Delta API
Humanitec Deployment API
Humanitec DriverDefinition API
Humanitec Environment API
Humanitec EnvironmentPausedInfo API