Search skmtc
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
Agents
7
public
213
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
delete
/orgs/{orgId}/apps/{appId}
Delete an Application
patch
/orgs/{orgId}/apps/{appId}
Update metadata of an existing 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.
delete
/orgs/{orgId}/apps/{appId}/envs/{envId}
Delete a specific Environment.
patch
/orgs/{orgId}/apps/{appId}/envs/{envId}
Update 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
put
/orgs/{orgId}/apps/{appId}/deltas/{deltaId}
Update an existing Delta
patch
/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
get
/orgs/{orgId}/keys
List all public keys associated to an organization.
post
/orgs/{orgId}/keys
Associate a new RSA public key to an organization.
get
/orgs/{orgId}/keys/{keyId}
Retrieve a single public key associated to an organization.
delete
/orgs/{orgId}/keys/{keyId}
Delete a 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.
delete
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}
Delete a pipeline within an application.
patch
/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}
update 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/graph
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.
put
/orgs/{orgId}/resources/types/{typeId}
Update a Resource Type.
delete
/orgs/{orgId}/resources/types/{typeId}
Delete a Resource Type.
patch
/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.
delete
/orgs/{orgId}/resources/types/{typeId}/classes/{classId}
Delete a resource class.
patch
/orgs/{orgId}/resources/types/{typeId}/classes/{classId}
Update a resource class description.
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
/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/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.
post
/orgs/{orgId}/workload-profile-chart-versions
Add new Workload Profile Chart Version
UserRole
1
public
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Delete a specific Environment.
delete
/orgs/{orgId}/apps/{appId}/envs/{envId}
Jun 21, 2025
4db6186594e3
Revision changes
info
added the success response with the status
202