Search skmtc

⌘K

Docs
History
Schema
Generate

Filter operations

Agents7

public213

get/orgs/{orgId}/appsList all Applications in an Organization.
post/orgs/{orgId}/appsAdd 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}/envsList all Environments.
post/orgs/{orgId}/apps/{appId}/envsAdd 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}/deploysList Deployments in an Environment.
post/orgs/{orgId}/apps/{appId}/envs/{envId}/deploysStart 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}/errorsList errors that occurred in a Deployment.
put/orgs/{orgId}/apps/{appId}/envs/{envId}/from_deploy_idRebase to a different Deployment.
get/orgs/{orgId}/env-typesList all Environment Types
post/orgs/{orgId}/env-typesAdd 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-versionsList all Artefacts Versions in the org.
post/orgs/{orgId}/artefact-versionsRegister a new Artefact Version with your organization.
get/orgs/{orgId}/artefact-versions/{artefactVersionId}Get an Artefacts Versions.
get/orgs/{orgId}/artefact-versions/{artefactVersionId}/workload-specGet the spec of this Workload Artefact Version
get/orgs/{orgId}/artefact-versions/{artefactVersionId}/workload-deployment-setGet the Humanitec module definition of this Workload Artefact Version as a deployment set
get/orgs/{orgId}/artefactsList all Artefacts.
delete/orgs/{orgId}/artefacts/{artefactId}Delete Artefact and all related Artefact Versions
get/orgs/{orgId}/artefacts/{artefactId}/versionsList all Artefact Versions of an Artefact.
patch/orgs/{orgId}/artefacts/{artefactId}/versions/{versionId}Update Version of an Artefact.
get/orgs/{orgId}/imagesList all Container Images
get/orgs/{orgId}/images/{imageId}Get a specific Image Object
get/orgs/{orgId}/images/{imageId}/buildsLists all the Builds of an Image
post/orgs/{orgId}/images/{imageId}/buildsAdd a new Image Build
post/orgs/{orgId}/artefact-versions/convert-scoreConvert a Score specification, optional overrides, and extensions into the contents for a deployment set.
get/orgs/{orgId}/audit-logsList audit log entries by Organization
get/orgs/{orgId}/apps/{appId}/envs/{envId}/rulesList all Automation Rules in an Environment.
post/orgs/{orgId}/apps/{appId}/envs/{envId}/rulesCreate 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}/deltasList Deltas in an Application
post/orgs/{orgId}/apps/{appId}/deltasCreate 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/archivedMark a Delta as "archived"
put/orgs/{orgId}/apps/{appId}/deltas/{deltaId}/metadata/env_idChange the Environment of a Delta
put/orgs/{orgId}/apps/{appId}/deltas/{deltaId}/metadata/nameChange the name of a Delta
get/orgs/{orgId}/apps/{appId}/setsGet 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}/resourcesGet 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}/jobsDeletes all Jobs for the Application
get/orgs/{orgId}/apps/{appId}/webhooksList Webhooks
post/orgs/{orgId}/apps/{appId}/webhooksCreate 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}/eventsList Events
get/orgs/{orgId}/keysList all public keys associated to an organization.
post/orgs/{orgId}/keysAssociate 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-keysList all the public keys Humanitec shares with an organization.
get/orgs/{orgId}/apps/{appId}/envs/{envId}/logsGet container log entries for the environment
get/orgsList active organizations the user has access to.
get/orgs/{orgId}Get the specified Organization.
get/orgs/{orgId}/pipelinesList all Pipelines within an Organization. This can be filtered by Application.
get/orgs/{orgId}/apps/{appId}/pipelinesList Pipelines within an Application.
post/orgs/{orgId}/apps/{appId}/pipelinesCreate 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}/versionsList all versions of the pipeline
get/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/schemaGet a pipeline schema.
get/orgs/{orgId}/apps/{appId}/pipeline-criteriaList the trigger matching criteria defined for Pipelines in this Application.
post/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/criteriaCreate 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/latestGets the latest pipeline schema
get/orgs/{orgId}/pipeline-runsList 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-runsCreate a Pipeline Run in the appropriate Pipeline based on the trigger and inputs.
get/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runsList runs within a pipeline ordered newest to oldest.
post/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runsCreate 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}/cancelCancel a Run within an Pipeline.
post/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/restartRestart a Run within an Pipeline by cloning it with the same trigger and inputs.
get/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobsList 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}/logsGet a page of log output for a given step within a job.
get/orgs/{orgId}/apps/{appId}/approvalsList 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}/approveApprove the approval request
post/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs/{jobId}/approvals/{approvalId}/denyDeny the approval request
get/orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/batches/{batchType}Read the current state of a trigger batch
get/orgs/{orgId}/registriesLists available registries for the organization.
post/orgs/{orgId}/registriesCreates 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}/credsReturns current account credentials or secret details for the registry.
get/orgs/{orgId}/apps/{appId}/envs/{envId}/resourcesList Active Resources provisioned in an environment.
post/orgs/{orgId}/apps/{appId}/envs/{envId}/resources/graphLists 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/graphsCreate 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/pinPin Active Resource to a target Resource Definition Version.
get/orgs/{orgId}/resources/account-typesList Resource Account Types available to the organization.
get/orgs/{orgId}/resources/accountsList Resource Accounts in the organization.
post/orgs/{orgId}/resources/accountsCreate 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/checkCheck the credentials of an existing Resource Account
get/orgs/{orgId}/resources/defsList Resource Definitions.
post/orgs/{orgId}/resources/defsCreate 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}/versionsGet 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/archiveMark/unmark the Resource Definition Version as archived.
post/orgs/{orgId}/resources/defs/{defId}/versions/{defVersionId}/actions/promotePromote the Resource Definition Version as active.
put/orgs/{orgId}/resources/defs/{defId}/criteriaUpdate all Matching Criteria of a Resource Definition.
post/orgs/{orgId}/resources/defs/{defId}/criteriaAdd 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}/resourcesList Active Resources provisioned via a specific Resource Definition.
get/orgs/{orgId}/resources/driversList Resource Drivers.
post/orgs/{orgId}/resources/driversRegister 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/typesList Resource Types.
post/orgs/{orgId}/resources/typesCreates 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/classesList resource classes.
post/orgs/{orgId}/resources/types/{typeId}/classesCreates 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}/runtimeGet Runtime information about the environment.
put/orgs/{orgId}/apps/{appId}/envs/{envId}/runtime/pausedPause / Resume an environment.
patch/orgs/{orgId}/apps/{appId}/envs/{envId}/runtime/replicasSet number of replicas for an environment's modules.
get/orgs/{orgId}/apps/{appId}/runtimeGet Runtime information about specific multiple environments.
post/orgs/{orgId}/runtime/actions/check-connectivityProvision and check the cluster connectivity in an environment
get/orgs/{orgId}/secretstoresGet list of Secret Stores for the given organization.
post/orgs/{orgId}/secretstoresCreate 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-userGets the extended profile of the current user
patch/current-userUpdates the extended profile of the current user.
post/orgs/{orgId}/groupsCreate a group in an organization
get/orgs/{orgId}/groups/{groupId}/usersList users in a group.
get/orgs/{orgId}/apps/{appId}/usersList Users or Groups with roles in an App
post/orgs/{orgId}/apps/{appId}/usersAdds 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}/usersList Users and Groups with roles in an Environment Type
post/orgs/{orgId}/env-types/{envType}/usersAdds 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}/invitationsList the invites issued for the organization.
post/orgs/{orgId}/invitationsInvites a user to an Organization with a specified role.
get/orgs/{orgId}/usersList Users and Groups with roles in an Organization
post/orgs/{orgId}/usersCreates 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}/groupsGet the groups in an organization a user belongs to.
get/users/{userId}/tokensLists tokens associated with a user
post/users/{userId}/tokensCreates 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-versionsList 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}/restoreRestore 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}/valuesList Shared Values in an Environment
post/orgs/{orgId}/apps/{appId}/envs/{envId}/valuesCreate a Shared Value for an Environment
delete/orgs/{orgId}/apps/{appId}/envs/{envId}/valuesDelete 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-versionsList 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}/restoreRestore 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}/valuesList Shared Values in an Application
post/orgs/{orgId}/apps/{appId}/valuesCreate a Shared Value for an Application
delete/orgs/{orgId}/apps/{appId}/valuesDelete 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-featuresList workload profile features available to the organization.
get/orgs/{orgId}/workload-profilesList workload profiles available to the organization.
post/orgs/{orgId}/workload-profilesCreate 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}/versionsList versions of the given workload profile.
get/orgs/{orgId}/workload-profiles/{profileQid}/versions/latestLatest version of the given workload profile with optional constraint.
get/orgs/{orgId}/workload-profile-chart-versionsWorkload Profile Chart Versions for the given organization.
post/orgs/{orgId}/workload-profile-chart-versionsAdd new Workload Profile Chart Version

UserRole1

public

Changes to List Webhooks

get/orgs/{orgId}/apps/{appId}/webhooks

Aug 31, 20263980a71317ca Revision changes
- info
  added the required property / to the response with the status