Humanitec public API
The public API from Humanitec — 141 operation(s) for public.
Humanitec public API is one of 45 APIs that Humanitec publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include public. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and authentication docs.
This API exposes 221 operations across 141 paths, and defines 216 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/.
221 operations
141 paths
216 schemas
31 DELETE102 GET21 PATCH53 POST14 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 221
Across 141 paths, the API surfaces 221 operations — 31 DELETE, 102 GET, 21 PATCH, 53 POST, 14 PUT. Each is listed below with its method, path, parameters, and response codes.
public 221
POST
/orgs/{orgId}/agents
Register a new Agent under an Organization.
GET
/orgs/{orgId}/agents
List all the agents in an Organization.
DELETE
/orgs/{orgId}/agents/{agentId}
Delete an Agent (and its keys) stored under an Organization.
PATCH
/orgs/{orgId}/agents/{agentId}
Update the description of an Agent.
GET
/orgs/{orgId}/agents/{agentId}/keys
List all the keys registered under an Agent in an Organization.
POST
/orgs/{orgId}/agents/{agentId}/keys
Register a new Key under an Agent in an Organization.
DELETE
/orgs/{orgId}/agents/{agentId}/keys/{fingerprint}
Delete a key registered under a Agent.
GET
/orgs/{orgId}/apps
List all Applications in an Organization.
POST
/orgs/{orgId}/apps
Add a new Application to an Organization
GET
/orgs/{orgId}/apps/{appId}
Get an existing Application
PATCH
/orgs/{orgId}/apps/{appId}
Update metadata of an existing Application
DELETE
/orgs/{orgId}/apps/{appId}
Delete an Application
GET
/orgs/{orgId}/apps/{appId}/envs
List all Environments.
POST
/orgs/{orgId}/apps/{appId}/envs
Add a new Environment to an Application.
GET
/orgs/{orgId}/apps/{appId}/envs/{envId}
Get a specific Environment.
PATCH
/orgs/{orgId}/apps/{appId}/envs/{envId}
Update a specific Environment.
DELETE
/orgs/{orgId}/apps/{appId}/envs/{envId}
Delete a specific Environment.
GET
/orgs/{orgId}/apps/{appId}/envs/{envId}/deploys
List Deployments in an Environment.
POST
/orgs/{orgId}/apps/{appId}/envs/{envId}/deploys
Start a new Deployment.
GET
/orgs/{orgId}/apps/{appId}/envs/{envId}/deploys/{deployId}
Get a specific Deployment.
GET
/orgs/{orgId}/apps/{appId}/envs/{envId}/deploys/{deployId}/errors
List errors that occurred in a Deployment.
PUT
/orgs/{orgId}/apps/{appId}/envs/{envId}/from_deploy_id
Rebase to a different Deployment.
GET
/orgs/{orgId}/env-types
List all Environment Types
POST
/orgs/{orgId}/env-types
Add a new Environment Type
GET
/orgs/{orgId}/env-types/{envTypeId}
Get an Environment Type
DELETE
/orgs/{orgId}/env-types/{envTypeId}
Deletes an Environment Type
PATCH
/orgs/{orgId}/env-types/{envTypeId}
Updates Environment Type
GET
/orgs/{orgId}/artefact-versions
List all Artefacts Versions in the org.
POST
/orgs/{orgId}/artefact-versions
Register a new Artefact Version with your organization.
GET
/orgs/{orgId}/artefact-versions/{artefactVersionId}
Get an Artefacts Versions.
GET
/orgs/{orgId}/artefact-versions/{artefactVersionId}/workload-spec
Get the spec of this Workload Artefact Version
GET
/orgs/{orgId}/artefact-versions/{artefactVersionId}/workload-deployment-set
Get the Humanitec module definition of this Workload Artefact Version as a deployment set
GET
/orgs/{orgId}/artefacts
List all Artefacts.
DELETE
/orgs/{orgId}/artefacts/{artefactId}
Delete Artefact and all related Artefact Versions
GET
/orgs/{orgId}/artefacts/{artefactId}/versions
List all Artefact Versions of an Artefact.
PATCH
/orgs/{orgId}/artefacts/{artefactId}/versions/{versionId}
Update Version of an Artefact.
GET
/orgs/{orgId}/images
List all Container Images
GET
/orgs/{orgId}/images/{imageId}
Get a specific Image Object
GET
/orgs/{orgId}/images/{imageId}/builds
Lists all the Builds of an Image
POST
/orgs/{orgId}/images/{imageId}/builds
Add a new Image Build
POST
/orgs/{orgId}/artefact-versions/convert-score
Convert a Score specification, optional overrides, and extensions into the contents for a deployment set.
GET
/orgs/{orgId}/audit-logs
List audit log entries by Organization
GET
/orgs/{orgId}/apps/{appId}/envs/{envId}/rules
List all Automation Rules in an Environment.
POST
/orgs/{orgId}/apps/{appId}/envs/{envId}/rules
Create a new Automation Rule for an Environment.
GET
/orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId}
Get a specific Automation Rule for an Environment.
PUT
/orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId}
Update an existing Automation Rule for an Environment.
DELETE
/orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId}
Delete Automation Rule from an Environment.
GET
/orgs/{orgId}/apps/{appId}/deltas
List Deltas in an Application
POST
/orgs/{orgId}/apps/{appId}/deltas
Create a new Delta
GET
/orgs/{orgId}/apps/{appId}/deltas/{deltaId}
Fetch an existing Delta
PATCH
/orgs/{orgId}/apps/{appId}/deltas/{deltaId}
Update an existing Delta
PUT
/orgs/{orgId}/apps/{appId}/deltas/{deltaId}
Update an existing Delta
PUT
/orgs/{orgId}/apps/{appId}/deltas/{deltaId}/metadata/archived
Mark a Delta as "archived"
PUT
/orgs/{orgId}/apps/{appId}/deltas/{deltaId}/metadata/env_id
Change the Environment of a Delta
PUT
/orgs/{orgId}/apps/{appId}/deltas/{deltaId}/metadata/name
Change the name of a Delta
GET
/orgs/{orgId}/apps/{appId}/sets
Get all Deployment Sets
GET
/orgs/{orgId}/apps/{appId}/sets/{setId}
Get a Deployment Set
POST
/orgs/{orgId}/apps/{appId}/sets/{setId}
Apply a Deployment Delta to a Deployment Set
GET
/orgs/{orgId}/apps/{appId}/sets/{setId}/resources
Get Resource Inputs for the given Deployment Set
GET
/orgs/{orgId}/apps/{appId}/sets/{setId}/diff/{sourceSetId}
Get the difference between 2 Deployment Sets
DELETE
/orgs/{orgId}/apps/{appId}/jobs
Deletes all Jobs for the Application
GET
/orgs/{orgId}/apps/{appId}/webhooks
List Webhooks
POST
/orgs/{orgId}/apps/{appId}/webhooks
Create a new Webhook
GET
/orgs/{orgId}/apps/{appId}/webhooks/{jobId}
Get a Webhook
DELETE
/orgs/{orgId}/apps/{appId}/webhooks/{jobId}
Delete a Webhook
PATCH
/orgs/{orgId}/apps/{appId}/webhooks/{jobId}
Update a Webhook
GET
/orgs/{orgId}/events
List Events
POST
/orgs/{orgId}/keys
Associate a new RSA public key to an organization.
GET
/orgs/{orgId}/keys
List all public keys associated to an organization.
DELETE
/orgs/{orgId}/keys/{keyId}
Delete a public key associated to an organization.
GET
/orgs/{orgId}/keys/{keyId}
Retrieve a single public key associated to an organization.
GET
/orgs/{orgId}/humanitec-keys
List all the public keys Humanitec shares with an organization.
GET
/orgs/{orgId}/apps/{appId}/envs/{envId}/logs
Get container log entries for the environment
GET
/orgs
List active organizations the user has access to.
GET
/orgs/{orgId}
Get the specified Organization.
GET
/orgs/{orgId}/pipelines
List all Pipelines within an Organization. This can be filtered by Application.
GET
/orgs/{orgId}/apps/{appId}/pipelines
List Pipelines within an Application.
POST
/orgs/{orgId}/apps/{appId}/pipelines
Create a Pipeline within an Application.
GET
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}
Get a Pipeline within an Application.
PATCH
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}
update a Pipeline within an Application.
DELETE
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}
Delete a pipeline within an application.
GET
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/versions
List all versions of the pipeline
GET
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/schema
Get a pipeline schema.
GET
/orgs/{orgId}/apps/{appId}/pipeline-criteria
List the trigger matching criteria defined for Pipelines in this Application.
POST
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/criteria
Create a new trigger matching criteria for this Pipeline.
GET
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/criteria/{criteriaId}
Get the Pipeline Criteria with the given id.
DELETE
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/criteria/{criteriaId}
Delete the Pipeline Criteria with the given id.
GET
/orgs/{orgId}/pipeline-schemas/latest
Gets the latest pipeline schema
GET
/orgs/{orgId}/pipeline-runs
List all pipeline runs within the Org ordered newest to oldest. This can be filtered by app, pipeline, and status.
POST
/orgs/{orgId}/apps/{appId}/pipeline-runs
Create a Pipeline Run in the appropriate Pipeline based on the trigger and inputs.
GET
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs
List runs within a pipeline ordered newest to oldest.
POST
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs
Create a run within a pipeline.
GET
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}
Get a run within an pipeline.
DELETE
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}
Deleting a completed Run within a Pipeline.
POST
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/cancel
Cancel a Run within an Pipeline.
POST
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/restart
Restart a Run within an Pipeline by cloning it with the same trigger and inputs.
GET
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs
List the details of the jobs within a pipeline run.
GET
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs/{jobId}
List the details of a Job including Step information
GET
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs/{jobId}/steps/{stepIndex}/logs
Get a page of log output for a given step within a job.
GET
/orgs/{orgId}/apps/{appId}/approvals
List of the approval requests
GET
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs/{jobId}/approvals/{approvalId}
Get an approval request
POST
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs/{jobId}/approvals/{approvalId}/approve
Approve the approval request
POST
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs/{jobId}/approvals/{approvalId}/deny
Deny the approval request
GET
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/batches/{batchType}
Read the current state of a trigger batch
GET
/orgs/{orgId}/registries
Lists available registries for the organization.
POST
/orgs/{orgId}/registries
Creates a new registry record.
GET
/orgs/{orgId}/registries/{regId}
Loads a registry record details.
DELETE
/orgs/{orgId}/registries/{regId}
Deletes an existing registry record and all associated credentials and secrets.
PATCH
/orgs/{orgId}/registries/{regId}
Updates (patches) an existing registry record.
GET
/orgs/{orgId}/registries/{regId}/creds
Returns current account credentials or secret details for the registry.
GET
/orgs/{orgId}/apps/{appId}/envs/{envId}/resources
List Active Resources provisioned in an environment.
POST
/orgs/{orgId}/apps/{appId}/envs/{envId}/resources/graphdeprecated
Lists the resource objects that hold the information needed to provision the resources specified in the request and the resources they depend on.
POST
/orgs/{orgId}/apps/{appId}/envs/{envId}/resources/graphs
Create a Dependency Graph which is composed by the resource objects that hold the information needed to provision the resources specified in the request and the resources they depend on.
GET
/orgs/{orgId}/apps/{appId}/envs/{envId}/resources/graphs/{graphId}
Retrieve a Dependency Graph by its ID.
DELETE
/orgs/{orgId}/apps/{appId}/envs/{envId}/resources/{type}/{resId}
Delete Active Resource.
POST
/orgs/{orgId}/apps/{appId}/envs/{envId}/resources/{type}/{resId}/actions/pin
Pin Active Resource to a target Resource Definition Version.
GET
/orgs/{orgId}/resources/account-types
List Resource Account Types available to the organization.
GET
/orgs/{orgId}/resources/accounts
List Resource Accounts in the organization.
POST
/orgs/{orgId}/resources/accounts
Create a new Resource Account in the organization.
GET
/orgs/{orgId}/resources/accounts/{accId}
Get a Resource Account.
DELETE
/orgs/{orgId}/resources/accounts/{accId}
Delete an unused Resource Account.
PATCH
/orgs/{orgId}/resources/accounts/{accId}
Update a Resource Account.
POST
/orgs/{orgId}/resources/accounts/{accId}/actions/check
Check the credentials of an existing Resource Account
GET
/orgs/{orgId}/resources/defs
List Resource Definitions.
POST
/orgs/{orgId}/resources/defs
Create a new Resource Definition.
GET
/orgs/{orgId}/resources/defs/{defId}
Get a Resource Definition.
PUT
/orgs/{orgId}/resources/defs/{defId}
Update a Resource Definition.
DELETE
/orgs/{orgId}/resources/defs/{defId}
Delete a Resource Definition.
PATCH
/orgs/{orgId}/resources/defs/{defId}
Update a Resource Definition.
GET
/orgs/{orgId}/resources/defs/{defId}/versions
Get Versions of a Resource Definition.
GET
/orgs/{orgId}/resources/defs/{defId}/versions/{defVersionId}
Get a Resource Definition Version.
POST
/orgs/{orgId}/resources/defs/{defId}/versions/{defVersionId}/actions/archive
Mark/unmark the Resource Definition Version as archived.
POST
/orgs/{orgId}/resources/defs/{defId}/versions/{defVersionId}/actions/promote
Promote the Resource Definition Version as active.
PUT
/orgs/{orgId}/resources/defs/{defId}/criteria
Update all Matching Criteria of a Resource Definition.
POST
/orgs/{orgId}/resources/defs/{defId}/criteria
Add a new Matching Criteria to a Resource Definition.
DELETE
/orgs/{orgId}/resources/defs/{defId}/criteria/{criteriaId}
Delete a Matching Criteria from a Resource Definition.
GET
/orgs/{orgId}/resources/defs/{defId}/resources
List Active Resources provisioned via a specific Resource Definition.
GET
/orgs/{orgId}/resources/drivers
List Resource Drivers.
POST
/orgs/{orgId}/resources/drivers
Register a new Resource Driver.
GET
/orgs/{orgId}/resources/drivers/{driverId}
Get a Resource Driver.
PUT
/orgs/{orgId}/resources/drivers/{driverId}
Update a Resource Driver.
DELETE
/orgs/{orgId}/resources/drivers/{driverId}
Delete a Resources Driver.
GET
/orgs/{orgId}/resources/types
List Resource Types.
POST
/orgs/{orgId}/resources/types
Creates a new Resources Type.
DELETE
/orgs/{orgId}/resources/types/{typeId}
Delete a Resource Type.
PATCH
/orgs/{orgId}/resources/types/{typeId}
Update a Resource Type.
PUT
/orgs/{orgId}/resources/types/{typeId}
Update a Resource Type.
GET
/orgs/{orgId}/resources/classes
List resource classes.
POST
/orgs/{orgId}/resources/types/{typeId}/classes
Creates a new resources class.
GET
/orgs/{orgId}/resources/types/{typeId}/classes/{classId}
Get resource class by ID.
PATCH
/orgs/{orgId}/resources/types/{typeId}/classes/{classId}
Update a resource class description.
DELETE
/orgs/{orgId}/resources/types/{typeId}/classes/{classId}
Delete a resource class.
GET
/orgs/{orgId}/apps/{appId}/envs/{envId}/runtime
Get Runtime information about the environment.
PUT
/orgs/{orgId}/apps/{appId}/envs/{envId}/runtime/paused
Pause / Resume an environment.
PATCH
/orgs/{orgId}/apps/{appId}/envs/{envId}/runtime/replicas
Set number of replicas for an environment's modules.
GET
/orgs/{orgId}/apps/{appId}/runtime
Get Runtime information about specific multiple environments.
POST
/orgs/{orgId}/runtime/actions/check-connectivity
Provision and check the cluster connectivity in an environment
GET
/orgs/{orgId}/secretstores
Get list of Secret Stores for the given organization.
POST
/orgs/{orgId}/secretstores
Create a Secret Store for the given organization.
GET
/orgs/{orgId}/secretstores/{storeId}
Get the Secret Store.
DELETE
/orgs/{orgId}/secretstores/{storeId}
Delete the Secret Store.
PATCH
/orgs/{orgId}/secretstores/{storeId}
Update the Secret Store.
GET
/current-user
Gets the extended profile of the current user
PATCH
/current-user
Updates the extended profile of the current user.
POST
/orgs/{orgId}/groups
Create a group in an organization
GET
/orgs/{orgId}/groups/{groupId}/users
List users in a group.
GET
/orgs/{orgId}/apps/{appId}/users
List Users or Groups with roles in an App
POST
/orgs/{orgId}/apps/{appId}/users
Adds a User or a Group to an Application with a Role
GET
/orgs/{orgId}/apps/{appId}/users/{userId}
Get the role of a User or a Group on an Application
DELETE
/orgs/{orgId}/apps/{appId}/users/{userId}
Remove the role of a User or a Group on an Application
PATCH
/orgs/{orgId}/apps/{appId}/users/{userId}
Update the role of a User or a Group on an Application
GET
/orgs/{orgId}/env-types/{envType}/users
List Users and Groups with roles in an Environment Type
POST
/orgs/{orgId}/env-types/{envType}/users
Adds a User or a Group to an Environment Type with a Role
GET
/orgs/{orgId}/env-types/{envType}/users/{userId}
Get the role of a User or a Group on an Environment Type
DELETE
/orgs/{orgId}/env-types/{envType}/users/{userId}
Remove the role of a User or a Group on an Environment Type
PATCH
/orgs/{orgId}/env-types/{envType}/users/{userId}
Update the role of a User or a Group on an Environment Type
GET
/orgs/{orgId}/invitations
List the invites issued for the organization.
POST
/orgs/{orgId}/invitations
Invites a user to an Organization with a specified role.
GET
/orgs/{orgId}/users
List Users and Groups with roles in an Organization
POST
/orgs/{orgId}/users
Creates a new service user.
GET
/orgs/{orgId}/users/{userId}
Get the role of a User or a Group on an Organization
DELETE
/orgs/{orgId}/users/{userId}
Remove the role of a User or a Group on an Organization
PATCH
/orgs/{orgId}/users/{userId}
Update the role of a User or a Group on an Organization
GET
/orgs/{orgId}/users/{userId}/groups
Get the groups in an organization a user belongs to.
GET
/orgs/{orgId}/users/{userId}/perms
Get the permissions of a User or Group on the objects in an Organization
GET
/users/{userId}/tokens
Lists tokens associated with a user
POST
/users/{userId}/tokens
Creates a new static token for a user.
GET
/users/{userId}/tokens/{tokenId}
Gets a specific token associated with a user
DELETE
/users/{userId}/tokens/{tokenId}
Deletes a specific token associated with a user
GET
/orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions
List Value Set Versions in an Environment of an App
GET
/orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions/{valueSetVersionId}
Get a single Value Set Version in an Environment of an App. The zero version id (00000000-0000-0000-0000-000000000000) will return the latest Value Set Version.
POST
/orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions/{valueSetVersionId}/purge/{key}
Purge the value of a specific Shared Value from the App Environment Version history.
POST
/orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions/{valueSetVersionId}/restore
Restore a Value Set Version in an Environment of an App
POST
/orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions/{valueSetVersionId}/restore/{key}
Restore a specific key from the Value Set Version in an Environment of an App
GET
/orgs/{orgId}/apps/{appId}/envs/{envId}/values
List Shared Values in an Environment
POST
/orgs/{orgId}/apps/{appId}/envs/{envId}/values
Create a Shared Value for an Environment
DELETE
/orgs/{orgId}/apps/{appId}/envs/{envId}/values
Delete all Shared Value for an Environment
PUT
/orgs/{orgId}/apps/{appId}/envs/{envId}/values/{key}
Update Shared Value for an Environment
DELETE
/orgs/{orgId}/apps/{appId}/envs/{envId}/values/{key}
Delete Shared Value for an Environment
PATCH
/orgs/{orgId}/apps/{appId}/envs/{envId}/values/{key}
Update Shared Value for an Environment
GET
/orgs/{orgId}/apps/{appId}/value-set-versions
List Value Set Versions in the App
GET
/orgs/{orgId}/apps/{appId}/value-set-versions/{valueSetVersionId}
Get a single Value Set Version from the App
POST
/orgs/{orgId}/apps/{appId}/value-set-versions/{valueSetVersionId}/purge/{key}
Purge the value of a specific Shared Value from the App Version history.
POST
/orgs/{orgId}/apps/{appId}/value-set-versions/{valueSetVersionId}/restore
Restore a Value Set Version in an App
POST
/orgs/{orgId}/apps/{appId}/value-set-versions/{valueSetVersionId}/restore/{key}
Restore a specific key from the Value Set Version in an App
GET
/orgs/{orgId}/apps/{appId}/values
List Shared Values in an Application
POST
/orgs/{orgId}/apps/{appId}/values
Create a Shared Value for an Application
DELETE
/orgs/{orgId}/apps/{appId}/values
Delete all Shared Value for an App
PUT
/orgs/{orgId}/apps/{appId}/values/{key}
Update Shared Value for an Application
DELETE
/orgs/{orgId}/apps/{appId}/values/{key}
Delete Shared Value for an Application
PATCH
/orgs/{orgId}/apps/{appId}/values/{key}
Update Shared Value for an Application
GET
/orgs/{orgId}/workload-profile-features
List workload profile features available to the organization.
GET
/orgs/{orgId}/workload-profiles
List workload profiles available to the organization.
POST
/orgs/{orgId}/workload-profiles
Create new Workload Profile
GET
/orgs/{orgId}/workload-profiles/{profileQid}
Get a Workload Profile
PUT
/orgs/{orgId}/workload-profiles/{profileQid}
Update a Workload Profile
DELETE
/orgs/{orgId}/workload-profiles/{profileQid}
Delete a Workload Profile
GET
/orgs/{orgId}/workload-profiles/{profileQid}/versions
List versions of the given workload profile.
GET
/orgs/{orgId}/workload-profiles/{profileQid}/versions/latestdeprecated
Latest version of the given workload profile with optional constraint.
POST
/orgs/{orgId}/workload-profile-chart-versions
Add new Workload Profile Chart Version
GET
/orgs/{orgId}/workload-profile-chart-versions
Workload Profile Chart Versions for the given organization.
Schemas 216
The contract defines 216 schemas that model the data the API accepts and returns. The most detailed are ActiveResourceResponse (20 properties), PipelineRun (20 properties), ResourceDefinitionResponse (16 properties), DeploymentResponse (16 properties). Each schema is shown below with its type and property counts.
AzureKVRequest
object
Azure Key Vault specification.
3 properties
UpdateActionResponse
object
A representation of the main object defined in JSON Patch specified in RFC 6902 from the IETF. The main differences are: Only add, remove and replace are suppo…
4 properties
2 required
RuntimeInfoContainerStateTerminated
object
Details about a terminated container.
7 properties
EventBaseRequest
object
Properties which identify an event .
2 properties
WorkloadProfileChartVersionResponse
object
Each Workload Profile Chart has one or more Versions associated with it.
5 properties
5 required
PatchResourceTypeRequestRequest
object
5 properties
ResourceDefinitionVersion
object
A Resource Definition Version represents a version of a Resource Definition.
15 properties
15 required
CreateDriverRequestRequest
object
CreateDriverRequest describes the new resource driver registration request.
7 properties
5 required
ApplicationCreationRequest
object
4 properties
2 required
RoleRequest
object
Role defines the role that will be used in request
1 property
1 required
EventBaseResponse
object
Properties which identify an event .
2 properties
2 required
UserInviteRequestRequest
object
UserInviteRequest describes a new user invitation.
2 properties
2 required
ConflictingResourcesErrorResponseDetails
object
Object composed by the list of resources which prevent the deletion of the specified entity. The resources are indexed by their kind.
1 property
1 required
UpdateResourceClassRequest
object
UpdateResourceClassRequest describes the update class description request.
1 property
1 required
WorkloadArtefactVersion
Details of a Workload Artefact Version
RuntimeInfoContainerStateRunning
object
Details about a running container.
1 property
RegistryCredsResponse
object
RegistryCreds represents current registry credentials (either, username- or token-based).
5 properties
1 required
OrganizationRole
string
Roles that can be assumed by an entity on an organization.
GroupRequest
object
GroupRequest holds the definition of a new group.
3 properties
3 required
AccountCredsRequest
object
AccountCreds represents an account credentials (either, username- or token-based).
3 properties
2 required
Group
object
Group holds the metadata of a new group.
4 properties
3 required
UpdateEnvironmentTypePayloadRequest
object
UpdateEnvironmentTypePayload contains the description field that should be set in the Environment Type to update.
1 property
ValuePatchPayloadRequest
object
3 properties
DeltaRequest
object
A Deployment Delta (or just "Delta") describes the changes that must be applied to one Deployment Set to generate another Deployment Set. Deployment Deltas are…
4 properties
WorkloadProfileSpecDefinitionProperty
object
8 properties
1 required
ApplicationPatchPayload
object
Patch request body to update Application metadata.
1 property
1 required
BatchItem
object
2 properties
2 required
EnvironmentID
string
ValueSetResponse
object
CreateResourceDefinitionRequestRequest
object
CreateResourceDefinitionRequest describes a new ResourceDefinition request.
8 properties
4 required
ConflictingResourcesErrorResponse
object
Represents a standard Humanitec Error with additional details which describe why an action on a specific resource cannot be performed due to some other entitie…
3 properties
3 required
ValueSource
string
Source of the value, "app" for app level, "env" for app env level.
RuntimeInfoStatus
string
Workload status.
PipelineJobPartial
object
Partial details of a Job within the Run. The full details, including steps, can be retrieved using the GetPipelineJob operation.
15 properties
13 required
SecretReference
object
It stores sensitive value in the organization primary store or a reference to a sensitive value stored in a store registered under the organization.
4 properties
UpdateActionRequest
object
A representation of the main object defined in JSON Patch specified in RFC 6902 from the IETF. The main differences are: Only add, remove and replace are suppo…
4 properties
MatchingCriteriaRuleRequest
object
MatchingCriteriaRule describes Matching Criteria rules.
5 properties
UserInviteResponse
object
UserInvite stores the invitation details.
5 properties
4 required
ImageResponse
object
DEPRECATED: This type exists for historical compatibility and should not be used. Please use the [Artefact API](https://api-docs.humanitec.com/tag/Artefact) in…
4 properties
4 required
AWSSMResponse
object
AWS Secret Manager specification.
2 properties
PipelineStep
object
A Step within a Job.
9 properties
8 required
Key
object
An object containing the details of a Key.
6 properties
6 required
WorkloadProfileSpecDefinitionRuntimeProperty
object
5 properties
1 required
PipelineJob
A response containing all of the details of an executing or completed Job including Step information.
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
UserProfileExtendedResponse
object
UserProfileExtended holds the profile information of a user including properties only accessible to the user.
7 properties
6 required
PatchResourceDefinitionRequestRequest
object
PatchResourceDefinitionRequest describes a ResourceDefinition change request.
5 properties
ValueSetVersionResultOf
string
ResourceClassResponse
object
Resource Classes provide a way of specializing Resource Types. Developers can set the class of a Resource alongside the type in their Score File. Platform team…
5 properties
5 required
GroupWithRole
object
GroupWithRole holds the metadata of a new group with its role in the organization.
5 properties
4 required
ConflictingResourcesErrorResponseDetailsResources
object
2 properties
ClusterConnectionCheckResultCondition
object
A condition associated with a test result. The condition
3 properties
3 required
ContainerArtefactVersion
Details of a Container Artefact Version
TokenResponse
object
Token holds the token and its type.
2 properties
1 required
AuditLogEntry
object
An entry in the audit log
6 properties
5 required
ResourceDefinitions
object
Object that contains definition id and resource type
2 properties
2 required
DeltaMetadataRequest
object
8 properties
ResourceProvisionRequestRequest
object
ResourceProvisionRequest is the payload passed to the resource provisioner, specifying the resources to be provisioned.
4 properties
2 required
ModuleDeltasRequest
object
ModuleDeltas groups the different operations together.
3 properties
DeploymentResponse
object
Deployments represent updates to the running state of an Environment. Deployments are made by applying Deltas to a state defined by an existing Deployment. The…
16 properties
11 required
UpdateResourceDefinitionRequestRequest
object
UpdateResourceDefinitionRequest describes a ResourceDefinition change request.
6 properties
1 required
RuntimeInfoContainerStatus
object
Container status.
5 properties
5 required
WebhookResponse
object
Webhook is a special type of a Job. It performs an HTTPS request to a specified URL with specified headers.
8 properties
6 required
OrganizationResponse
object
An Organization is the top level object in Humanitec. All other objects belong to an Organization.
7 properties
6 required
AutomationRuleRequest
object
An Automation Rule defining how and when artefacts in an environment should be updated.
9 properties
1 required
UserProfileExtendedRequest
object
UserProfileExtended holds the profile information of a user including properties only accessible to the user.
7 properties
DeltaMetadataResponse
object
8 properties
4 required
ClusterSecretsMapResponse
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
CheckResourceAccountField
object
An identity field or property resulting from the account check.
3 properties
3 required
ValueEditPayloadRequest
object
5 properties
1 required
DeploymentPipelineReferenceResponse
object
4 properties
4 required
SubjectPermissions
object
Maps of objects and permissions the subject holds on them.
1 property
1 required
TokenDefinitionRequest
object
Defines the token to be created.
4 properties
2 required
WorkloadProfileSpecDefinitionPropertyUIHints
object
2 properties
UserRoleRequest
object
Holds the mapping of role for a subject on a particular object.
2 properties
2 required
ErrorResponse
object
A standard error response
3 properties
2 required
ResourceTypeResponse
object
Resources Types define the technology that Applications can have dependencies on. Each Resource Type also defines a set of input parameters (inputsschema), and…
6 properties
6 required
PipelineVersion
object
An object containing the details of a Pipeline.
6 properties
6 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
PipelineRunCreateBody
object
The parameters for creating a new Run for the Pipeline.
1 property
1 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
PipelineRunCreateByDeploymentRequestCriteriaBody
object
Trigger the pipeline that has a deploymentrequest trigger and criteria that match this target environment. If "deltaid" or "setid" is provided, the matching cr…
7 properties
JSONPatchesResponse
array
WorkloadProfileResponse
object
Workload Profiles provide the baseline configuration for Workloads in Applications in Humanitec. Developers can configure various features of a workload profil…
12 properties
11 required
ArchiveDefinitionVersionRequest
object
1 property
PipelineStepLog
object
An item from the logs of a Step.
3 properties
3 required
PipelineRun
object
Details of a Run within the Pipeline.
20 properties
16 required
ResourceInputsResponse
object
A payload needed to generate a resource graph.
4 properties
2 required
UpdateResourceAccountRequestRequest
object
UpdateResourceAccountRequest describes the request to update the security account details.
2 properties
LogoResponse
object
2 properties
JSONFieldRequest
object
DeploymentErrorResponse
object
Error happening during deployment.
6 properties
6 required
ResourceTypeRequest
object
Resources Types define the technology that Applications can have dependencies on. Each Resource Type also defines a set of input parameters (inputsschema), and…
6 properties
2 required
RuntimeInfoStatusClass
string
Status class, statuses are aggregated into classes
CreateArtefactVersionBase
object
5 properties
2 required
WebhookRequest
object
Webhook is a special type of a Job. It performs an HTTPS request to a specified URL with specified headers.
6 properties
HumanitecPublicKey
object
HumanitecPublicKey stores a Public Key Humanitec shared with an organization.
3 properties
3 required
ModuleResponse
object
Module represents a collection of workload controllers (deployments/statefulsets/etc) for the module
4 properties
3 required
VaultResponse
object
Vault specification.
3 properties
WorkloadProfileSpecDefinitionPropertyType
string
WorkloadProfileVersionResponse
object
A version of a workload profile.
10 properties
10 required
ApplicationResponse
object
An Application is a collection of Workloads that work together. When deployed, all Workloads in an Application are deployed to the same namespace. Apps are the…
9 properties
8 required
ResourceAccountResponse
object
ResourceAccount represents the account being used to access a resource. Resource Accounts hold credentials that are required to provision and manage resources.
6 properties
6 required
DeployConditionResponse
object
A deploy condition for the workload Possible values for "when" are: - "before", deployed before other workloads - "deploy", deployed in-parallel with other wor…
3 properties
3 required
ImageBuildRequest
object
DEPRECATED: This type exists for historical compatibility and should not be used. Please use the [Artefact API](https://api-docs.humanitec.com/tag/Artefact) in…
4 properties
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
VaultAuthRequest
object
Credentials to authenticate Vault.
2 properties
SubjectTypeEnum
string
Subjects that can assume roles on objects.
PodStateResponse
object
PodState represents single pod status
5 properties
5 required
AWSSMRequest
object
AWS Secret Manager specification.
3 properties
EnvironmentRuntimeInfoResponse
object
EnvironmentRuntimeInfo
4 properties
2 required
Agent
object
An object containing the details of an Agent.
4 properties
3 required
TokenInfoResponse
object
Holds metadata about a token. expiresat is excluded if token does not expire.
6 properties
5 required
CreateSecretStorePayloadRequest
object
Secret Store represents external secret management system used by an organization to store secrets referenced in Humanitec. It must contain exactly one of the…
6 properties
2 required
UpdateArtefactVersionPayloadRequest
object
UpdateArtefactVersionPayload contains the archived field that should be set in the Artefact Version to update.
1 property
1 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
EnvironmentResponse
object
Environments are independent spaces where Applications can run. An Application is always deployed into an Environment.
10 properties
7 required
AccountTypeResponse
object
Resource Account Types define cloud providers or protocols to which a resource account can belong.
4 properties
2 required
GCPSMResponse
object
GCP Secret Manager specification.
1 property
AzureKVResponse
object
Azure Key Vault specification.
2 properties
VaultRequest
object
Vault specification.
4 properties
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
ResourceClassRequest
object
Resource Classes provide a way of specializing Resource Types. Developers can set the class of a Resource alongside the type in their Score File. Platform team…
2 properties
2 required
RuntimeInfoModuleController
object
K8s controller.
6 properties
2 required
PipelineApprovalRequest
object
An approval object
12 properties
10 required
EnvironmentBaseResponse
object
3 properties
3 required
ModuleRequest
object
Module single workload data
4 properties
RuntimeInfoControllerStateWaiting
object
Details about a waiting container
2 properties
AzureAuthRequest
object
Credentials to authenticate Azure Key Vault.
2 properties
WorkloadProfileRequest
object
Workload Profiles provide the baseline configuration for Workloads in Applications in Humanitec. Developers can configure various features of a workload profil…
6 properties
3 required
ResourceDefinitionChangeResponse
object
ResourceDefinitionChange describes the effects of a Resource Definition or Matching Criteria update/deletion.
5 properties
5 required
ClusterConnectionCheckRequest
object
Detailed needed to test a Kubernetes cluster connection
4 properties
3 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
ActiveResourceTargetDefinitionRequest
object
An active resource can be pinned to a certain version of the resource definition, then the resource is provisioned with this version.
1 property
1 required
JSONPatchResponse
object
3 properties
2 required
PipelineDeploymentRequestCriteria
object
A deployment request matching criteria for a Pipeline.
8 properties
4 required
WorkloadProfileFeatureResponse
object
4 properties
4 required
AutomationRuleResponse
object
An Automation Rule defining how and when artefacts in an environment should be updated.
12 properties
12 required
WorkloadArtefactVersionDeploymentSet
object
Humanitec definition for a Workload Artefact.
2 properties
2 required
PlainDeltaResponse
object
Similar to the delta response, except the id and metadata properties. Basic Structure { "modules" : { "add" : { : { } }, "remove": [ ], "update": { : [ ] } } }
2 properties
2 required
WorkloadProfileSpecDefinitionRuntimePropertyType
string
OutputEntryResponse
object
A container log entry.
5 properties
5 required
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
WorkloadProfileSpecDefinitionProperties
object
Workload spec definition
PipelineCriteria
object
4 properties
4 required
UpdateDriverRequestRequest
object
UpdateDriverRequest describes the update driver details request.
6 properties
4 required
EventResponse
object
Events available for triggering automated jobs.
3 properties
3 required
PipelineRunCreateByTriggerCriteriaBody
object
The parameters for creating a new Run based on trigger and inputs.
1 property
1 required
RuntimeInfoModule
object
Module represents a collection of workload controllers (deployments/statefulsets/etc) for the module.
3 properties
3 required
UserProfileResponse
object
UserProfile holds the profile information of a user
5 properties
4 required
HumanitecResponse
object
Humanitec built-in Secret Store specification.
EnvironmentTypeResponse
object
Environment Types are a way of grouping and managing Environments. Every Environment has exactly 1 Environment Type. Environment Types can be used with Externa…
2 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
AgentCreateBody
object
An object containing data needed to register an Agent.
3 properties
2 required
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
CreateWorkloadArtefactVersion
Details for creating a new Workload Artefact Version
GCPAuthRequest
object
Credentials to authenticate GCP Secret Manager.
1 property
ClusterSecretsMapRequest
object
ClusterSecretsMap stores a list of Kuberenetes secret references for the target deployment clusters.
PublicKey
object
PublicKey stores a Public Key an organization shares with Humanitec.
6 properties
6 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
AWSAuthRequest
object
Credentials to authenticate AWS Secret Manager.
2 properties
ModuleDeltasResponse
object
ModuleDeltas groups the different operations together.
3 properties
3 required
JSONFieldResponse
object
EnvironmentDefinitionRequest
object
4 properties
2 required
CheckResourceAccountData
object
The successful check response details.
2 properties
1 required
KeyCreateBody
object
1 property
1 required
Pipeline
object
An object containing the details of a Pipeline.
10 properties
9 required
ValuesSecretsRefsResponse
object
ValuesSecretsRefs stores data that should be passed around split by sensitivity.
3 properties
RuntimeInfoResponseV2
object
RuntimeInfo object returned by the runtime endpoint. Represents a list post statuses grouped by modules and controllers (deployments and stateful sets).
2 properties
2 required
ClusterSecretRequest
object
ClusterSecret represents Kubernetes secret reference.
2 properties
2 required
PipelineCriteriaCreateBody
object
1 property
1 required
SecretStoreResponse
object
Secret Store represents external secret management system used by an organization to store secrets referenced in Humanitec.
11 properties
6 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
EnvironmentBaseRequest
object
3 properties
3 required
ClusterConnectionCheckResult
object
The result of testing the Kubernetes cluster connection
3 properties
3 required
RuntimeInfoPod
object
k8s pod.
5 properties
4 required
WorkloadProfileSpecDefinition
object
Workload spec definition
2 properties
ValueSetVersionResponse
object
A Value Set Version can be used as a track record of Shared Values changes, to restore a previous version of a Shared Value or Value Set, or to purge a Shared…
9 properties
9 required
DependencyGraphResponse
object
The Dependency Graph which holds the list of objects which contain information to provision resources, sorted according to resources provisioning order.
5 properties
5 required
Batch
object
A batch of items that are being collected for a upcoming run.
2 properties
1 required
SetResponse
object
A Deployment Set (or just "Set") defines all of the non-Environment specific configuration for Modules and External Resources. Each of these Modules or Externa…
4 properties
4 required
NewServiceUserRequest
object
NewServiceUser holds the definition of a new service user.
3 properties
2 required
WorkloadProfileUpdateRequest
object
The proposed properties to update a workload profile.
5 properties
2 required
DeployConditionRequest
object
A deploy condition for the workload Possible values for "when" are: - "before", deployed before other workloads - "deploy", deployed in-parallel with other wor…
3 properties
EnvironmentTypeRequest
object
Environment Types are a way of grouping and managing Environments. Every Environment has exactly 1 Environment Type. Environment Types can be used with Externa…
2 properties
1 required
UpdateResourceTypeRequestRequest
object
5 properties
1 required
DeploymentRequest
object
Deployments represent updates to the running state of an Environment. Deployments are made by applying Deltas to a state defined by an existing Deployment. The…
5 properties
DeltaResponse
object
A Deployment Delta (or just "Delta") describes the changes that must be applied to one Deployment Set to generate another Deployment Set. Deployment Deltas are…
4 properties
4 required
CreateResourceAccountRequestRequest
object
CreateResourceAccountRequest describes the request to create a new security account.
4 properties
4 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
NodeBodyResponse
object
NodeBody represents a node of a Resource Dependency Graph.
14 properties
12 required
UserRoleResponse
object
UserRole holds the mapping of role to user or group for a particular object.
8 properties
5 required
ValueSetActionPayloadRequest
object
1 property
GCPSMRequest
object
GCP Secret Manager specification.
2 properties
EnvironmentBaseUpdateRequest
object
1 property
ArtefactVersionBase
object
11 properties
5 required
WebhookUpdateResponse
object
Webhook is a special type of a Job. It performs an HTTPS request to a specified URL with specified headers.
5 properties
5 required
PipelineDeploymentRequestCriteriaCreateBody
object
The details required to create a new deployment request matching criteria for a Pipeline.
4 properties
ValueResponse
object
Shared Values can be used to manage variables and configuration that might vary between environments. They are also the way that secrets can be stored securely…
10 properties
10 required
UpdateSecretStorePayloadRequest
object
Secret Store represents external secret management system used by an organization to store secrets referenced in Humanitec.
5 properties
RuntimeInfoContainerState
object
Details about the container's current condition.
3 properties
RolesResponse
object
ValueCreatePayloadRequest
object
5 properties
2 required
AgentPatchBody
object
An object containing data to update the description field of an Agent.
1 property
1 required
DeploymentPipelineReferenceRequest
object
4 properties
WorkloadProfileChartReference
object
References a workload profile chart.
2 properties
2 required
RuntimeInfoResponseV1
object
RuntimeInfo object returned by the runtime endpoint. Represents a list post statuses grouped by modules and controllers (deployments and stateful sets).
2 properties
2 required
ClusterConnectionCheckResourceSummary
object
8 properties
8 required
Permissions
object
List of permissions.
1 property
1 required
ImageBuildResponse
object
DEPRECATED: This type exists for historical compatibility and should not be used. Please use the [Artefact API](https://api-docs.humanitec.com/tag/Artefact) in…
5 properties
4 required
ErrorInfoResponse
object
ErrorInfo is returned by a handler in case of an error.
1 property
1 required
ControllerResponse
object
Controller represents deployment, stateful set etc
6 properties
6 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Humanitec 12
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
#public