naftiko: 1.0.0-alpha2 info: label: Humanitec API description: '# Introduction The *Humanitec API* allows you to automate and integrate Humanitec into your developer and operational workflows. The API is a REST based API. It is based around a set of concepts: * Core * External Resources * Sets and Deltas ## Authentication Almost all requests made to the Humanitec API require Authentication. See our [Developer Docs on API Authentication](https://developer.humanitec.com/platform-orchestrator/reference/api-references/#authentication) for instructions. ## Content Types The Humanitec API, unless explicitly specified, only accepts content types of `application/j' tags: - Humanitec - API created: '2026-05-06' modified: '2026-05-06' capability: consumes: - type: http namespace: humanitec baseUri: https://api.humanitec.io description: Humanitec API HTTP API. resources: - 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: $. - 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: $. - 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: $. - 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. inputParameters: - name: orgId in: path type: string required: true description: The Organization ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createapplication method: POST description: Add a new Application to an Organization inputParameters: - name: orgId in: path type: string required: true description: The Organization ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-apps-appid path: /orgs/{orgId}/apps/{appId} operations: - name: getapplication method: GET description: Get an existing Application inputParameters: - name: orgId in: path type: string required: true description: The Organization ID. - name: appId in: path type: string required: true description: The Application ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: patchapplication method: PATCH description: Update metadata of an existing Application outputRawFormat: json outputParameters: - name: result type: object value: $. - name: deleteapplication method: DELETE description: Delete an Application inputParameters: - name: orgId in: path type: string required: true description: The Organization ID. - name: appId in: path type: string required: true description: The Application ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-apps-appid-envs path: /orgs/{orgId}/apps/{appId}/envs operations: - name: listenvironments method: GET description: List all Environments. inputParameters: - name: orgId in: path type: string required: true description: The Organization ID. - name: appId in: path type: string required: true description: The Application ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createenvironment method: POST description: Add a new Environment to an Application. inputParameters: - name: orgId in: path type: string required: true description: The Organization ID. - name: appId in: path type: string required: true description: The Application ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-apps-appid-envs-envid path: /orgs/{orgId}/apps/{appId}/envs/{envId} operations: - name: getenvironment method: GET description: Get a specific Environment. inputParameters: - name: orgId in: path type: string required: true description: The Organization ID. - name: appId in: path type: string required: true description: The Application ID. - name: envId in: path type: string required: true description: The Environment ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updateenvironment method: PATCH description: Update a specific Environment. inputParameters: - name: orgId in: path type: string required: true description: The Organization ID. - name: appId in: path type: string required: true description: The Application ID. - name: envId in: path type: string required: true description: The Environment ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: deleteenvironment method: DELETE description: Delete a specific Environment. inputParameters: - name: orgId in: path type: string required: true description: The Organization ID. - name: appId in: path type: string required: true description: The Application ID. - name: envId in: path type: string required: true description: The Environment ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - 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. inputParameters: - name: orgId in: path type: string required: true description: The Organization ID. - name: appId in: path type: string required: true description: The Application ID. - name: envId in: path type: string required: true description: The Environment ID. - name: pipelineRunId in: query type: string description: An optional filter by the Pipeline and Pipeline Run ID separated by a comma. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createdeployment method: POST description: Start a new Deployment. inputParameters: - name: orgId in: path type: string required: true description: The Organization ID. - name: appId in: path type: string required: true description: The Application ID. - name: envId in: path type: string required: true description: The Environment ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-apps-appid-envs-envid-deploys-deployi path: /orgs/{orgId}/apps/{appId}/envs/{envId}/deploys/{deployId} operations: - name: getdeployment method: GET description: Get a specific Deployment. inputParameters: - name: orgId in: path type: string required: true description: The Organization ID. - name: appId in: path type: string required: true description: The Application ID. - name: envId in: path type: string required: true description: The Environment ID. - name: deployId in: path type: string required: true description: The Deployment ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-apps-appid-envs-envid-deploys-deployi path: /orgs/{orgId}/apps/{appId}/envs/{envId}/deploys/{deployId}/errors operations: - name: listdeploymenterrors method: GET description: List errors that occurred in a Deployment. inputParameters: - name: orgId in: path type: string required: true description: The Organization ID. - name: appId in: path type: string required: true description: The Application ID. - name: envId in: path type: string required: true description: The Environment ID. - name: deployId in: path type: string required: true description: The Deployment ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - 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. inputParameters: - name: orgId in: path type: string required: true description: The Organization ID. - name: appId in: path type: string required: true description: The Application ID. - name: envId in: path type: string required: true description: The Environment ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-env-types path: /orgs/{orgId}/env-types operations: - name: listenvironmenttypes method: GET description: List all Environment Types inputParameters: - name: orgId in: path type: string required: true description: The Organization ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createenvironmenttype method: POST description: Add a new Environment Type inputParameters: - name: orgId in: path type: string required: true description: The Organization ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-env-types-envtypeid path: /orgs/{orgId}/env-types/{envTypeId} operations: - name: getenvironmenttype method: GET description: Get an Environment Type inputParameters: - name: orgId in: path type: string required: true description: The Organization ID. - name: envTypeId in: path type: string required: true description: ID of the Environment Type. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: deleteenvironmenttype method: DELETE description: Deletes an Environment Type inputParameters: - name: orgId in: path type: string required: true description: The Organization ID. - name: envTypeId in: path type: string required: true description: ID of the Environment Type. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updateenvironmenttype method: PATCH description: Updates Environment Type inputParameters: - name: orgId in: path type: string required: true description: The Organization ID. - name: envTypeId in: path type: string required: true description: ID of the Environment Type. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-artefact-versions path: /orgs/{orgId}/artefact-versions operations: - name: listartefactversionsinorg method: GET description: List all Artefacts Versions in the org. inputParameters: - name: orgId in: path type: string required: true description: The organization ID. - name: name in: query type: string description: (Optional) Filter Artefact Versions by name. - name: reference in: query type: string description: (Optional) Filter Artefact Versions by the reference to a Version of the same Artefact. This cannot be used together with `name`. - name: archived in: query type: boolean description: (Optional) Filter for non-archived Artefact Versions. If no filter is defined only non-archived Artefact Versions are returned, if the filter is true both archi - name: type in: query type: string description: (Optional) Filter by artefact type. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createartefactversion method: POST description: Register a new Artefact Version with your organization. inputParameters: - name: orgId in: path type: string required: true description: The organization ID. - name: vcs in: query type: string description: (Optional) Which version control system the version comes from. Default value is "git". If this parameter is not supplied or its value is "git", the provided re - name: dry_run in: query type: boolean description: Optionally validate the request but do not persist the actual artefact. If the Accept type is set to "application/x.workload-deployment-set+json" or "applicatio - name: Accept in: header type: string description: Indicates which content types the client is able to understand. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-artefact-versions-artefactversionid path: /orgs/{orgId}/artefact-versions/{artefactVersionId} operations: - name: getartefactversion method: GET description: Get an Artefacts Versions. inputParameters: - name: orgId in: path type: string required: true description: The organization ID. - name: artefactVersionId in: path type: string required: true description: The Artefact Version ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-artefact-versions-artefactversionid-w path: /orgs/{orgId}/artefact-versions/{artefactVersionId}/workload-spec operations: - name: getworkloadartefactversionspec method: GET description: Get the spec of this Workload Artefact Version inputParameters: - name: orgId in: path type: string required: true description: The organization ID. - name: artefactVersionId in: path type: string required: true description: The Artefact Version ID. - name: Accept in: header type: string description: The accepted content type. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-artefact-versions-artefactversionid-w path: /orgs/{orgId}/artefact-versions/{artefactVersionId}/workload-deployment-set operations: - name: getworkloadartefactversiondeploymentset method: GET description: Get the Humanitec module definition of this Workload Artefact Version as a deployment set inputParameters: - name: orgId in: path type: string required: true description: The organization ID. - name: artefactVersionId in: path type: string required: true description: The Artefact Version ID. - name: Accept in: header type: string description: The accepted content type. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-artefacts path: /orgs/{orgId}/artefacts operations: - name: listartefacts method: GET description: List all Artefacts. inputParameters: - name: orgId in: path type: string required: true description: The organization ID. - name: type in: query type: string description: (Optional) Filter Artefacts by type. - name: name in: query type: string description: (Optional) Filter Artefacts by name. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-artefacts-artefactid path: /orgs/{orgId}/artefacts/{artefactId} operations: - name: deleteartefact method: DELETE description: Delete Artefact and all related Artefact Versions inputParameters: - name: orgId in: path type: string required: true description: The organization ID. - name: artefactId in: path type: string required: true description: The Artefact ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-artefacts-artefactid-versions path: /orgs/{orgId}/artefacts/{artefactId}/versions operations: - name: listartefactversions method: GET description: List all Artefact Versions of an Artefact. inputParameters: - name: orgId in: path type: string required: true description: The organization ID. - name: artefactId in: path type: string required: true description: The Artefact ID. - name: archived in: query type: boolean description: (Optional) Filter for non-archived Artefact Versions. If no filter is defined only non-archived Artefact Versions are returned, if the filter is true both archi - name: reference in: query type: string description: (Optional) Filter Artefact Versions by by name including a version or digest. - name: limit in: query type: integer description: (Optional) Limit the number of versions returned by the endpoint. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-artefacts-artefactid-versions-version path: /orgs/{orgId}/artefacts/{artefactId}/versions/{versionId} operations: - name: patchartefactversion method: PATCH description: Update Version of an Artefact. inputParameters: - name: orgId in: path type: string required: true description: The organization ID. - name: artefactId in: path type: string required: true description: The Artefact ID. - name: versionId in: path type: string required: true description: The Version ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-images path: /orgs/{orgId}/images operations: - name: listdeprecatedimages method: GET description: List all Container Images inputParameters: - name: orgId in: path type: string required: true description: The organization ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-images-imageid path: /orgs/{orgId}/images/{imageId} operations: - name: getdeprecatedimage method: GET description: Get a specific Image Object inputParameters: - name: orgId in: path type: string required: true description: The organization ID. - name: imageId in: path type: string required: true description: The Image ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-images-imageid-builds path: /orgs/{orgId}/images/{imageId}/builds operations: - name: listdeprecatedimagebuilds method: GET description: Lists all the Builds of an Image inputParameters: - name: orgId in: path type: string required: true description: The organization ID. - name: imageId in: path type: string required: true description: The Image ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createdeprecatedimagebuild method: POST description: Add a new Image Build inputParameters: - name: orgId in: path type: string required: true description: The organization ID. - name: imageId in: path type: string required: true description: The Image ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-artefact-versions-convert-score path: /orgs/{orgId}/artefact-versions/convert-score operations: - name: convertscoretoset method: POST description: Convert a Score specification, optional overrides, and extensions into the contents for a deployment set. inputParameters: - name: orgId in: path type: string required: true description: The organization ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-audit-logs path: /orgs/{orgId}/audit-logs operations: - name: listauditlogentries method: GET description: List audit log entries by Organization inputParameters: - name: from in: query type: string description: Optional filter for entries created after the given time. - name: to in: query type: string description: Optional filter for entries created before the given time. outputRawFormat: json outputParameters: - name: result type: object value: $. - 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: $. - 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. inputParameters: - name: ruleId in: path type: string required: true description: The Automation Rule ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updateautomationrule method: PUT description: Update an existing Automation Rule for an Environment. inputParameters: - name: ruleId in: path type: string required: true description: The Automation Rule ID. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: deleteautomationrule method: DELETE description: Delete Automation Rule from an Environment. inputParameters: - name: ruleId in: path type: string required: true description: The Automation Rule ID. 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 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. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createdelta method: POST description: Create a new Delta outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-apps-appid-deltas-deltaid path: /orgs/{orgId}/apps/{appId}/deltas/{deltaId} operations: - name: getdelta method: GET description: Fetch an existing Delta inputParameters: - name: deltaId in: path type: string required: true description: ID of the Delta to fetch. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: patchdelta method: PATCH description: Update an existing Delta inputParameters: - name: deltaId in: path type: string required: true description: ID of the Delta to update. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: putdelta method: PUT description: Update an existing Delta inputParameters: - name: deltaId in: path type: string required: true description: ID of the Delta to update. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-apps-appid-deltas-deltaid-metadata-ar path: /orgs/{orgId}/apps/{appId}/deltas/{deltaId}/metadata/archived operations: - name: archivedelta method: PUT description: Mark a Delta as "archived" inputParameters: - name: deltaId in: path type: string required: true description: ID of the Deployment Delta. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-apps-appid-deltas-deltaid-metadata-en path: /orgs/{orgId}/apps/{appId}/deltas/{deltaId}/metadata/env_id operations: - name: changeenvofdelta method: PUT description: Change the Environment of a Delta inputParameters: - name: deltaId in: path type: string required: true description: ID of the Deployment Delta. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-apps-appid-deltas-deltaid-metadata-na path: /orgs/{orgId}/apps/{appId}/deltas/{deltaId}/metadata/name operations: - name: changenameofdelta method: PUT description: Change the name of a Delta inputParameters: - name: deltaId in: path type: string required: true description: ID of the Deployment Delta. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-apps-appid-sets path: /orgs/{orgId}/apps/{appId}/sets operations: - name: listsets method: GET description: Get all Deployment Sets outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-apps-appid-sets-setid path: /orgs/{orgId}/apps/{appId}/sets/{setId} operations: - name: getset method: GET description: Get a Deployment Set inputParameters: - name: setId in: path type: string required: true description: ID of the Deployment Set. - name: diff in: query type: string description: ID of the Deployment Set to compared against. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updateset method: POST description: Apply a Deployment Delta to a Deployment Set inputParameters: - name: setId in: path type: string required: true description: ID of the Deployment Set. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-apps-appid-sets-setid-resources path: /orgs/{orgId}/apps/{appId}/sets/{setId}/resources operations: - name: getsetresourceinputs method: GET description: Get Resource Inputs for the given Deployment Set inputParameters: - name: setId in: path type: string required: true description: ID of the Deployment Set. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgid-apps-appid-sets-setid-diff-sourceseti path: /orgs/{orgId}/apps/{appId}/sets/{setId}/diff/{sourceSetId} operations: - name: getdiff method: GET description: Get the difference between 2 Deployment Sets inputParameters: - name: setId in: path type: string required: true description: ID of the Deployment Set. - name: sourceSetId in: path type: string required: true description: ID of the Deployment Set to diff against. outputRawFormat: json outputParameters: - name: result type: object value: $. exposes: - type: rest port: 8080 namespace: humanitec-rest description: REST adapter for Humanitec API. resources: - path: /orgs/{orgId}/agents name: createagent operations: - method: POST name: createagent description: Register a new Agent under an Organization. call: humanitec.createagent outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/agents name: listagents operations: - method: GET name: listagents description: List all the agents in an Organization. call: humanitec.listagents outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/agents/{agentId} name: deleteagent operations: - method: DELETE name: deleteagent description: Delete an Agent (and its keys) stored under an Organization. call: humanitec.deleteagent outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/agents/{agentId} name: patchagent operations: - method: PATCH name: patchagent description: Update the description of an Agent. call: humanitec.patchagent outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/agents/{agentId}/keys name: listkeysinagent operations: - method: GET name: listkeysinagent description: List all the keys registered under an Agent in an Organization. call: humanitec.listkeysinagent outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/agents/{agentId}/keys name: createkey operations: - method: POST name: createkey description: Register a new Key under an Agent in an Organization. call: humanitec.createkey outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/agents/{agentId}/keys/{fingerprint} name: deletekeyinagent operations: - method: DELETE name: deletekeyinagent description: Delete a key registered under a Agent. call: humanitec.deletekeyinagent outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps name: listapplications operations: - method: GET name: listapplications description: List all Applications in an Organization. call: humanitec.listapplications with: orgId: rest.orgId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps name: createapplication operations: - method: POST name: createapplication description: Add a new Application to an Organization call: humanitec.createapplication with: orgId: rest.orgId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId} name: getapplication operations: - method: GET name: getapplication description: Get an existing Application call: humanitec.getapplication with: orgId: rest.orgId appId: rest.appId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId} name: patchapplication operations: - method: PATCH name: patchapplication description: Update metadata of an existing Application call: humanitec.patchapplication outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId} name: deleteapplication operations: - method: DELETE name: deleteapplication description: Delete an Application call: humanitec.deleteapplication with: orgId: rest.orgId appId: rest.appId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/envs name: listenvironments operations: - method: GET name: listenvironments description: List all Environments. call: humanitec.listenvironments with: orgId: rest.orgId appId: rest.appId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/envs name: createenvironment operations: - method: POST name: createenvironment description: Add a new Environment to an Application. call: humanitec.createenvironment with: orgId: rest.orgId appId: rest.appId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/envs/{envId} name: getenvironment operations: - method: GET name: getenvironment description: Get a specific Environment. call: humanitec.getenvironment with: orgId: rest.orgId appId: rest.appId envId: rest.envId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/envs/{envId} name: updateenvironment operations: - method: PATCH name: updateenvironment description: Update a specific Environment. call: humanitec.updateenvironment with: orgId: rest.orgId appId: rest.appId envId: rest.envId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/envs/{envId} name: deleteenvironment operations: - method: DELETE name: deleteenvironment description: Delete a specific Environment. call: humanitec.deleteenvironment with: orgId: rest.orgId appId: rest.appId envId: rest.envId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/envs/{envId}/deploys name: listdeployments operations: - method: GET name: listdeployments description: List Deployments in an Environment. call: humanitec.listdeployments with: orgId: rest.orgId appId: rest.appId envId: rest.envId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/envs/{envId}/deploys name: createdeployment operations: - method: POST name: createdeployment description: Start a new Deployment. call: humanitec.createdeployment with: orgId: rest.orgId appId: rest.appId envId: rest.envId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/envs/{envId}/deploys/{deployId} name: getdeployment operations: - method: GET name: getdeployment description: Get a specific Deployment. call: humanitec.getdeployment with: orgId: rest.orgId appId: rest.appId envId: rest.envId deployId: rest.deployId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/envs/{envId}/deploys/{deployId}/errors name: listdeploymenterrors operations: - method: GET name: listdeploymenterrors description: List errors that occurred in a Deployment. call: humanitec.listdeploymenterrors with: orgId: rest.orgId appId: rest.appId envId: rest.envId deployId: rest.deployId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/envs/{envId}/from_deploy_id name: rebaseenvironment operations: - method: PUT name: rebaseenvironment description: Rebase to a different Deployment. call: humanitec.rebaseenvironment with: orgId: rest.orgId appId: rest.appId envId: rest.envId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/env-types name: listenvironmenttypes operations: - method: GET name: listenvironmenttypes description: List all Environment Types call: humanitec.listenvironmenttypes with: orgId: rest.orgId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/env-types name: createenvironmenttype operations: - method: POST name: createenvironmenttype description: Add a new Environment Type call: humanitec.createenvironmenttype with: orgId: rest.orgId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/env-types/{envTypeId} name: getenvironmenttype operations: - method: GET name: getenvironmenttype description: Get an Environment Type call: humanitec.getenvironmenttype with: orgId: rest.orgId envTypeId: rest.envTypeId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/env-types/{envTypeId} name: deleteenvironmenttype operations: - method: DELETE name: deleteenvironmenttype description: Deletes an Environment Type call: humanitec.deleteenvironmenttype with: orgId: rest.orgId envTypeId: rest.envTypeId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/env-types/{envTypeId} name: updateenvironmenttype operations: - method: PATCH name: updateenvironmenttype description: Updates Environment Type call: humanitec.updateenvironmenttype with: orgId: rest.orgId envTypeId: rest.envTypeId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/artefact-versions name: listartefactversionsinorg operations: - method: GET name: listartefactversionsinorg description: List all Artefacts Versions in the org. call: humanitec.listartefactversionsinorg with: orgId: rest.orgId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/artefact-versions name: createartefactversion operations: - method: POST name: createartefactversion description: Register a new Artefact Version with your organization. call: humanitec.createartefactversion with: orgId: rest.orgId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/artefact-versions/{artefactVersionId} name: getartefactversion operations: - method: GET name: getartefactversion description: Get an Artefacts Versions. call: humanitec.getartefactversion with: orgId: rest.orgId artefactVersionId: rest.artefactVersionId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/artefact-versions/{artefactVersionId}/workload-spec name: getworkloadartefactversionspec operations: - method: GET name: getworkloadartefactversionspec description: Get the spec of this Workload Artefact Version call: humanitec.getworkloadartefactversionspec with: orgId: rest.orgId artefactVersionId: rest.artefactVersionId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/artefact-versions/{artefactVersionId}/workload-deployment-set name: getworkloadartefactversiondeploymentset operations: - method: GET name: getworkloadartefactversiondeploymentset description: Get the Humanitec module definition of this Workload Artefact Version as a deployment set call: humanitec.getworkloadartefactversiondeploymentset with: orgId: rest.orgId artefactVersionId: rest.artefactVersionId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/artefacts name: listartefacts operations: - method: GET name: listartefacts description: List all Artefacts. call: humanitec.listartefacts with: orgId: rest.orgId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/artefacts/{artefactId} name: deleteartefact operations: - method: DELETE name: deleteartefact description: Delete Artefact and all related Artefact Versions call: humanitec.deleteartefact with: orgId: rest.orgId artefactId: rest.artefactId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/artefacts/{artefactId}/versions name: listartefactversions operations: - method: GET name: listartefactversions description: List all Artefact Versions of an Artefact. call: humanitec.listartefactversions with: orgId: rest.orgId artefactId: rest.artefactId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/artefacts/{artefactId}/versions/{versionId} name: patchartefactversion operations: - method: PATCH name: patchartefactversion description: Update Version of an Artefact. call: humanitec.patchartefactversion with: orgId: rest.orgId artefactId: rest.artefactId versionId: rest.versionId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/images name: listdeprecatedimages operations: - method: GET name: listdeprecatedimages description: List all Container Images call: humanitec.listdeprecatedimages with: orgId: rest.orgId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/images/{imageId} name: getdeprecatedimage operations: - method: GET name: getdeprecatedimage description: Get a specific Image Object call: humanitec.getdeprecatedimage with: orgId: rest.orgId imageId: rest.imageId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/images/{imageId}/builds name: listdeprecatedimagebuilds operations: - method: GET name: listdeprecatedimagebuilds description: Lists all the Builds of an Image call: humanitec.listdeprecatedimagebuilds with: orgId: rest.orgId imageId: rest.imageId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/images/{imageId}/builds name: createdeprecatedimagebuild operations: - method: POST name: createdeprecatedimagebuild description: Add a new Image Build call: humanitec.createdeprecatedimagebuild with: orgId: rest.orgId imageId: rest.imageId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/artefact-versions/convert-score name: convertscoretoset operations: - method: POST name: convertscoretoset description: Convert a Score specification, optional overrides, and extensions into the contents for a deployment set. call: humanitec.convertscoretoset with: orgId: rest.orgId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/audit-logs name: listauditlogentries operations: - method: GET name: listauditlogentries description: List audit log entries by Organization call: humanitec.listauditlogentries outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/envs/{envId}/rules name: listautomationrules operations: - method: GET name: listautomationrules description: List all Automation Rules in an Environment. call: humanitec.listautomationrules outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/envs/{envId}/rules name: createautomationrule operations: - method: POST name: createautomationrule description: Create a new Automation Rule for an Environment. call: humanitec.createautomationrule outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId} name: getautomationrule operations: - method: GET name: getautomationrule description: Get a specific Automation Rule for an Environment. call: humanitec.getautomationrule with: ruleId: rest.ruleId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId} name: updateautomationrule operations: - method: PUT name: updateautomationrule description: Update an existing Automation Rule for an Environment. call: humanitec.updateautomationrule with: ruleId: rest.ruleId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId} name: deleteautomationrule operations: - method: DELETE name: deleteautomationrule description: Delete Automation Rule from an Environment. call: humanitec.deleteautomationrule with: ruleId: rest.ruleId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/deltas name: listdeltas operations: - method: GET name: listdeltas description: List Deltas in an Application call: humanitec.listdeltas outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/deltas name: createdelta operations: - method: POST name: createdelta description: Create a new Delta call: humanitec.createdelta outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/deltas/{deltaId} name: getdelta operations: - method: GET name: getdelta description: Fetch an existing Delta call: humanitec.getdelta with: deltaId: rest.deltaId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/deltas/{deltaId} name: patchdelta operations: - method: PATCH name: patchdelta description: Update an existing Delta call: humanitec.patchdelta with: deltaId: rest.deltaId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/deltas/{deltaId} name: putdelta operations: - method: PUT name: putdelta description: Update an existing Delta call: humanitec.putdelta with: deltaId: rest.deltaId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/deltas/{deltaId}/metadata/archived name: archivedelta operations: - method: PUT name: archivedelta description: Mark a Delta as "archived" call: humanitec.archivedelta with: deltaId: rest.deltaId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/deltas/{deltaId}/metadata/env_id name: changeenvofdelta operations: - method: PUT name: changeenvofdelta description: Change the Environment of a Delta call: humanitec.changeenvofdelta with: deltaId: rest.deltaId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/deltas/{deltaId}/metadata/name name: changenameofdelta operations: - method: PUT name: changenameofdelta description: Change the name of a Delta call: humanitec.changenameofdelta with: deltaId: rest.deltaId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/sets name: listsets operations: - method: GET name: listsets description: Get all Deployment Sets call: humanitec.listsets outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/sets/{setId} name: getset operations: - method: GET name: getset description: Get a Deployment Set call: humanitec.getset with: setId: rest.setId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/sets/{setId} name: updateset operations: - method: POST name: updateset description: Apply a Deployment Delta to a Deployment Set call: humanitec.updateset with: setId: rest.setId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/sets/{setId}/resources name: getsetresourceinputs operations: - method: GET name: getsetresourceinputs description: Get Resource Inputs for the given Deployment Set call: humanitec.getsetresourceinputs with: setId: rest.setId outputParameters: - type: object mapping: $. - path: /orgs/{orgId}/apps/{appId}/sets/{setId}/diff/{sourceSetId} name: getdiff operations: - method: GET name: getdiff description: Get the difference between 2 Deployment Sets call: humanitec.getdiff with: setId: rest.setId sourceSetId: rest.sourceSetId outputParameters: - type: object mapping: $. - type: mcp port: 9090 namespace: humanitec-mcp transport: http description: MCP adapter for Humanitec API for AI agent use. tools: - name: createagent description: Register a new Agent under an Organization. hints: readOnly: false destructive: false idempotent: false call: humanitec.createagent outputParameters: - type: object mapping: $. - name: listagents description: List all the agents in an Organization. hints: readOnly: true destructive: false idempotent: true call: humanitec.listagents outputParameters: - type: object mapping: $. - name: deleteagent description: Delete an Agent (and its keys) stored under an Organization. hints: readOnly: false destructive: true idempotent: true call: humanitec.deleteagent outputParameters: - type: object mapping: $. - name: patchagent description: Update the description of an Agent. hints: readOnly: false destructive: false idempotent: false call: humanitec.patchagent outputParameters: - type: object mapping: $. - name: listkeysinagent description: List all the keys registered under an Agent in an Organization. hints: readOnly: true destructive: false idempotent: true call: humanitec.listkeysinagent outputParameters: - type: object mapping: $. - name: createkey description: Register a new Key under an Agent in an Organization. hints: readOnly: false destructive: false idempotent: false call: humanitec.createkey outputParameters: - type: object mapping: $. - name: deletekeyinagent description: Delete a key registered under a Agent. hints: readOnly: false destructive: true idempotent: true call: humanitec.deletekeyinagent outputParameters: - type: object mapping: $. - name: listapplications description: List all Applications in an Organization. hints: readOnly: true destructive: false idempotent: true call: humanitec.listapplications with: orgId: tools.orgId inputParameters: - name: orgId type: string description: The Organization ID. required: true outputParameters: - type: object mapping: $. - name: createapplication description: Add a new Application to an Organization hints: readOnly: false destructive: false idempotent: false call: humanitec.createapplication with: orgId: tools.orgId inputParameters: - name: orgId type: string description: The Organization ID. required: true outputParameters: - type: object mapping: $. - name: getapplication description: Get an existing Application hints: readOnly: true destructive: false idempotent: true call: humanitec.getapplication with: orgId: tools.orgId appId: tools.appId inputParameters: - name: orgId type: string description: The Organization ID. required: true - name: appId type: string description: The Application ID. required: true outputParameters: - type: object mapping: $. - name: patchapplication description: Update metadata of an existing Application hints: readOnly: false destructive: false idempotent: false call: humanitec.patchapplication outputParameters: - type: object mapping: $. - name: deleteapplication description: Delete an Application hints: readOnly: false destructive: true idempotent: true call: humanitec.deleteapplication with: orgId: tools.orgId appId: tools.appId inputParameters: - name: orgId type: string description: The Organization ID. required: true - name: appId type: string description: The Application ID. required: true outputParameters: - type: object mapping: $. - name: listenvironments description: List all Environments. hints: readOnly: true destructive: false idempotent: true call: humanitec.listenvironments with: orgId: tools.orgId appId: tools.appId inputParameters: - name: orgId type: string description: The Organization ID. required: true - name: appId type: string description: The Application ID. required: true outputParameters: - type: object mapping: $. - name: createenvironment description: Add a new Environment to an Application. hints: readOnly: false destructive: false idempotent: false call: humanitec.createenvironment with: orgId: tools.orgId appId: tools.appId inputParameters: - name: orgId type: string description: The Organization ID. required: true - name: appId type: string description: The Application ID. required: true outputParameters: - type: object mapping: $. - name: getenvironment description: Get a specific Environment. hints: readOnly: true destructive: false idempotent: true call: humanitec.getenvironment with: orgId: tools.orgId appId: tools.appId envId: tools.envId inputParameters: - name: orgId type: string description: The Organization ID. required: true - name: appId type: string description: The Application ID. required: true - name: envId type: string description: The Environment ID. required: true outputParameters: - type: object mapping: $. - name: updateenvironment description: Update a specific Environment. hints: readOnly: false destructive: false idempotent: false call: humanitec.updateenvironment with: orgId: tools.orgId appId: tools.appId envId: tools.envId inputParameters: - name: orgId type: string description: The Organization ID. required: true - name: appId type: string description: The Application ID. required: true - name: envId type: string description: The Environment ID. required: true outputParameters: - type: object mapping: $. - name: deleteenvironment description: Delete a specific Environment. hints: readOnly: false destructive: true idempotent: true call: humanitec.deleteenvironment with: orgId: tools.orgId appId: tools.appId envId: tools.envId inputParameters: - name: orgId type: string description: The Organization ID. required: true - name: appId type: string description: The Application ID. required: true - name: envId type: string description: The Environment ID. required: true outputParameters: - type: object mapping: $. - name: listdeployments description: List Deployments in an Environment. hints: readOnly: true destructive: false idempotent: true call: humanitec.listdeployments with: orgId: tools.orgId appId: tools.appId envId: tools.envId pipelineRunId: tools.pipelineRunId inputParameters: - name: orgId type: string description: The Organization ID. required: true - name: appId type: string description: The Application ID. required: true - name: envId type: string description: The Environment ID. required: true - name: pipelineRunId type: string description: An optional filter by the Pipeline and Pipeline Run ID separated by a comma. outputParameters: - type: object mapping: $. - name: createdeployment description: Start a new Deployment. hints: readOnly: false destructive: false idempotent: false call: humanitec.createdeployment with: orgId: tools.orgId appId: tools.appId envId: tools.envId inputParameters: - name: orgId type: string description: The Organization ID. required: true - name: appId type: string description: The Application ID. required: true - name: envId type: string description: The Environment ID. required: true outputParameters: - type: object mapping: $. - name: getdeployment description: Get a specific Deployment. hints: readOnly: true destructive: false idempotent: true call: humanitec.getdeployment with: orgId: tools.orgId appId: tools.appId envId: tools.envId deployId: tools.deployId inputParameters: - name: orgId type: string description: The Organization ID. required: true - name: appId type: string description: The Application ID. required: true - name: envId type: string description: The Environment ID. required: true - name: deployId type: string description: The Deployment ID. required: true outputParameters: - type: object mapping: $. - name: listdeploymenterrors description: List errors that occurred in a Deployment. hints: readOnly: true destructive: false idempotent: true call: humanitec.listdeploymenterrors with: orgId: tools.orgId appId: tools.appId envId: tools.envId deployId: tools.deployId inputParameters: - name: orgId type: string description: The Organization ID. required: true - name: appId type: string description: The Application ID. required: true - name: envId type: string description: The Environment ID. required: true - name: deployId type: string description: The Deployment ID. required: true outputParameters: - type: object mapping: $. - name: rebaseenvironment description: Rebase to a different Deployment. hints: readOnly: false destructive: false idempotent: true call: humanitec.rebaseenvironment with: orgId: tools.orgId appId: tools.appId envId: tools.envId inputParameters: - name: orgId type: string description: The Organization ID. required: true - name: appId type: string description: The Application ID. required: true - name: envId type: string description: The Environment ID. required: true outputParameters: - type: object mapping: $. - name: listenvironmenttypes description: List all Environment Types hints: readOnly: true destructive: false idempotent: true call: humanitec.listenvironmenttypes with: orgId: tools.orgId inputParameters: - name: orgId type: string description: The Organization ID. required: true outputParameters: - type: object mapping: $. - name: createenvironmenttype description: Add a new Environment Type hints: readOnly: false destructive: false idempotent: false call: humanitec.createenvironmenttype with: orgId: tools.orgId inputParameters: - name: orgId type: string description: The Organization ID. required: true outputParameters: - type: object mapping: $. - name: getenvironmenttype description: Get an Environment Type hints: readOnly: true destructive: false idempotent: true call: humanitec.getenvironmenttype with: orgId: tools.orgId envTypeId: tools.envTypeId inputParameters: - name: orgId type: string description: The Organization ID. required: true - name: envTypeId type: string description: ID of the Environment Type. required: true outputParameters: - type: object mapping: $. - name: deleteenvironmenttype description: Deletes an Environment Type hints: readOnly: false destructive: true idempotent: true call: humanitec.deleteenvironmenttype with: orgId: tools.orgId envTypeId: tools.envTypeId inputParameters: - name: orgId type: string description: The Organization ID. required: true - name: envTypeId type: string description: ID of the Environment Type. required: true outputParameters: - type: object mapping: $. - name: updateenvironmenttype description: Updates Environment Type hints: readOnly: false destructive: false idempotent: false call: humanitec.updateenvironmenttype with: orgId: tools.orgId envTypeId: tools.envTypeId inputParameters: - name: orgId type: string description: The Organization ID. required: true - name: envTypeId type: string description: ID of the Environment Type. required: true outputParameters: - type: object mapping: $. - name: listartefactversionsinorg description: List all Artefacts Versions in the org. hints: readOnly: true destructive: false idempotent: true call: humanitec.listartefactversionsinorg with: orgId: tools.orgId name: tools.name reference: tools.reference archived: tools.archived type: tools.type inputParameters: - name: orgId type: string description: The organization ID. required: true - name: name type: string description: (Optional) Filter Artefact Versions by name. - name: reference type: string description: (Optional) Filter Artefact Versions by the reference to a Version of the same Artefact. This cannot be used together with `name`. - name: archived type: boolean description: (Optional) Filter for non-archived Artefact Versions. If no filter is defined only non-archived Artefact Versions are returned, if the filter is true both archi - name: type type: string description: (Optional) Filter by artefact type. outputParameters: - type: object mapping: $. - name: createartefactversion description: Register a new Artefact Version with your organization. hints: readOnly: false destructive: false idempotent: false call: humanitec.createartefactversion with: orgId: tools.orgId vcs: tools.vcs dry_run: tools.dry_run inputParameters: - name: orgId type: string description: The organization ID. required: true - name: vcs type: string description: (Optional) Which version control system the version comes from. Default value is "git". If this parameter is not supplied or its value is "git", the provided re - name: dry_run type: boolean description: Optionally validate the request but do not persist the actual artefact. If the Accept type is set to "application/x.workload-deployment-set+json" or "applicatio outputParameters: - type: object mapping: $. - name: getartefactversion description: Get an Artefacts Versions. hints: readOnly: true destructive: false idempotent: true call: humanitec.getartefactversion with: orgId: tools.orgId artefactVersionId: tools.artefactVersionId inputParameters: - name: orgId type: string description: The organization ID. required: true - name: artefactVersionId type: string description: The Artefact Version ID. required: true outputParameters: - type: object mapping: $. - name: getworkloadartefactversionspec description: Get the spec of this Workload Artefact Version hints: readOnly: true destructive: false idempotent: true call: humanitec.getworkloadartefactversionspec with: orgId: tools.orgId artefactVersionId: tools.artefactVersionId inputParameters: - name: orgId type: string description: The organization ID. required: true - name: artefactVersionId type: string description: The Artefact Version ID. required: true outputParameters: - type: object mapping: $. - name: getworkloadartefactversiondeploymentset description: Get the Humanitec module definition of this Workload Artefact Version as a deployment set hints: readOnly: true destructive: false idempotent: true call: humanitec.getworkloadartefactversiondeploymentset with: orgId: tools.orgId artefactVersionId: tools.artefactVersionId inputParameters: - name: orgId type: string description: The organization ID. required: true - name: artefactVersionId type: string description: The Artefact Version ID. required: true outputParameters: - type: object mapping: $. - name: listartefacts description: List all Artefacts. hints: readOnly: true destructive: false idempotent: true call: humanitec.listartefacts with: orgId: tools.orgId type: tools.type name: tools.name inputParameters: - name: orgId type: string description: The organization ID. required: true - name: type type: string description: (Optional) Filter Artefacts by type. - name: name type: string description: (Optional) Filter Artefacts by name. outputParameters: - type: object mapping: $. - name: deleteartefact description: Delete Artefact and all related Artefact Versions hints: readOnly: false destructive: true idempotent: true call: humanitec.deleteartefact with: orgId: tools.orgId artefactId: tools.artefactId inputParameters: - name: orgId type: string description: The organization ID. required: true - name: artefactId type: string description: The Artefact ID. required: true outputParameters: - type: object mapping: $. - name: listartefactversions description: List all Artefact Versions of an Artefact. hints: readOnly: true destructive: false idempotent: true call: humanitec.listartefactversions with: orgId: tools.orgId artefactId: tools.artefactId archived: tools.archived reference: tools.reference limit: tools.limit inputParameters: - name: orgId type: string description: The organization ID. required: true - name: artefactId type: string description: The Artefact ID. required: true - name: archived type: boolean description: (Optional) Filter for non-archived Artefact Versions. If no filter is defined only non-archived Artefact Versions are returned, if the filter is true both archi - name: reference type: string description: (Optional) Filter Artefact Versions by by name including a version or digest. - name: limit type: integer description: (Optional) Limit the number of versions returned by the endpoint. outputParameters: - type: object mapping: $. - name: patchartefactversion description: Update Version of an Artefact. hints: readOnly: false destructive: false idempotent: false call: humanitec.patchartefactversion with: orgId: tools.orgId artefactId: tools.artefactId versionId: tools.versionId inputParameters: - name: orgId type: string description: The organization ID. required: true - name: artefactId type: string description: The Artefact ID. required: true - name: versionId type: string description: The Version ID. required: true outputParameters: - type: object mapping: $. - name: listdeprecatedimages description: List all Container Images hints: readOnly: true destructive: false idempotent: true call: humanitec.listdeprecatedimages with: orgId: tools.orgId inputParameters: - name: orgId type: string description: The organization ID. required: true outputParameters: - type: object mapping: $. - name: getdeprecatedimage description: Get a specific Image Object hints: readOnly: true destructive: false idempotent: true call: humanitec.getdeprecatedimage with: orgId: tools.orgId imageId: tools.imageId inputParameters: - name: orgId type: string description: The organization ID. required: true - name: imageId type: string description: The Image ID. required: true outputParameters: - type: object mapping: $. - name: listdeprecatedimagebuilds description: Lists all the Builds of an Image hints: readOnly: true destructive: false idempotent: true call: humanitec.listdeprecatedimagebuilds with: orgId: tools.orgId imageId: tools.imageId inputParameters: - name: orgId type: string description: The organization ID. required: true - name: imageId type: string description: The Image ID. required: true outputParameters: - type: object mapping: $. - name: createdeprecatedimagebuild description: Add a new Image Build hints: readOnly: false destructive: false idempotent: false call: humanitec.createdeprecatedimagebuild with: orgId: tools.orgId imageId: tools.imageId inputParameters: - name: orgId type: string description: The organization ID. required: true - name: imageId type: string description: The Image ID. required: true outputParameters: - type: object mapping: $. - name: convertscoretoset description: Convert a Score specification, optional overrides, and extensions into the contents for a deployment set. hints: readOnly: false destructive: false idempotent: false call: humanitec.convertscoretoset with: orgId: tools.orgId inputParameters: - name: orgId type: string description: The organization ID. required: true outputParameters: - type: object mapping: $. - name: listauditlogentries description: List audit log entries by Organization hints: readOnly: true destructive: false idempotent: true call: humanitec.listauditlogentries with: from: tools.from to: tools.to inputParameters: - name: from type: string description: Optional filter for entries created after the given time. - name: to type: string description: Optional filter for entries created before the given time. outputParameters: - type: object mapping: $. - name: listautomationrules description: List all Automation Rules in an Environment. hints: readOnly: true destructive: false idempotent: true call: humanitec.listautomationrules outputParameters: - type: object mapping: $. - name: createautomationrule description: Create a new Automation Rule for an Environment. hints: readOnly: false destructive: false idempotent: false call: humanitec.createautomationrule outputParameters: - type: object mapping: $. - name: getautomationrule description: Get a specific Automation Rule for an Environment. hints: readOnly: true destructive: false idempotent: true call: humanitec.getautomationrule with: ruleId: tools.ruleId inputParameters: - name: ruleId type: string description: The Automation Rule ID. required: true outputParameters: - type: object mapping: $. - name: updateautomationrule description: Update an existing Automation Rule for an Environment. hints: readOnly: false destructive: false idempotent: true call: humanitec.updateautomationrule with: ruleId: tools.ruleId inputParameters: - name: ruleId type: string description: The Automation Rule ID. required: true outputParameters: - type: object mapping: $. - name: deleteautomationrule description: Delete Automation Rule from an Environment. hints: readOnly: false destructive: true idempotent: true call: humanitec.deleteautomationrule with: ruleId: tools.ruleId inputParameters: - name: ruleId type: string description: The Automation Rule ID. required: true outputParameters: - type: object mapping: $. - name: listdeltas description: List Deltas in an Application hints: readOnly: true destructive: false idempotent: true call: humanitec.listdeltas with: archived: tools.archived env: tools.env inputParameters: - name: archived type: boolean description: If true, return archived Deltas. - name: env type: string description: Only return Deltas associated with the specified Environment. outputParameters: - type: object mapping: $. - name: createdelta description: Create a new Delta hints: readOnly: false destructive: false idempotent: false call: humanitec.createdelta outputParameters: - type: object mapping: $. - name: getdelta description: Fetch an existing Delta hints: readOnly: true destructive: false idempotent: true call: humanitec.getdelta with: deltaId: tools.deltaId inputParameters: - name: deltaId type: string description: ID of the Delta to fetch. required: true outputParameters: - type: object mapping: $. - name: patchdelta description: Update an existing Delta hints: readOnly: false destructive: false idempotent: false call: humanitec.patchdelta with: deltaId: tools.deltaId inputParameters: - name: deltaId type: string description: ID of the Delta to update. required: true outputParameters: - type: object mapping: $. - name: putdelta description: Update an existing Delta hints: readOnly: false destructive: false idempotent: true call: humanitec.putdelta with: deltaId: tools.deltaId inputParameters: - name: deltaId type: string description: ID of the Delta to update. required: true outputParameters: - type: object mapping: $. - name: archivedelta description: Mark a Delta as "archived" hints: readOnly: false destructive: false idempotent: true call: humanitec.archivedelta with: deltaId: tools.deltaId inputParameters: - name: deltaId type: string description: ID of the Deployment Delta. required: true outputParameters: - type: object mapping: $. - name: changeenvofdelta description: Change the Environment of a Delta hints: readOnly: false destructive: false idempotent: true call: humanitec.changeenvofdelta with: deltaId: tools.deltaId inputParameters: - name: deltaId type: string description: ID of the Deployment Delta. required: true outputParameters: - type: object mapping: $. - name: changenameofdelta description: Change the name of a Delta hints: readOnly: false destructive: false idempotent: true call: humanitec.changenameofdelta with: deltaId: tools.deltaId inputParameters: - name: deltaId type: string description: ID of the Deployment Delta. required: true outputParameters: - type: object mapping: $. - name: listsets description: Get all Deployment Sets hints: readOnly: true destructive: false idempotent: true call: humanitec.listsets outputParameters: - type: object mapping: $. - name: getset description: Get a Deployment Set hints: readOnly: true destructive: false idempotent: true call: humanitec.getset with: setId: tools.setId diff: tools.diff inputParameters: - name: setId type: string description: ID of the Deployment Set. required: true - name: diff type: string description: ID of the Deployment Set to compared against. outputParameters: - type: object mapping: $. - name: updateset description: Apply a Deployment Delta to a Deployment Set hints: readOnly: false destructive: false idempotent: false call: humanitec.updateset with: setId: tools.setId inputParameters: - name: setId type: string description: ID of the Deployment Set. required: true outputParameters: - type: object mapping: $. - name: getsetresourceinputs description: Get Resource Inputs for the given Deployment Set hints: readOnly: true destructive: false idempotent: true call: humanitec.getsetresourceinputs with: setId: tools.setId inputParameters: - name: setId type: string description: ID of the Deployment Set. required: true outputParameters: - type: object mapping: $. - name: getdiff description: Get the difference between 2 Deployment Sets hints: readOnly: true destructive: false idempotent: true call: humanitec.getdiff with: setId: tools.setId sourceSetId: tools.sourceSetId inputParameters: - name: setId type: string description: ID of the Deployment Set. required: true - name: sourceSetId type: string description: ID of the Deployment Set to diff against. required: true outputParameters: - type: object mapping: $.