Humanitec · Capability

Humanitec API — public

Humanitec API — public. 221 operations. Lead operation: Gets the extended profile of the current user. Self-contained Naftiko capability covering one Humanitec business surface.

Run with Naftiko Humanitecpublic

What You Can Do

GET
Getcurrentuser — Gets the extended profile of the current user
/v1/current-user
PATCH
Updatecurrentuser — Updates the extended profile of the current user.
/v1/current-user
GET
Listorganizations — List active organizations the user has access to.
/v1/orgs
GET
Getorganization — Get the specified Organization.
/v1/orgs/{orgid}
POST
Createagent — Register a new Agent under an Organization.
/v1/orgs/{orgid}/agents
GET
Listagents — List all the agents in an Organization.
/v1/orgs/{orgid}/agents
DELETE
Deleteagent — Delete an Agent (and its keys) stored under an Organization.
/v1/orgs/{orgid}/agents/{agentid}
PATCH
Patchagent — Update the description of an Agent.
/v1/orgs/{orgid}/agents/{agentid}
GET
Listkeysinagent — List all the keys registered under an Agent in an Organization.
/v1/orgs/{orgid}/agents/{agentid}/keys
POST
Createkey — Register a new Key under an Agent in an Organization.
/v1/orgs/{orgid}/agents/{agentid}/keys
DELETE
Deletekeyinagent — Delete a key registered under a Agent.
/v1/orgs/{orgid}/agents/{agentid}/keys/{fingerprint}
GET
Listapplications — List all Applications in an Organization.
/v1/orgs/{orgid}/apps
POST
Createapplication — Add a new Application to an Organization
/v1/orgs/{orgid}/apps
GET
Getapplication — Get an existing Application
/v1/orgs/{orgid}/apps/{appid}
PATCH
Patchapplication — Update metadata of an existing Application
/v1/orgs/{orgid}/apps/{appid}
DELETE
Deleteapplication — Delete an Application
/v1/orgs/{orgid}/apps/{appid}
GET
Listpipelineapprovalrequests — List of the approval requests
/v1/orgs/{orgid}/apps/{appid}/approvals
GET
Listdeltas — List Deltas in an Application
/v1/orgs/{orgid}/apps/{appid}/deltas
POST
Createdelta — Create a new Delta
/v1/orgs/{orgid}/apps/{appid}/deltas
GET
Getdelta — Fetch an existing Delta
/v1/orgs/{orgid}/apps/{appid}/deltas/{deltaid}
PATCH
Patchdelta — Update an existing Delta
/v1/orgs/{orgid}/apps/{appid}/deltas/{deltaid}
PUT
Putdelta — Update an existing Delta
/v1/orgs/{orgid}/apps/{appid}/deltas/{deltaid}
PUT
Archivedelta — Mark a Delta as "archived"
/v1/orgs/{orgid}/apps/{appid}/deltas/{deltaid}/metadata/archived
PUT
Changeenvofdelta — Change the Environment of a Delta
/v1/orgs/{orgid}/apps/{appid}/deltas/{deltaid}/metadata/env-id
PUT
Changenameofdelta — Change the name of a Delta
/v1/orgs/{orgid}/apps/{appid}/deltas/{deltaid}/metadata/name
GET
Listenvironments — List all Environments.
/v1/orgs/{orgid}/apps/{appid}/envs
POST
Createenvironment — Add a new Environment to an Application.
/v1/orgs/{orgid}/apps/{appid}/envs
GET
Getenvironment — Get a specific Environment.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}
PATCH
Updateenvironment — Update a specific Environment.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}
DELETE
Deleteenvironment — Delete a specific Environment.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}
GET
Listdeployments — List Deployments in an Environment.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/deploys
POST
Createdeployment — Start a new Deployment.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/deploys
GET
Getdeployment — Get a specific Deployment.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/deploys/{deployid}
GET
Listdeploymenterrors — List errors that occurred in a Deployment.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/deploys/{deployid}/errors
PUT
Rebaseenvironment — Rebase to a different Deployment.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/from-deploy-id
GET
Get — Get container log entries for the environment
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/logs
GET
Listactiveresources — List Active Resources provisioned in an environment.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/resources
POST
Queryresourcegraph — Lists the resource objects that hold the information needed to provision the resources specified in the request and the resources they depend on.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/resources/graph
POST
Createdependencygraph — 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.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/resources/graphs
GET
Getdependencygraph — Retrieve a Dependency Graph by its ID.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/resources/graphs/{graphid}
DELETE
Deleteactiveresource — Delete Active Resource.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/resources/{type}/{resid}
POST
Pinactiveresource — Pin Active Resource to a target Resource Definition Version.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/resources/{type}/{resid}/actions/pin
GET
Listautomationrules — List all Automation Rules in an Environment.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/rules
POST
Createautomationrule — Create a new Automation Rule for an Environment.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/rules
GET
Getautomationrule — Get a specific Automation Rule for an Environment.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/rules/{ruleid}
PUT
Updateautomationrule — Update an existing Automation Rule for an Environment.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/rules/{ruleid}
DELETE
Deleteautomationrule — Delete Automation Rule from an Environment.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/rules/{ruleid}
GET
Getruntime — Get Runtime information about the environment.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/runtime
PUT
Updatepaused — Pause / Resume an environment.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/runtime/paused
PATCH
Patchreplicas — Set number of replicas for an environment's modules.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/runtime/replicas
GET
Get — List Value Set Versions in an Environment of an App
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/value-set-versions
GET
Get — 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.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/value-set-versions/{valuesetversionid}
POST
Post — Purge the value of a specific Shared Value from the App Environment Version history.
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/value-set-versions/{valuesetversionid}/purge/{key}
POST
Post — Restore a Value Set Version in an Environment of an App
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/value-set-versions/{valuesetversionid}/restore
POST
Post — Restore a specific key from the Value Set Version in an Environment of an App
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/value-set-versions/{valuesetversionid}/restore/{key}
GET
Get — List Shared Values in an Environment
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/values
POST
Post — Create a Shared Value for an Environment
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/values
DELETE
Delete — Delete all Shared Value for an Environment
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/values
PUT
Put — Update Shared Value for an Environment
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/values/{key}
DELETE
Delete — Delete Shared Value for an Environment
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/values/{key}
PATCH
Patch — Update Shared Value for an Environment
/v1/orgs/{orgid}/apps/{appid}/envs/{envid}/values/{key}
DELETE
Delete — Deletes all Jobs for the Application
/v1/orgs/{orgid}/apps/{appid}/jobs
GET
Listpipelinecriteriainapp — List the trigger matching criteria defined for Pipelines in this Application.
/v1/orgs/{orgid}/apps/{appid}/pipeline-criteria
POST
Createpipelinerunbytriggercriteria — Create a Pipeline Run in the appropriate Pipeline based on the trigger and inputs.
/v1/orgs/{orgid}/apps/{appid}/pipeline-runs
GET
Listpipelines — List Pipelines within an Application.
/v1/orgs/{orgid}/apps/{appid}/pipelines
POST
Createpipeline — Create a Pipeline within an Application.
/v1/orgs/{orgid}/apps/{appid}/pipelines
GET
Getpipeline — Get a Pipeline within an Application.
/v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}
PATCH
Updatepipeline — update a Pipeline within an Application.
/v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}
DELETE
Deletepipeline — Delete a pipeline within an application.
/v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}
GET
Getbatch — Read the current state of a trigger batch
/v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/batches/{batchtype}
POST
Createpipelinecriteria — Create a new trigger matching criteria for this Pipeline.
/v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/criteria
GET
Getpipelinecriteria — Get the Pipeline Criteria with the given id.
/v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/criteria/{criteriaid}
DELETE
Deletepipelinecriteria — Delete the Pipeline Criteria with the given id.
/v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/criteria/{criteriaid}
GET
Listpipelineruns — List runs within a pipeline ordered newest to oldest.
/v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/runs
POST
Createpipelinerun — Create a run within a pipeline.
/v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/runs
GET
Getpipelinerun — Get a run within an pipeline.
/v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/runs/{runid}
DELETE
Deletepipelinerun — Deleting a completed Run within a Pipeline.
/v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/runs/{runid}
POST
Cancelpipelinerun — Cancel a Run within an Pipeline.
/v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/runs/{runid}/cancel
GET
Listpipelinejobs — List the details of the jobs within a pipeline run.
/v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/runs/{runid}/jobs
GET
Getpipelinejob — List the details of a Job including Step information
/v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/runs/{runid}/jobs/{jobid}
GET
Getpipelineapprovalrequest — Get an approval request
/v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/runs/{runid}/jobs/{jobid}/approvals/{approvalid}
POST
Approvepipelineapprovalrequest — Approve the approval request
/v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/runs/{runid}/jobs/{jobid}/approvals/{approvalid}/approve
POST
Denypipelineapprovalrequest — Deny the approval request
/v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/runs/{runid}/jobs/{jobid}/approvals/{approvalid}/deny
GET
Listpipelinesteplogs — Get a page of log output for a given step within a job.
/v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/runs/{runid}/jobs/{jobid}/steps/{stepindex}/logs
POST
Restartpipelinerun — Restart a Run within an Pipeline by cloning it with the same trigger and inputs.
/v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/runs/{runid}/restart
GET
Getpipelinedefinition — Get a pipeline schema.
/v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/schema
GET
Listpipelineversions — List all versions of the pipeline
/v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/versions
GET
Listruntime — Get Runtime information about specific multiple environments.
/v1/orgs/{orgid}/apps/{appid}/runtime
GET
Listsets — Get all Deployment Sets
/v1/orgs/{orgid}/apps/{appid}/sets
GET
Getset — Get a Deployment Set
/v1/orgs/{orgid}/apps/{appid}/sets/{setid}
POST
Updateset — Apply a Deployment Delta to a Deployment Set
/v1/orgs/{orgid}/apps/{appid}/sets/{setid}
GET
Getdiff — Get the difference between 2 Deployment Sets
/v1/orgs/{orgid}/apps/{appid}/sets/{setid}/diff/{sourcesetid}
GET
Getsetresourceinputs — Get Resource Inputs for the given Deployment Set
/v1/orgs/{orgid}/apps/{appid}/sets/{setid}/resources
GET
Listuserrolesinapp — List Users or Groups with roles in an App
/v1/orgs/{orgid}/apps/{appid}/users
POST
Createuserroleinapp — Adds a User or a Group to an Application with a Role
/v1/orgs/{orgid}/apps/{appid}/users
GET
Getuserroleinapp — Get the role of a User or a Group on an Application
/v1/orgs/{orgid}/apps/{appid}/users/{userid}
DELETE
Deleteuserroleinapp — Remove the role of a User or a Group on an Application
/v1/orgs/{orgid}/apps/{appid}/users/{userid}
PATCH
Updateuserroleinapp — Update the role of a User or a Group on an Application
/v1/orgs/{orgid}/apps/{appid}/users/{userid}
GET
Get — List Value Set Versions in the App
/v1/orgs/{orgid}/apps/{appid}/value-set-versions
GET
Get — Get a single Value Set Version from the App
/v1/orgs/{orgid}/apps/{appid}/value-set-versions/{valuesetversionid}
POST
Post — Purge the value of a specific Shared Value from the App Version history.
/v1/orgs/{orgid}/apps/{appid}/value-set-versions/{valuesetversionid}/purge/{key}
POST
Post — Restore a Value Set Version in an App
/v1/orgs/{orgid}/apps/{appid}/value-set-versions/{valuesetversionid}/restore
POST
Post — Restore a specific key from the Value Set Version in an App
/v1/orgs/{orgid}/apps/{appid}/value-set-versions/{valuesetversionid}/restore/{key}
GET
Get — List Shared Values in an Application
/v1/orgs/{orgid}/apps/{appid}/values
POST
Post — Create a Shared Value for an Application
/v1/orgs/{orgid}/apps/{appid}/values
DELETE
Delete — Delete all Shared Value for an App
/v1/orgs/{orgid}/apps/{appid}/values
PUT
Put — Update Shared Value for an Application
/v1/orgs/{orgid}/apps/{appid}/values/{key}
DELETE
Delete — Delete Shared Value for an Application
/v1/orgs/{orgid}/apps/{appid}/values/{key}
PATCH
Patch — Update Shared Value for an Application
/v1/orgs/{orgid}/apps/{appid}/values/{key}
GET
Get — List Webhooks
/v1/orgs/{orgid}/apps/{appid}/webhooks
POST
Post — Create a new Webhook
/v1/orgs/{orgid}/apps/{appid}/webhooks
GET
Get — Get a Webhook
/v1/orgs/{orgid}/apps/{appid}/webhooks/{jobid}
DELETE
Delete — Delete a Webhook
/v1/orgs/{orgid}/apps/{appid}/webhooks/{jobid}
PATCH
Patch — Update a Webhook
/v1/orgs/{orgid}/apps/{appid}/webhooks/{jobid}
GET
Listartefactversionsinorg — List all Artefacts Versions in the org.
/v1/orgs/{orgid}/artefact-versions
POST
Createartefactversion — Register a new Artefact Version with your organization.
/v1/orgs/{orgid}/artefact-versions
POST
Convertscoretoset — Convert a Score specification, optional overrides, and extensions into the contents for a deployment set.
/v1/orgs/{orgid}/artefact-versions/convert-score
GET
Getartefactversion — Get an Artefacts Versions.
/v1/orgs/{orgid}/artefact-versions/{artefactversionid}
GET
Getworkloadartefactversiondeploymentset — Get the Humanitec module definition of this Workload Artefact Version as a deployment set
/v1/orgs/{orgid}/artefact-versions/{artefactversionid}/workload-deployment-set
GET
Getworkloadartefactversionspec — Get the spec of this Workload Artefact Version
/v1/orgs/{orgid}/artefact-versions/{artefactversionid}/workload-spec
GET
Listartefacts — List all Artefacts.
/v1/orgs/{orgid}/artefacts
DELETE
Deleteartefact — Delete Artefact and all related Artefact Versions
/v1/orgs/{orgid}/artefacts/{artefactid}
GET
Listartefactversions — List all Artefact Versions of an Artefact.
/v1/orgs/{orgid}/artefacts/{artefactid}/versions
PATCH
Patchartefactversion — Update Version of an Artefact.
/v1/orgs/{orgid}/artefacts/{artefactid}/versions/{versionid}
GET
Listauditlogentries — List audit log entries by Organization
/v1/orgs/{orgid}/audit-logs
GET
Listenvironmenttypes — List all Environment Types
/v1/orgs/{orgid}/env-types
POST
Createenvironmenttype — Add a new Environment Type
/v1/orgs/{orgid}/env-types
GET
Getenvironmenttype — Get an Environment Type
/v1/orgs/{orgid}/env-types/{envtypeid}
DELETE
Deleteenvironmenttype — Deletes an Environment Type
/v1/orgs/{orgid}/env-types/{envtypeid}
PATCH
Updateenvironmenttype — Updates Environment Type
/v1/orgs/{orgid}/env-types/{envtypeid}
GET
Listuserrolesinenvtype — List Users and Groups with roles in an Environment Type
/v1/orgs/{orgid}/env-types/{envtype}/users
POST
Createuserroleinenvtype — Adds a User or a Group to an Environment Type with a Role
/v1/orgs/{orgid}/env-types/{envtype}/users
GET
Getuserroleinenvtype — Get the role of a User or a Group on an Environment Type
/v1/orgs/{orgid}/env-types/{envtype}/users/{userid}
DELETE
Deleteuserroleinenvtype — Remove the role of a User or a Group on an Environment Type
/v1/orgs/{orgid}/env-types/{envtype}/users/{userid}
PATCH
Updateuserroleinenvtype — Update the role of a User or a Group on an Environment Type
/v1/orgs/{orgid}/env-types/{envtype}/users/{userid}
GET
Get — List Events
/v1/orgs/{orgid}/events
POST
Creategroup — Create a group in an organization
/v1/orgs/{orgid}/groups
GET
Listgroupusers — List users in a group.
/v1/orgs/{orgid}/groups/{groupid}/users
GET
Listhumanitecpublickeys — List all the public keys Humanitec shares with an organization.
/v1/orgs/{orgid}/humanitec-keys
GET
Listdeprecatedimages — List all Container Images
/v1/orgs/{orgid}/images
GET
Getdeprecatedimage — Get a specific Image Object
/v1/orgs/{orgid}/images/{imageid}
GET
Listdeprecatedimagebuilds — Lists all the Builds of an Image
/v1/orgs/{orgid}/images/{imageid}/builds
POST
Createdeprecatedimagebuild — Add a new Image Build
/v1/orgs/{orgid}/images/{imageid}/builds
GET
Listinvitesinorg — List the invites issued for the organization.
/v1/orgs/{orgid}/invitations
POST
Createinviteinorg — Invites a user to an Organization with a specified role.
/v1/orgs/{orgid}/invitations
POST
Createpublickey — Associate a new RSA public key to an organization.
/v1/orgs/{orgid}/keys
GET
Listpublickeys — List all public keys associated to an organization.
/v1/orgs/{orgid}/keys
DELETE
Deletepublickey — Delete a public key associated to an organization.
/v1/orgs/{orgid}/keys/{keyid}
GET
Getpublickey — Retrieve a single public key associated to an organization.
/v1/orgs/{orgid}/keys/{keyid}
GET
Listpipelinerunsbyorg — List all pipeline runs within the Org ordered newest to oldest. This can be filtered by app, pipeline, and status.
/v1/orgs/{orgid}/pipeline-runs
GET
Getlatestpipelinedefinitionschema — Gets the latest pipeline schema
/v1/orgs/{orgid}/pipeline-schemas/latest
GET
Listpipelinesinorg — List all Pipelines within an Organization. This can be filtered by Application.
/v1/orgs/{orgid}/pipelines
GET
Get — Lists available registries for the organization.
/v1/orgs/{orgid}/registries
POST
Post — Creates a new registry record.
/v1/orgs/{orgid}/registries
GET
Get — Loads a registry record details.
/v1/orgs/{orgid}/registries/{regid}
DELETE
Delete — Deletes an existing registry record and all associated credentials and secrets.
/v1/orgs/{orgid}/registries/{regid}
PATCH
Patch — Updates (patches) an existing registry record.
/v1/orgs/{orgid}/registries/{regid}
GET
Get — Returns current account credentials or secret details for the registry.
/v1/orgs/{orgid}/registries/{regid}/creds
GET
Listresourceaccounttypes — List Resource Account Types available to the organization.
/v1/orgs/{orgid}/resources/account-types
GET
Listresourceaccounts — List Resource Accounts in the organization.
/v1/orgs/{orgid}/resources/accounts
POST
Createresourceaccount — Create a new Resource Account in the organization.
/v1/orgs/{orgid}/resources/accounts
GET
Getresourceaccount — Get a Resource Account.
/v1/orgs/{orgid}/resources/accounts/{accid}
DELETE
Deleteresourceaccount — Delete an unused Resource Account.
/v1/orgs/{orgid}/resources/accounts/{accid}
PATCH
Patchresourceaccount — Update a Resource Account.
/v1/orgs/{orgid}/resources/accounts/{accid}
POST
Checkresourceaccount — Check the credentials of an existing Resource Account
/v1/orgs/{orgid}/resources/accounts/{accid}/actions/check
GET
Listresourceclasses — List resource classes.
/v1/orgs/{orgid}/resources/classes
GET
Listresourcedefinitions — List Resource Definitions.
/v1/orgs/{orgid}/resources/defs
POST
Createresourcedefinition — Create a new Resource Definition.
/v1/orgs/{orgid}/resources/defs
GET
Getresourcedefinition — Get a Resource Definition.
/v1/orgs/{orgid}/resources/defs/{defid}
PUT
Updateresourcedefinition — Update a Resource Definition.
/v1/orgs/{orgid}/resources/defs/{defid}
DELETE
Deleteresourcedefinition — Delete a Resource Definition.
/v1/orgs/{orgid}/resources/defs/{defid}
PATCH
Patchresourcedefinition — Update a Resource Definition.
/v1/orgs/{orgid}/resources/defs/{defid}
PUT
Updateresourcedefinitioncriteria — Update all Matching Criteria of a Resource Definition.
/v1/orgs/{orgid}/resources/defs/{defid}/criteria
POST
Createresourcedefinitioncriteria — Add a new Matching Criteria to a Resource Definition.
/v1/orgs/{orgid}/resources/defs/{defid}/criteria
DELETE
Deleteresourcedefinitioncriteria — Delete a Matching Criteria from a Resource Definition.
/v1/orgs/{orgid}/resources/defs/{defid}/criteria/{criteriaid}
GET
Listactiveresourcebydefinition — List Active Resources provisioned via a specific Resource Definition.
/v1/orgs/{orgid}/resources/defs/{defid}/resources
GET
Listresourcedefinitionversions — Get Versions of a Resource Definition.
/v1/orgs/{orgid}/resources/defs/{defid}/versions
GET
Getresourcedefinitionversion — Get a Resource Definition Version.
/v1/orgs/{orgid}/resources/defs/{defid}/versions/{defversionid}
POST
Archiveresourcedefinitionversion — Mark/unmark the Resource Definition Version as archived.
/v1/orgs/{orgid}/resources/defs/{defid}/versions/{defversionid}/actions/archive
POST
Promoteresourcedefinitionversion — Promote the Resource Definition Version as active.
/v1/orgs/{orgid}/resources/defs/{defid}/versions/{defversionid}/actions/promote
GET
Listresourcedrivers — List Resource Drivers.
/v1/orgs/{orgid}/resources/drivers
POST
Createresourcedriver — Register a new Resource Driver.
/v1/orgs/{orgid}/resources/drivers
GET
Getresourcedriver — Get a Resource Driver.
/v1/orgs/{orgid}/resources/drivers/{driverid}
PUT
Updateresourcedriver — Update a Resource Driver.
/v1/orgs/{orgid}/resources/drivers/{driverid}
DELETE
Deleteresourcedriver — Delete a Resources Driver.
/v1/orgs/{orgid}/resources/drivers/{driverid}
GET
Listresourcetypes — List Resource Types.
/v1/orgs/{orgid}/resources/types
POST
Createresourcetype — Creates a new Resources Type.
/v1/orgs/{orgid}/resources/types
DELETE
Deleteresourcetype — Delete a Resource Type.
/v1/orgs/{orgid}/resources/types/{typeid}
PATCH
Patchresourcetype — Update a Resource Type.
/v1/orgs/{orgid}/resources/types/{typeid}
PUT
Updateresourcetype — Update a Resource Type.
/v1/orgs/{orgid}/resources/types/{typeid}
POST
Createresourceclass — Creates a new resources class.
/v1/orgs/{orgid}/resources/types/{typeid}/classes
GET
Getresourceclass — Get resource class by ID.
/v1/orgs/{orgid}/resources/types/{typeid}/classes/{classid}
PATCH
Updateresourceclass — Update a resource class description.
/v1/orgs/{orgid}/resources/types/{typeid}/classes/{classid}
DELETE
Deleteresourceclass — Delete a resource class.
/v1/orgs/{orgid}/resources/types/{typeid}/classes/{classid}
POST
Checkclusterconnectivity — Provision and check the cluster connectivity in an environment
/v1/orgs/{orgid}/runtime/actions/check-connectivity
GET
Get — Get list of Secret Stores for the given organization.
/v1/orgs/{orgid}/secretstores
POST
Post — Create a Secret Store for the given organization.
/v1/orgs/{orgid}/secretstores
GET
Get — Get the Secret Store.
/v1/orgs/{orgid}/secretstores/{storeid}
DELETE
Delete — Delete the Secret Store.
/v1/orgs/{orgid}/secretstores/{storeid}
PATCH
Patch — Update the Secret Store.
/v1/orgs/{orgid}/secretstores/{storeid}
GET
Listuserrolesinorg — List Users and Groups with roles in an Organization
/v1/orgs/{orgid}/users
POST
Createserviceuserinorg — Creates a new service user.
/v1/orgs/{orgid}/users
GET
Getuserroleinorg — Get the role of a User or a Group on an Organization
/v1/orgs/{orgid}/users/{userid}
DELETE
Deleteuserroleinorg — Remove the role of a User or a Group on an Organization
/v1/orgs/{orgid}/users/{userid}
PATCH
Updateuserroleinorg — Update the role of a User or a Group on an Organization
/v1/orgs/{orgid}/users/{userid}
GET
Listusergroupsinorg — Get the groups in an organization a user belongs to.
/v1/orgs/{orgid}/users/{userid}/groups
GET
Getsubjectpermsinorg — Get the permissions of a User or Group on the objects in an Organization
/v1/orgs/{orgid}/users/{userid}/perms
POST
Createworkloadprofilechartversion — Add new Workload Profile Chart Version
/v1/orgs/{orgid}/workload-profile-chart-versions
GET
Listworkloadprofilechartversions — Workload Profile Chart Versions for the given organization.
/v1/orgs/{orgid}/workload-profile-chart-versions
GET
Listworkloadprofilefeatures — List workload profile features available to the organization.
/v1/orgs/{orgid}/workload-profile-features
GET
Listworkloadprofiles — List workload profiles available to the organization.
/v1/orgs/{orgid}/workload-profiles
POST
Createworkloadprofile — Create new Workload Profile
/v1/orgs/{orgid}/workload-profiles
GET
Getworkloadprofile — Get a Workload Profile
/v1/orgs/{orgid}/workload-profiles/{profileqid}
PUT
Updateworkloadprofile — Update a Workload Profile
/v1/orgs/{orgid}/workload-profiles/{profileqid}
DELETE
Deleteworkloadprofile — Delete a Workload Profile
/v1/orgs/{orgid}/workload-profiles/{profileqid}
GET
Listworkloadprofileversions — List versions of the given workload profile.
/v1/orgs/{orgid}/workload-profiles/{profileqid}/versions
GET
Getlatestworkloadprofileversion — Latest version of the given workload profile with optional constraint.
/v1/orgs/{orgid}/workload-profiles/{profileqid}/versions/latest
GET
Listusertokens — Lists tokens associated with a user
/v1/users/{userid}/tokens
POST
Createusertoken — Creates a new static token for a user.
/v1/users/{userid}/tokens
GET
Getusertoken — Gets a specific token associated with a user
/v1/users/{userid}/tokens/{tokenid}
DELETE
Deleteusertoken — Deletes a specific token associated with a user
/v1/users/{userid}/tokens/{tokenid}

MCP Tools

gets-extended-profile-current-user

Gets the extended profile of the current user

read-only idempotent
updates-extended-profile-current-user

Updates the extended profile of the current user.

idempotent
list-active-organizations-user-has

List active organizations the user has access to.

read-only idempotent
get-specified-organization

Get the specified Organization.

read-only idempotent
register-new-agent-under-organization

Register a new Agent under an Organization.

list-all-agents-organization

List all the agents in an Organization.

read-only idempotent
delete-agent-and-its-keys

Delete an Agent (and its keys) stored under an Organization.

idempotent
update-description-agent

Update the description of an Agent.

idempotent
list-all-keys-registered-under

List all the keys registered under an Agent in an Organization.

read-only idempotent
register-new-key-under-agent

Register a new Key under an Agent in an Organization.

delete-key-registered-under-agent

Delete a key registered under a Agent.

idempotent
list-all-applications-organization

List all Applications in an Organization.

read-only idempotent
add-new-application-organization

Add a new Application to an Organization

get-existing-application

Get an existing Application

read-only idempotent
update-metadata-existing-application

Update metadata of an existing Application

idempotent
delete-application

Delete an Application

idempotent
list-approval-requests

List of the approval requests

read-only idempotent
list-deltas-application

List Deltas in an Application

read-only idempotent
create-new-delta

Create a new Delta

fetch-existing-delta

Fetch an existing Delta

read-only idempotent
update-existing-delta

Update an existing Delta

idempotent
update-existing-delta-2

Update an existing Delta

idempotent
mark-delta-archived

Mark a Delta as "archived"

idempotent
change-environment-delta

Change the Environment of a Delta

idempotent
change-name-delta

Change the name of a Delta

idempotent
list-all-environments

List all Environments.

read-only idempotent
add-new-environment-application

Add a new Environment to an Application.

get-specific-environment

Get a specific Environment.

read-only idempotent
update-specific-environment

Update a specific Environment.

idempotent
delete-specific-environment

Delete a specific Environment.

idempotent
list-deployments-environment

List Deployments in an Environment.

read-only idempotent
start-new-deployment

Start a new Deployment.

get-specific-deployment

Get a specific Deployment.

read-only idempotent
list-errors-that-occurred-deployment

List errors that occurred in a Deployment.

read-only idempotent
rebase-different-deployment

Rebase to a different Deployment.

idempotent
get-container-log-entries-environment

Get container log entries for the environment

read-only idempotent
list-active-resources-provisioned-environment

List Active Resources provisioned in an environment.

read-only idempotent
lists-resource-objects-that-hold

Lists the resource objects that hold the information needed to provision the resources specified in the request and the resources they depend on.

create-dependency-graph-which-is

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.

retrieve-dependency-graph-its-id

Retrieve a Dependency Graph by its ID.

read-only idempotent
delete-active-resource

Delete Active Resource.

idempotent
pin-active-resource-target-resource

Pin Active Resource to a target Resource Definition Version.

read-only
list-all-automation-rules-environment

List all Automation Rules in an Environment.

read-only idempotent
create-new-automation-rule-environment

Create a new Automation Rule for an Environment.

get-specific-automation-rule-environment

Get a specific Automation Rule for an Environment.

read-only idempotent
update-existing-automation-rule-environment

Update an existing Automation Rule for an Environment.

idempotent
delete-automation-rule-environment

Delete Automation Rule from an Environment.

idempotent
get-runtime-information-about-environment

Get Runtime information about the environment.

read-only idempotent
pause-resume-environment

Pause / Resume an environment.

idempotent
set-number-replicas-environment-s-modules

Set number of replicas for an environment's modules.

idempotent
list-value-set-versions-environment

List Value Set Versions in an Environment of an App

read-only idempotent
get-single-value-set-version

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.

read-only idempotent
purge-value-specific-shared-value

Purge the value of a specific Shared Value from the App Environment Version history.

restore-value-set-version-environment

Restore a Value Set Version in an Environment of an App

restore-specific-key-value-set

Restore a specific key from the Value Set Version in an Environment of an App

list-shared-values-environment

List Shared Values in an Environment

read-only idempotent
create-shared-value-environment

Create a Shared Value for an Environment

delete-all-shared-value-environment

Delete all Shared Value for an Environment

idempotent
update-shared-value-environment

Update Shared Value for an Environment

idempotent
delete-shared-value-environment

Delete Shared Value for an Environment

idempotent
update-shared-value-environment-2

Update Shared Value for an Environment

idempotent
deletes-all-jobs-application

Deletes all Jobs for the Application

idempotent
list-trigger-matching-criteria-defined

List the trigger matching criteria defined for Pipelines in this Application.

read-only idempotent
create-pipeline-run-appropriate-pipeline

Create a Pipeline Run in the appropriate Pipeline based on the trigger and inputs.

list-pipelines-within-application

List Pipelines within an Application.

read-only idempotent
create-pipeline-within-application

Create a Pipeline within an Application.

get-pipeline-within-application

Get a Pipeline within an Application.

read-only idempotent
update-pipeline-within-application

update a Pipeline within an Application.

idempotent
delete-pipeline-within-application

Delete a pipeline within an application.

idempotent
read-current-state-trigger-batch

Read the current state of a trigger batch

read-only idempotent
create-new-trigger-matching-criteria

Create a new trigger matching criteria for this Pipeline.

get-pipeline-criteria-given-id

Get the Pipeline Criteria with the given id.

read-only idempotent
delete-pipeline-criteria-given-id

Delete the Pipeline Criteria with the given id.

idempotent
list-runs-within-pipeline-ordered

List runs within a pipeline ordered newest to oldest.

read-only idempotent
create-run-within-pipeline

Create a run within a pipeline.

get-run-within-pipeline

Get a run within an pipeline.

read-only idempotent
deleting-completed-run-within-pipeline

Deleting a completed Run within a Pipeline.

idempotent
cancel-run-within-pipeline

Cancel a Run within an Pipeline.

list-details-jobs-within-pipeline

List the details of the jobs within a pipeline run.

read-only idempotent
list-details-job-including-step

List the details of a Job including Step information

read-only idempotent
get-approval-request

Get an approval request

read-only idempotent
approve-approval-request

Approve the approval request

deny-approval-request

Deny the approval request

get-page-log-output-given

Get a page of log output for a given step within a job.

read-only idempotent
restart-run-within-pipeline-cloning

Restart a Run within an Pipeline by cloning it with the same trigger and inputs.

get-pipeline-schema

Get a pipeline schema.

read-only idempotent
list-all-versions-pipeline

List all versions of the pipeline

read-only idempotent
get-runtime-information-about-specific

Get Runtime information about specific multiple environments.

read-only idempotent
get-all-deployment-sets

Get all Deployment Sets

read-only idempotent
get-deployment-set

Get a Deployment Set

read-only idempotent
apply-deployment-delta-deployment-set

Apply a Deployment Delta to a Deployment Set

get-difference-between-2-deployment

Get the difference between 2 Deployment Sets

read-only idempotent
get-resource-inputs-given-deployment

Get Resource Inputs for the given Deployment Set

read-only idempotent
list-users-groups-roles-app

List Users or Groups with roles in an App

read-only idempotent
adds-user-group-application-role

Adds a User or a Group to an Application with a Role

get-role-user-group-application

Get the role of a User or a Group on an Application

read-only idempotent
remove-role-user-group-application

Remove the role of a User or a Group on an Application

idempotent
update-role-user-group-application

Update the role of a User or a Group on an Application

idempotent
list-value-set-versions-app

List Value Set Versions in the App

read-only idempotent
get-single-value-set-version-2

Get a single Value Set Version from the App

read-only idempotent
purge-value-specific-shared-value-2

Purge the value of a specific Shared Value from the App Version history.

restore-value-set-version-app

Restore a Value Set Version in an App

restore-specific-key-value-set-2

Restore a specific key from the Value Set Version in an App

list-shared-values-application

List Shared Values in an Application

read-only idempotent
create-shared-value-application

Create a Shared Value for an Application

delete-all-shared-value-app

Delete all Shared Value for an App

idempotent
update-shared-value-application

Update Shared Value for an Application

idempotent
delete-shared-value-application

Delete Shared Value for an Application

idempotent
update-shared-value-application-2

Update Shared Value for an Application

idempotent
list-webhooks

List Webhooks

read-only idempotent
create-new-webhook

Create a new Webhook

get-webhook

Get a Webhook

read-only idempotent
delete-webhook

Delete a Webhook

idempotent
update-webhook

Update a Webhook

idempotent
list-all-artefacts-versions-org

List all Artefacts Versions in the org.

read-only idempotent
register-new-artefact-version-your

Register a new Artefact Version with your organization.

convert-score-specification-optional-overrides

Convert a Score specification, optional overrides, and extensions into the contents for a deployment set.

get-artefacts-versions

Get an Artefacts Versions.

read-only idempotent
get-humanitec-module-definition-this

Get the Humanitec module definition of this Workload Artefact Version as a deployment set

read-only idempotent
get-spec-this-workload-artefact

Get the spec of this Workload Artefact Version

read-only idempotent
list-all-artefacts

List all Artefacts.

read-only idempotent
delete-artefact-and-all-related

Delete Artefact and all related Artefact Versions

idempotent
list-all-artefact-versions-artefact

List all Artefact Versions of an Artefact.

read-only idempotent
update-version-artefact

Update Version of an Artefact.

idempotent
list-audit-log-entries-organization

List audit log entries by Organization

read-only idempotent
list-all-environment-types

List all Environment Types

read-only idempotent
add-new-environment-type

Add a new Environment Type

get-environment-type

Get an Environment Type

read-only idempotent
deletes-environment-type

Deletes an Environment Type

idempotent
updates-environment-type

Updates Environment Type

idempotent
list-users-and-groups-roles

List Users and Groups with roles in an Environment Type

read-only idempotent
adds-user-group-environment-type

Adds a User or a Group to an Environment Type with a Role

get-role-user-group-environment

Get the role of a User or a Group on an Environment Type

read-only idempotent
remove-role-user-group-environment

Remove the role of a User or a Group on an Environment Type

idempotent
update-role-user-group-environment

Update the role of a User or a Group on an Environment Type

idempotent
list-events

List Events

read-only idempotent
create-group-organization

Create a group in an organization

list-users-group

List users in a group.

read-only idempotent
list-all-public-keys-humanitec

List all the public keys Humanitec shares with an organization.

read-only idempotent
list-all-container-images

List all Container Images

read-only idempotent
get-specific-image-object

Get a specific Image Object

read-only idempotent
lists-all-builds-image

Lists all the Builds of an Image

read-only idempotent
add-new-image-build

Add a new Image Build

list-invites-issued-organization

List the invites issued for the organization.

read-only idempotent
invites-user-organization-specified-role

Invites a user to an Organization with a specified role.

associate-new-rsa-public-key

Associate a new RSA public key to an organization.

list-all-public-keys-associated

List all public keys associated to an organization.

read-only idempotent
delete-public-key-associated-organization

Delete a public key associated to an organization.

idempotent
retrieve-single-public-key-associated

Retrieve a single public key associated to an organization.

read-only idempotent
list-all-pipeline-runs-within

List all pipeline runs within the Org ordered newest to oldest. This can be filtered by app, pipeline, and status.

read-only idempotent
gets-latest-pipeline-schema

Gets the latest pipeline schema

read-only idempotent
list-all-pipelines-within-organization

List all Pipelines within an Organization. This can be filtered by Application.

read-only idempotent
lists-available-registries-organization

Lists available registries for the organization.

read-only idempotent
creates-new-registry-record

Creates a new registry record.

loads-registry-record-details

Loads a registry record details.

read-only idempotent
deletes-existing-registry-record-and

Deletes an existing registry record and all associated credentials and secrets.

idempotent
updates-patches-existing-registry-record

Updates (patches) an existing registry record.

idempotent
returns-current-account-credentials-secret

Returns current account credentials or secret details for the registry.

read-only idempotent
list-resource-account-types-available

List Resource Account Types available to the organization.

read-only idempotent
list-resource-accounts-organization

List Resource Accounts in the organization.

read-only idempotent
create-new-resource-account-organization

Create a new Resource Account in the organization.

get-resource-account

Get a Resource Account.

read-only idempotent
delete-unused-resource-account

Delete an unused Resource Account.

idempotent
update-resource-account

Update a Resource Account.

idempotent
check-credentials-existing-resource-account

Check the credentials of an existing Resource Account

read-only
list-resource-classes

List resource classes.

read-only idempotent
list-resource-definitions

List Resource Definitions.

read-only idempotent
create-new-resource-definition

Create a new Resource Definition.

get-resource-definition

Get a Resource Definition.

read-only idempotent
update-resource-definition

Update a Resource Definition.

idempotent
delete-resource-definition

Delete a Resource Definition.

idempotent
update-resource-definition-2

Update a Resource Definition.

idempotent
update-all-matching-criteria-resource

Update all Matching Criteria of a Resource Definition.

idempotent
add-new-matching-criteria-resource

Add a new Matching Criteria to a Resource Definition.

delete-matching-criteria-resource-definition

Delete a Matching Criteria from a Resource Definition.

idempotent
list-active-resources-provisioned-specific

List Active Resources provisioned via a specific Resource Definition.

read-only idempotent
get-versions-resource-definition

Get Versions of a Resource Definition.

read-only idempotent
get-resource-definition-version

Get a Resource Definition Version.

read-only idempotent
mark-unmark-resource-definition-version

Mark/unmark the Resource Definition Version as archived.

promote-resource-definition-version-active

Promote the Resource Definition Version as active.

list-resource-drivers

List Resource Drivers.

read-only idempotent
register-new-resource-driver

Register a new Resource Driver.

get-resource-driver

Get a Resource Driver.

read-only idempotent
update-resource-driver

Update a Resource Driver.

idempotent
delete-resources-driver

Delete a Resources Driver.

idempotent
list-resource-types

List Resource Types.

read-only idempotent
creates-new-resources-type

Creates a new Resources Type.

delete-resource-type

Delete a Resource Type.

idempotent
update-resource-type

Update a Resource Type.

idempotent
update-resource-type-2

Update a Resource Type.

idempotent
creates-new-resources-class

Creates a new resources class.

get-resource-class-id

Get resource class by ID.

read-only idempotent
update-resource-class-description

Update a resource class description.

idempotent
delete-resource-class

Delete a resource class.

idempotent
provision-and-check-cluster-connectivity

Provision and check the cluster connectivity in an environment

read-only
get-list-secret-stores-given

Get list of Secret Stores for the given organization.

read-only idempotent
create-secret-store-given-organization

Create a Secret Store for the given organization.

get-secret-store

Get the Secret Store.

read-only idempotent
delete-secret-store

Delete the Secret Store.

idempotent
update-secret-store

Update the Secret Store.

idempotent
list-users-and-groups-roles-2

List Users and Groups with roles in an Organization

read-only idempotent
creates-new-service-user

Creates a new service user.

get-role-user-group-organization

Get the role of a User or a Group on an Organization

read-only idempotent
remove-role-user-group-organization

Remove the role of a User or a Group on an Organization

idempotent
update-role-user-group-organization

Update the role of a User or a Group on an Organization

idempotent
get-groups-organization-user-belongs

Get the groups in an organization a user belongs to.

read-only idempotent
get-permissions-user-group-objects

Get the permissions of a User or Group on the objects in an Organization

read-only idempotent
add-new-workload-profile-chart

Add new Workload Profile Chart Version

workload-profile-chart-versions-given

Workload Profile Chart Versions for the given organization.

read-only idempotent
list-workload-profile-features-available

List workload profile features available to the organization.

read-only idempotent
list-workload-profiles-available-organization

List workload profiles available to the organization.

read-only idempotent
create-new-workload-profile

Create new Workload Profile

get-workload-profile

Get a Workload Profile

read-only idempotent
update-workload-profile

Update a Workload Profile

idempotent
delete-workload-profile

Delete a Workload Profile

idempotent
list-versions-given-workload-profile

List versions of the given workload profile.

read-only idempotent
latest-version-given-workload-profile

Latest version of the given workload profile with optional constraint.

read-only idempotent
lists-tokens-associated-user

Lists tokens associated with a user

read-only idempotent
creates-new-static-token-user

Creates a new static token for a user.

gets-specific-token-associated-user

Gets a specific token associated with a user

read-only idempotent
deletes-specific-token-associated-user

Deletes a specific token associated with a user

idempotent

Capability Spec

humanitec-public.yaml Raw ↑ 
naftiko: 1.0.0-alpha2
info:
  label: Humanitec API — public
  description: 'Humanitec API — public. 221 operations. Lead operation: Gets the extended profile of the current user. Self-contained
    Naftiko capability covering one Humanitec business surface.'
  tags:
  - Humanitec
  - public
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HUMANITEC_API_KEY: HUMANITEC_API_KEY
capability:
  consumes:
  - type: http
    namespace: humanitec-public
    baseUri: https://api.humanitec.io
    description: Humanitec API — public business capability. Self-contained, no shared references.
    resources:
    - name: current-user
      path: /current-user
      operations:
      - name: getcurrentuser
        method: GET
        description: Gets the extended profile of the current user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatecurrentuser
        method: PATCH
        description: Updates the extended profile of the current user.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orgs
      path: /orgs
      operations:
      - name: listorganizations
        method: GET
        description: List active organizations the user has access to.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: orgs-orgId
      path: /orgs/{orgId}
      operations:
      - name: getorganization
        method: GET
        description: Get the specified Organization.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: orgs-orgId-agents
      path: /orgs/{orgId}/agents
      operations:
      - name: createagent
        method: POST
        description: Register a new Agent under an Organization.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: listagents
        method: GET
        description: List all the agents in an Organization.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: orgs-orgId-agents-agentId
      path: /orgs/{orgId}/agents/{agentId}
      operations:
      - name: deleteagent
        method: DELETE
        description: Delete an Agent (and its keys) stored under an Organization.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patchagent
        method: PATCH
        description: Update the description of an Agent.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orgs-orgId-agents-agentId-keys
      path: /orgs/{orgId}/agents/{agentId}/keys
      operations:
      - name: listkeysinagent
        method: GET
        description: List all the keys registered under an Agent in an Organization.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createkey
        method: POST
        description: Register a new Key under an Agent in an Organization.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orgs-orgId-agents-agentId-keys-fingerprint
      path: /orgs/{orgId}/agents/{agentId}/keys/{fingerprint}
      operations:
      - name: deletekeyinagent
        method: DELETE
        description: Delete a key registered under a Agent.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: orgs-orgId-apps
      path: /orgs/{orgId}/apps
      operations:
      - name: listapplications
        method: GET
        description: List all Applications in an Organization.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
      - name: createapplication
        method: POST
        description: Add a new Application to an Organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orgs-orgId-apps-appId
      path: /orgs/{orgId}/apps/{appId}
      operations:
      - name: getapplication
        method: GET
        description: Get an existing Application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
        - name: appId
          in: path
          type: string
          description: The Application ID.
          required: true
      - name: patchapplication
        method: PATCH
        description: Update metadata of an existing Application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteapplication
        method: DELETE
        description: Delete an Application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
        - name: appId
          in: path
          type: string
          description: The Application ID.
          required: true
    - name: orgs-orgId-apps-appId-approvals
      path: /orgs/{orgId}/apps/{appId}/approvals
      operations:
      - name: listpipelineapprovalrequests
        method: GET
        description: List of the approval requests
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: orgs-orgId-apps-appId-deltas
      path: /orgs/{orgId}/apps/{appId}/deltas
      operations:
      - name: listdeltas
        method: GET
        description: List Deltas in an Application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: archived
          in: query
          type: boolean
          description: If true, return archived Deltas.
        - name: env
          in: query
          type: string
          description: Only return Deltas associated with the specified Environment.
      - name: createdelta
        method: POST
        description: Create a new Delta
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orgs-orgId-apps-appId-deltas-deltaId
      path: /orgs/{orgId}/apps/{appId}/deltas/{deltaId}
      operations:
      - name: getdelta
        method: GET
        description: Fetch an existing Delta
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deltaId
          in: path
          type: string
          description: ID of the Delta to fetch.
          required: true
      - name: patchdelta
        method: PATCH
        description: Update an existing Delta
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deltaId
          in: path
          type: string
          description: ID of the Delta to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: putdelta
        method: PUT
        description: Update an existing Delta
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deltaId
          in: path
          type: string
          description: ID of the Delta to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orgs-orgId-apps-appId-deltas-deltaId-metadata-archived
      path: /orgs/{orgId}/apps/{appId}/deltas/{deltaId}/metadata/archived
      operations:
      - name: archivedelta
        method: PUT
        description: Mark a Delta as "archived"
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deltaId
          in: path
          type: string
          description: ID of the Deployment Delta.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orgs-orgId-apps-appId-deltas-deltaId-metadata-env_id
      path: /orgs/{orgId}/apps/{appId}/deltas/{deltaId}/metadata/env_id
      operations:
      - name: changeenvofdelta
        method: PUT
        description: Change the Environment of a Delta
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deltaId
          in: path
          type: string
          description: ID of the Deployment Delta.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orgs-orgId-apps-appId-deltas-deltaId-metadata-name
      path: /orgs/{orgId}/apps/{appId}/deltas/{deltaId}/metadata/name
      operations:
      - name: changenameofdelta
        method: PUT
        description: Change the name of a Delta
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deltaId
          in: path
          type: string
          description: ID of the Deployment Delta.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orgs-orgId-apps-appId-envs
      path: /orgs/{orgId}/apps/{appId}/envs
      operations:
      - name: listenvironments
        method: GET
        description: List all Environments.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
        - name: appId
          in: path
          type: string
          description: The Application ID.
          required: true
      - name: createenvironment
        method: POST
        description: Add a new Environment to an Application.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
        - name: appId
          in: path
          type: string
          description: The Application ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orgs-orgId-apps-appId-envs-envId
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}
      operations:
      - name: getenvironment
        method: GET
        description: Get a specific Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
        - name: appId
          in: path
          type: string
          description: The Application ID.
          required: true
        - name: envId
          in: path
          type: string
          description: The Environment ID.
          required: true
      - name: updateenvironment
        method: PATCH
        description: Update a specific Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
        - name: appId
          in: path
          type: string
          description: The Application ID.
          required: true
        - name: envId
          in: path
          type: string
          description: The Environment ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deleteenvironment
        method: DELETE
        description: Delete a specific Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
        - name: appId
          in: path
          type: string
          description: The Application ID.
          required: true
        - name: envId
          in: path
          type: string
          description: The Environment ID.
          required: true
    - name: orgs-orgId-apps-appId-envs-envId-deploys
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/deploys
      operations:
      - name: listdeployments
        method: GET
        description: List Deployments in an Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
        - name: appId
          in: path
          type: string
          description: The Application ID.
          required: true
        - name: envId
          in: path
          type: string
          description: The Environment ID.
          required: true
        - name: pipelineRunId
          in: query
          type: string
          description: An optional filter by the Pipeline and Pipeline Run ID separated by a comma.
      - name: createdeployment
        method: POST
        description: Start a new Deployment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
        - name: appId
          in: path
          type: string
          description: The Application ID.
          required: true
        - name: envId
          in: path
          type: string
          description: The Environment ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orgs-orgId-apps-appId-envs-envId-deploys-deployId
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/deploys/{deployId}
      operations:
      - name: getdeployment
        method: GET
        description: Get a specific Deployment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
        - name: appId
          in: path
          type: string
          description: The Application ID.
          required: true
        - name: envId
          in: path
          type: string
          description: The Environment ID.
          required: true
        - name: deployId
          in: path
          type: string
          description: The Deployment ID.
          required: true
    - name: orgs-orgId-apps-appId-envs-envId-deploys-deployId-errors
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/deploys/{deployId}/errors
      operations:
      - name: listdeploymenterrors
        method: GET
        description: List errors that occurred in a Deployment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
        - name: appId
          in: path
          type: string
          description: The Application ID.
          required: true
        - name: envId
          in: path
          type: string
          description: The Environment ID.
          required: true
        - name: deployId
          in: path
          type: string
          description: The Deployment ID.
          required: true
    - name: orgs-orgId-apps-appId-envs-envId-from_deploy_id
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/from_deploy_id
      operations:
      - name: rebaseenvironment
        method: PUT
        description: Rebase to a different Deployment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
        - name: appId
          in: path
          type: string
          description: The Application ID.
          required: true
        - name: envId
          in: path
          type: string
          description: The Environment ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orgs-orgId-apps-appId-envs-envId-logs
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/logs
      operations:
      - name: get
        method: GET
        description: Get container log entries for the environment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID
          required: true
        - name: appId
          in: path
          type: string
          description: The Application ID
          required: true
        - name: envId
          in: path
          type: string
          description: The Environment ID
          required: true
        - name: workload_id
          in: query
          type: string
          description: filter by workload ID
        - name: container_id
          in: query
          type: string
          description: filter by container ID
        - name: deployment_id
          in: query
          type: string
          description: filter by deployment ID
        - name: timestamp_from
          in: query
          type: string
          description: filter by min time, RFC 3339 format, e.g. "2021-10-02T15:01:23.045Z"
        - name: timestamp_to
          in: query
          type: string
          description: filter by max time, RFC 3330 format, e.g. "2021-10-02T15:01:23.045Z"
        - name: limit
          in: query
          type: string
          description: limit log entries returned
        - name: asc
          in: query
          type: boolean
          description: if true request results in ascending order, default order is descending
        - name: invert
          in: query
          type: boolean
          description: if true reverse the order of the log entries in the output
    - name: orgs-orgId-apps-appId-envs-envId-resources
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/resources
      operations:
      - name: listactiveresources
        method: GET
        description: List Active Resources provisioned in an environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
        - name: appId
          in: path
          type: string
          description: The Application ID.
          required: true
        - name: envId
          in: path
          type: string
          description: The Environment ID.
          required: true
        - name: scheduled_deletion
          in: query
          type: boolean
          description: If set to `true` or `false`, filters resources scheduled or not scheduled for deletion correspondingly.
    - name: orgs-orgId-apps-appId-envs-envId-resources-graph
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/resources/graph
      operations:
      - name: queryresourcegraph
        method: POST
        description: Lists the resource objects that hold the information needed to provision the resources specified in the
          request and the resources they depend on.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
        - name: appId
          in: path
          type: string
          description: The Application ID.
          required: true
        - name: envId
          in: path
          type: string
          description: The Environment ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orgs-orgId-apps-appId-envs-envId-resources-graphs
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/resources/graphs
      operations:
      - name: createdependencygraph
        method: POST
        description: 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.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orgs-orgId-apps-appId-envs-envId-resources-graphs-graphId
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/resources/graphs/{graphId}
      operations:
      - name: getdependencygraph
        method: GET
        description: Retrieve a Dependency Graph by its ID.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: orgs-orgId-apps-appId-envs-envId-resources-type-resId
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/resources/{type}/{resId}
      operations:
      - name: deleteactiveresource
        method: DELETE
        description: Delete Active Resource.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
        - name: appId
          in: path
          type: string
          description: The Application ID.
          required: true
        - name: envId
          in: path
          type: string
          description: The Environment ID.
          required: true
        - name: type
          in: path
          type: string
          description: 'The Resource Type, may include a resource class: {type}.{class}.'
          required: true
        - name: resId
          in: path
          type: string
          description: The Resource ID.
          required: true
        - name: detach
          in: query
          type: boolean
          description: If set to `true`, will detach an active resource. The resource continues to exist and is not deleted,
            but it is no longer connected to the Platform Orchestrator
    - name: orgs-orgId-apps-appId-envs-envId-resources-type-resId-actions-pin
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/resources/{type}/{resId}/actions/pin
      operations:
      - name: pinactiveresource
        method: POST
        description: Pin Active Resource to a target Resource Definition Version.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orgs-orgId-apps-appId-envs-envId-rules
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/rules
      operations:
      - name: listautomationrules
        method: GET
        description: List all Automation Rules in an Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createautomationrule
        method: POST
        description: Create a new Automation Rule for an Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orgs-orgId-apps-appId-envs-envId-rules-ruleId
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId}
      operations:
      - name: getautomationrule
        method: GET
        description: Get a specific Automation Rule for an Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ruleId
          in: path
          type: string
          description: The Automation Rule ID.
          required: true
      - name: updateautomationrule
        method: PUT
        description: Update an existing Automation Rule for an Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ruleId
          in: path
          type: string
          description: The Automation Rule ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteautomationrule
        method: DELETE
        description: Delete Automation Rule from an Environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ruleId
          in: path
          type: string
          description: The Automation Rule ID.
          required: true
    - name: orgs-orgId-apps-appId-envs-envId-runtime
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/runtime
      operations:
      - name: getruntime
        method: GET
        description: Get Runtime information about the environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: orgs-orgId-apps-appId-envs-envId-runtime-paused
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/runtime/paused
      operations:
      - name: updatepaused
        method: PUT
        description: Pause / Resume an environment.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orgs-orgId-apps-appId-envs-envId-runtime-replicas
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/runtime/replicas
      operations:
      - name: patchreplicas
        method: PATCH
        description: Set number of replicas for an environment's modules.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orgs-orgId-apps-appId-envs-envId-value-set-versions
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions
      operations:
      - name: get
        method: GET
        description: List Value Set Versions in an Environment of an App
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
        - name: appId
          in: path
          type: string
          description: The Application ID.
          required: true
        - name: envId
          in: path
          type: string
          description: The Environment ID.
          required: true
        - name: key_changed
          in: query
          type: string
          description: (Optional) Return only value set version where the specified key changed
    - name: orgs-orgId-apps-appId-envs-envId-value-set-versions-valueSetVersionId
      path: /orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions/{valueSetVersionId}
      operations:
      - name: get
        method: GET
        description: 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.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orgId
          in: path
          type: string
          description: The Organization ID.
          required: true
        - name: appId
          in: path
          type: string
          description: The Application ID.
          required: true
        - name: envId
          in: path
          type: string
          description: The Environment ID.
          required: true
        - name: valueSetVersionId
          in: path
          type: string
          description: The ValueSetVersion ID.
          required: true
    - name: orgs-orgId-apps-a

# --- truncated at 32 KB (304 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/humanitec/refs/heads/main/capabilities/humanitec-public.yaml