Humanitec Public API
The public API from Humanitec — 141 operation(s) for public.
Operations 213
GET
/orgs/{orgId}/apps/{appId}/envs/{envId}/deploys/{deployId}/errors
List errors that occurred in a Deployment
#
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…
#
POST
/orgs/{orgId}/artefact-versions/convert-score
Convert a Score specification, optional overrides, and extensions into the…
#
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}/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
#
GET
/orgs/{orgId}/pipelines
List all Pipelines within an Organization. This can be filtered by Application
#
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
#
POST
/orgs/{orgId}/apps/{appId}/pipeline-runs
Create a Pipeline Run in the appropriate Pipeline based on the trigger and…
#
GET
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs
List runs within a pipeline ordered newest to oldest
#
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}/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
#
DELETE
/orgs/{orgId}/registries/{regId}
Deletes an existing registry record and all associated credentials and secrets
#
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/graph
Lists the resource objects that hold the information needed to provision the…
#
POST
/orgs/{orgId}/apps/{appId}/envs/{envId}/resources/graphs
Create a Dependency Graph which is composed by the resource objects that hold…
#
GET
/orgs/{orgId}/apps/{appId}/envs/{envId}/resources/graphs/{graphId}
Retrieve a Dependency Graph by its ID
#
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
#
POST
/orgs/{orgId}/resources/accounts/{accId}/actions/check
Check the credentials of an existing Resource Account
#
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
#
PATCH
/orgs/{orgId}/resources/types/{typeId}/classes/{classId}
Update a resource class description
#
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
#
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}/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.
#
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…
#
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
#
DELETE
/orgs/{orgId}/apps/{appId}/envs/{envId}/values/{key}
Delete Shared Value for an Environment
#
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}/workload-profile-features
List workload profile features available to the organization
#
GET
/orgs/{orgId}/workload-profiles/{profileQid}/versions
List versions of the given workload profile
#
GET
/orgs/{orgId}/workload-profiles/{profileQid}/versions/latest
Latest version of the given workload profile with optional constraint
#
GET
/orgs/{orgId}/workload-profile-chart-versions
Workload Profile Chart Versions for the given organization
#
Documentation
📖
Documentation
https://developer.humanitec.com/platform-orchestrator/reference/api-references/
📖
GettingStarted
https://developer.humanitec.com/introduction/overview/
📖
Authentication
https://developer.humanitec.com/platform-orchestrator/security/api-tokens/