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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Humanitec

Humanitec ArtefactVersion API

Details of a Container Artefact Version

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 6 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/.

6 operations 5 paths 13 schemas 3 GET1 PATCH2 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
Contact
Humanitec Support
Resource Areas
1

Paths & Operations 6

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

ArtefactVersion 6

Details of a Container Artefact Version

GET
/orgs/{orgId}/artefact-versions
List all Artefacts Versions in the org.
listArtefactVersionsInOrg 5 params → 200400
POST
/orgs/{orgId}/artefact-versions
Register a new Artefact Version with your organization.
createArtefactVersion 4 params body → 200204400401
GET
/orgs/{orgId}/artefact-versions/{artefactVersionId}
Get an Artefacts Versions.
getArtefactVersion 2 params → 200400404
GET
/orgs/{orgId}/artefacts/{artefactId}/versions
List all Artefact Versions of an Artefact.
listArtefactVersions 5 params → 200400404
PATCH
/orgs/{orgId}/artefacts/{artefactId}/versions/{versionId}
Update Version of an Artefact.
patchArtefactVersion 3 params body → 200400401403404
POST
/orgs/{orgId}/artefact-versions/convert-score
Convert a Score specification, optional overrides, and extensions into the contents for a deployment set.
convertScoreToSet 1 param body → 200400

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ArtefactVersionBase (11 properties), ConvertScoreToSetBody (6 properties), CreateArtefactVersionBase (5 properties), ScoreHumanitecExtensions (4 properties). Each schema is shown below with its type and property counts.

WorkloadArtefactVersionDeploymentSet
object
Humanitec definition for a Workload Artefact.
2 properties 2 required
CreateWorkloadArtefactVersion
Details for creating a new Workload Artefact Version
HumanitecErrorResponse
object
HumanitecError represents a standard Humanitec Error
3 properties 2 required
CreateArtefactVersion
object
The details of a new Artefact Version to register. The type field is required and dictates the type of Artefact to register.
1 property 1 required
UpdateArtefactVersionPayloadRequest
object
UpdateArtefactVersionPayload contains the archived field that should be set in the Artefact Version to update.
1 property 1 required
CreateArtefactVersionBase
object
5 properties 2 required
ScoreHumanitecExtensions
object
Humanitec workload extensions for the Workload Artefact Version. These can be used to override the profile, or workload module spec and resource attributes.
4 properties 1 required
ContainerArtefactVersion
Details of a Container Artefact Version
ArtefactVersion
object
The details of an Artefact Version. The type field dictates the type of Artefact along with any additional fields.
1 property 1 required
ArtefactVersionBase
object
11 properties 5 required
ConvertScoreToSetBody
object
Request body for converting a Score manifest to Humanitec deployment set.
6 properties 1 required
CreateContainerArtefactVersion
Details for creating a new Container Artefact Version
WorkloadArtefactVersion
Details of a Workload Artefact Version

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

humanitec-artefactversion-api-openapi.yml Raw ↑

Other APIs Humanitec publishes across the network.

Humanitec AccountType API
AE Profile APIs.io
Humanitec ActiveResource API
AE Profile APIs.io
Humanitec Agents API
AE Profile APIs.io
Humanitec Application API
AE Profile APIs.io
Humanitec Artefact API
AE Profile APIs.io
Humanitec AuditLogs API
AE Profile APIs.io
Humanitec AutomationRule API
AE Profile APIs.io
Humanitec Delta API
AE Profile APIs.io
Humanitec Deployment API
AE Profile APIs.io
Humanitec DriverDefinition API
AE Profile APIs.io
Humanitec Environment API
AE Profile APIs.io
Humanitec EnvironmentPausedInfo API
AE Profile APIs.io
#ArtefactVersion
← Back to H APIs
API Details
ID
humanitec:humanitec-artefactversion-api
Base URL
https://api.humanitec.io
Docs
https://developer.humanitec.com/platform-orchestrator/reference/api-references/
Provider
Humanitec
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network