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

Humanitec can be used to manage registry credentials. The Registry object represents how to match credentials to a particular registry.Humanitec supports all Docker compatible registries as well as the custom authentication formats used by AWS Elastic Container Registry and Google Container Registry. It also supports the injection of a specific secret to be copied from an existing namespace in the cluster.

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

Tagged areas include Registry. 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 3 paths, and defines 9 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 3 paths 9 schemas 1 DELETE3 GET1 PATCH1 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 6

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

Registry 6

Humanitec can be used to manage registry credentials. The Registry object represents how to match credentials to a particular registry. Humanitec supports all Docker compatible re…

GET
/orgs/{orgId}/registries
Lists available registries for the organization.
1 param → 200400404
POST
/orgs/{orgId}/registries
Creates a new registry record.
1 param body → 201400401404409
GET
/orgs/{orgId}/registries/{regId}
Loads a registry record details.
2 params → 200400404
DELETE
/orgs/{orgId}/registries/{regId}
Deletes an existing registry record and all associated credentials and secrets.
2 params → 204400403404
PATCH
/orgs/{orgId}/registries/{regId}
Updates (patches) an existing registry record.
2 params body → 200400403404409
GET
/orgs/{orgId}/registries/{regId}/creds
Returns current account credentials or secret details for the registry.
2 params → 200400401404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are RegistryResponse (7 properties), RegistryRequest (6 properties), RegistryCredsResponse (5 properties), AccountCredsRequest (3 properties). Each schema is shown below with its type and property counts.

RegistryCredsResponse
object
RegistryCreds represents current registry credentials (either, username- or token-based).
5 properties 1 required
ClusterSecretsMapResponse
object
ClusterSecretsMap stores a list of Kuberenetes secret references for the target deployment clusters.
ClusterSecretsMapRequest
object
ClusterSecretsMap stores a list of Kuberenetes secret references for the target deployment clusters.
ClusterSecretResponse
object
ClusterSecret represents Kubernetes secret reference.
2 properties 2 required
RegistryResponse
object
Humanitec can be used to manage registry credentials. The Registry object represents how to match credentials to a particular registry. Humanitec supports all…
7 properties 4 required
AccountCredsRequest
object
AccountCreds represents an account credentials (either, username- or token-based).
3 properties 2 required
RegistryRequest
object
Humanitec can be used to manage registry credentials. The Registry object represents how to match credentials to a particular registry. Humanitec supports all…
6 properties 3 required
ErrorInfoResponse
object
ErrorInfo is returned by a handler in case of an error.
1 property 1 required
ClusterSecretRequest
object
ClusterSecret represents Kubernetes secret reference.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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