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-appId-envs-envId-value-set-versions-valueSetVersionId-purge-key path: /orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions/{valueSetVersionId}/purge/{key} operations: - name: post method: POST description: Purge the value of a specific Shared Value from the App Environment Version history. 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: key in: path type: string description: Key of the value to be purged. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-apps-appId-envs-envId-value-set-versions-valueSetVersionId-restore path: /orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions/{valueSetVersionId}/restore operations: - name: post method: POST description: Restore a Value Set Version 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: valueSetVersionId in: path type: string description: The ValueSetVersion ID. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-apps-appId-envs-envId-value-set-versions-valueSetVersionId-restore-ke path: /orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions/{valueSetVersionId}/restore/{key} operations: - name: post method: POST description: Restore a specific key from the Value Set Version 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: valueSetVersionId in: path type: string description: The ValueSetVersion ID. required: true - name: key in: path type: string description: Key of the value to be restored. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-apps-appId-envs-envId-values path: /orgs/{orgId}/apps/{appId}/envs/{envId}/values operations: - name: get method: GET description: List Shared Values 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: post method: POST description: Create a Shared Value for 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: body in: body type: object description: Request body (JSON). required: true - name: delete method: DELETE description: Delete all Shared Value for 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: orgs-orgId-apps-appId-envs-envId-values-key path: /orgs/{orgId}/apps/{appId}/envs/{envId}/values/{key} operations: - name: put method: PUT description: Update Shared Value for 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: key in: path type: string description: The key to update. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: delete method: DELETE description: Delete Shared Value for 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: key in: path type: string description: The key to update. required: true - name: patch method: PATCH description: Update Shared Value for 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: key in: path type: string description: The key to update. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-apps-appId-jobs path: /orgs/{orgId}/apps/{appId}/jobs operations: - name: delete method: DELETE description: Deletes all Jobs for the 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-pipeline-criteria path: /orgs/{orgId}/apps/{appId}/pipeline-criteria operations: - name: listpipelinecriteriainapp method: GET description: List the trigger matching criteria defined for Pipelines in this Application. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: pipeline in: query type: string description: An optional filter by Pipeline ID. - name: match in: query type: object description: Optional key value match filters on the criteria. - name: orgs-orgId-apps-appId-pipeline-runs path: /orgs/{orgId}/apps/{appId}/pipeline-runs operations: - name: createpipelinerunbytriggercriteria method: POST description: Create a Pipeline Run in the appropriate Pipeline based on the trigger and inputs. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: dry_run in: query type: boolean description: Optionally validate the request but do not persist the actual Pipeline Run. - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-apps-appId-pipelines path: /orgs/{orgId}/apps/{appId}/pipelines operations: - name: listpipelines method: GET description: List Pipelines within an Application. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createpipeline method: POST description: Create a Pipeline within an Application. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: dry_run in: query type: boolean description: Optionally validate the request but do not persist the actual Pipeline. - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-apps-appId-pipelines-pipelineId path: /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId} operations: - name: getpipeline method: GET description: Get a Pipeline within an Application. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updatepipeline method: PATCH description: update a Pipeline within an Application. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: dry_run in: query type: boolean description: Optionally validate the request but do not persist the update. - name: body in: body type: object description: Request body (JSON). required: true - name: deletepipeline method: DELETE description: Delete a pipeline within an application. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-apps-appId-pipelines-pipelineId-batches-batchType path: /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/batches/{batchType} operations: - name: getbatch method: GET description: Read the current state of a trigger batch outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-apps-appId-pipelines-pipelineId-criteria path: /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/criteria operations: - name: createpipelinecriteria method: POST description: Create a new trigger matching criteria for this Pipeline. 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-pipelines-pipelineId-criteria-criteriaId path: /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/criteria/{criteriaId} operations: - name: getpipelinecriteria method: GET description: Get the Pipeline Criteria with the given id. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: criteriaId in: path type: string description: The Criteria ID required: true - name: deletepipelinecriteria method: DELETE description: Delete the Pipeline Criteria with the given id. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: criteriaId in: path type: string description: The Criteria ID required: true - name: orgs-orgId-apps-appId-pipelines-pipelineId-runs path: /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs operations: - name: listpipelineruns method: GET description: List runs within a pipeline ordered newest to oldest. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createpipelinerun method: POST description: Create a run within a pipeline. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: dry_run in: query type: boolean description: Optionally validate the request but do not persist the actual Pipeline Run. - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-apps-appId-pipelines-pipelineId-runs-runId path: /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId} operations: - name: getpipelinerun method: GET description: Get a run within an pipeline. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: deletepipelinerun method: DELETE description: Deleting a completed Run within a Pipeline. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-apps-appId-pipelines-pipelineId-runs-runId-cancel path: /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/cancel operations: - name: cancelpipelinerun method: POST description: Cancel a Run within an Pipeline. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-apps-appId-pipelines-pipelineId-runs-runId-jobs path: /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs operations: - name: listpipelinejobs method: GET description: List the details of the jobs within a pipeline run. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-apps-appId-pipelines-pipelineId-runs-runId-jobs-jobId path: /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs/{jobId} operations: - name: getpipelinejob method: GET description: List the details of a Job including Step information outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-apps-appId-pipelines-pipelineId-runs-runId-jobs-jobId-approvals-appro path: /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs/{jobId}/approvals/{approvalId} operations: - name: getpipelineapprovalrequest method: GET description: Get an approval request outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-apps-appId-pipelines-pipelineId-runs-runId-jobs-jobId-approvals-appro path: /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs/{jobId}/approvals/{approvalId}/approve operations: - name: approvepipelineapprovalrequest method: POST description: Approve the approval request outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-apps-appId-pipelines-pipelineId-runs-runId-jobs-jobId-approvals-appro path: /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs/{jobId}/approvals/{approvalId}/deny operations: - name: denypipelineapprovalrequest method: POST description: Deny the approval request outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-apps-appId-pipelines-pipelineId-runs-runId-jobs-jobId-steps-stepIndex path: /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs/{jobId}/steps/{stepIndex}/logs operations: - name: listpipelinesteplogs method: GET description: Get a page of log output for a given step within a job. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-apps-appId-pipelines-pipelineId-runs-runId-restart path: /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/restart operations: - name: restartpipelinerun method: POST description: Restart a Run within an Pipeline by cloning it with the same trigger and inputs. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-apps-appId-pipelines-pipelineId-schema path: /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/schema operations: - name: getpipelinedefinition method: GET description: Get a pipeline schema. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: Accept in: header type: string - name: orgs-orgId-apps-appId-pipelines-pipelineId-versions path: /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/versions operations: - name: listpipelineversions method: GET description: List all versions of the pipeline outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-apps-appId-runtime path: /orgs/{orgId}/apps/{appId}/runtime operations: - name: listruntime method: GET description: Get Runtime information about specific multiple environments. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: query type: array description: Filter environments by ID (required). Up to 5 ids can be supplied per request. - 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 outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: setId in: path type: string description: ID of the Deployment Set. required: true - name: diff in: query type: string description: ID of the Deployment Set to compared against. - name: updateset method: POST description: Apply a Deployment Delta to a Deployment Set outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: setId in: path type: string description: ID of the Deployment Set. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-apps-appId-sets-setId-diff-sourceSetId path: /orgs/{orgId}/apps/{appId}/sets/{setId}/diff/{sourceSetId} operations: - name: getdiff method: GET description: Get the difference between 2 Deployment Sets outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: setId in: path type: string description: ID of the Deployment Set. required: true - name: sourceSetId in: path type: string description: ID of the Deployment Set to diff against. required: true - 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 outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: setId in: path type: string description: ID of the Deployment Set. required: true - name: orgs-orgId-apps-appId-users path: /orgs/{orgId}/apps/{appId}/users operations: - name: listuserrolesinapp method: GET description: List Users or Groups with roles in an App outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createuserroleinapp method: POST description: Adds a User or a Group to an Application with a Role 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-users-userId path: /orgs/{orgId}/apps/{appId}/users/{userId} operations: - name: getuserroleinapp method: GET description: Get the role of a User or a Group on an Application outputRawFormat: json outputParameters: - name: result type: object value: $. - name: deleteuserroleinapp method: DELETE description: Remove the role of a User or a Group on an Application outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updateuserroleinapp method: PATCH description: Update the role of a User or a Group on an Application 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-value-set-versions path: /orgs/{orgId}/apps/{appId}/value-set-versions operations: - name: get method: GET description: List Value Set Versions in the 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: key_changed in: query type: string description: (Optional) Return only value set version where the specified key changed - name: orgs-orgId-apps-appId-value-set-versions-valueSetVersionId path: /orgs/{orgId}/apps/{appId}/value-set-versions/{valueSetVersionId} operations: - name: get method: GET description: Get a single Value Set Version from the 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: valueSetVersionId in: path type: string description: The ValueSetVersion ID. required: true - name: orgs-orgId-apps-appId-value-set-versions-valueSetVersionId-purge-key path: /orgs/{orgId}/apps/{appId}/value-set-versions/{valueSetVersionId}/purge/{key} operations: - name: post method: POST description: Purge the value of a specific Shared Value from the App Version history. 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: valueSetVersionId in: path type: string description: The ValueSetVersion ID. required: true - name: key in: path type: string description: Key of the value to be purged. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-apps-appId-value-set-versions-valueSetVersionId-restore path: /orgs/{orgId}/apps/{appId}/value-set-versions/{valueSetVersionId}/restore operations: - name: post method: POST description: Restore a Value Set Version in 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: valueSetVersionId in: path type: string description: The ValueSetVersion ID. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-apps-appId-value-set-versions-valueSetVersionId-restore-key path: /orgs/{orgId}/apps/{appId}/value-set-versions/{valueSetVersionId}/restore/{key} operations: - name: post method: POST description: Restore a specific key from the Value Set Version in 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: valueSetVersionId in: path type: string description: The ValueSetVersion ID. required: true - name: key in: path type: string description: Key of the value to be restored. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-apps-appId-values path: /orgs/{orgId}/apps/{appId}/values operations: - name: get method: GET description: List Shared Values in 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: post method: POST description: Create a Shared Value for 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: delete method: DELETE description: Delete all Shared Value for 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: orgs-orgId-apps-appId-values-key path: /orgs/{orgId}/apps/{appId}/values/{key} operations: - name: put method: PUT description: Update Shared Value for 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: key in: path type: string description: The key to update. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: delete method: DELETE description: Delete Shared Value for 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: key in: path type: string description: The key to update. required: true - name: patch method: PATCH description: Update Shared Value for 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: key in: path type: string description: The key to update. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-apps-appId-webhooks path: /orgs/{orgId}/apps/{appId}/webhooks operations: - name: get method: GET description: List Webhooks 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: post method: POST description: Create a new Webhook 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-webhooks-jobId path: /orgs/{orgId}/apps/{appId}/webhooks/{jobId} operations: - name: get method: GET description: Get a Webhook 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: jobId in: path type: string description: The Webhook ID. required: true - name: delete method: DELETE description: Delete a Webhook 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: jobId in: path type: string description: The Webhook ID. required: true - name: patch method: PATCH description: Update a Webhook 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: jobId in: path type: string description: The Webhook ID. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-artefact-versions path: /orgs/{orgId}/artefact-versions operations: - name: listartefactversionsinorg method: GET description: List all Artefacts Versions in the org. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The organization ID. required: true - 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. - name: createartefactversion method: POST description: Register a new Artefact Version with your organization. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The organization ID. required: true - 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. - name: body in: body type: object description: Request body (JSON). required: true - 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. 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-artefact-versions-artefactVersionId path: /orgs/{orgId}/artefact-versions/{artefactVersionId} operations: - name: getartefactversion method: GET description: Get an Artefacts Versions. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The organization ID. required: true - name: artefactVersionId in: path type: string description: The Artefact Version ID. required: true - name: orgs-orgId-artefact-versions-artefactVersionId-workload-deployment-set 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 outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The organization ID. required: true - name: artefactVersionId in: path type: string description: The Artefact Version ID. required: true - name: Accept in: header type: string description: The accepted content type. - name: orgs-orgId-artefact-versions-artefactVersionId-workload-spec path: /orgs/{orgId}/artefact-versions/{artefactVersionId}/workload-spec operations: - name: getworkloadartefactversionspec method: GET description: Get the spec of this Workload Artefact Version outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The organization ID. required: true - name: artefactVersionId in: path type: string description: The Artefact Version ID. required: true - name: Accept in: header type: string description: The accepted content type. - name: orgs-orgId-artefacts path: /orgs/{orgId}/artefacts operations: - name: listartefacts method: GET description: List all Artefacts. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The organization ID. required: true - name: type in: query type: string description: (Optional) Filter Artefacts by type. - name: name in: query type: string description: (Optional) Filter Artefacts by name. - name: orgs-orgId-artefacts-artefactId path: /orgs/{orgId}/artefacts/{artefactId} operations: - name: deleteartefact method: DELETE description: Delete Artefact and all related Artefact Versions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The organization ID. required: true - name: artefactId in: path type: string description: The Artefact ID. required: true - 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. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The organization ID. required: true - name: artefactId in: path type: string description: The Artefact ID. required: true - 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. - name: orgs-orgId-artefacts-artefactId-versions-versionId path: /orgs/{orgId}/artefacts/{artefactId}/versions/{versionId} operations: - name: patchartefactversion method: PATCH description: Update Version of an Artefact. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The organization ID. required: true - name: artefactId in: path type: string description: The Artefact ID. required: true - name: versionId in: path type: string description: The Version ID. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-audit-logs path: /orgs/{orgId}/audit-logs operations: - name: listauditlogentries method: GET description: List audit log entries by Organization outputRawFormat: json outputParameters: - name: result type: object value: $. 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. - name: orgs-orgId-env-types path: /orgs/{orgId}/env-types operations: - name: listenvironmenttypes method: GET description: List all Environment Types outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: createenvironmenttype method: POST description: Add a new Environment Type 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-env-types-envTypeId path: /orgs/{orgId}/env-types/{envTypeId} operations: - name: getenvironmenttype method: GET description: Get an Environment Type outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: envTypeId in: path type: string description: ID of the Environment Type. required: true - name: deleteenvironmenttype method: DELETE description: Deletes an Environment Type outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: envTypeId in: path type: string description: ID of the Environment Type. required: true - name: updateenvironmenttype method: PATCH description: Updates Environment Type outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: envTypeId in: path type: string description: ID of the Environment Type. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-env-types-envType-users path: /orgs/{orgId}/env-types/{envType}/users operations: - name: listuserrolesinenvtype method: GET description: List Users and Groups with roles in an Environment Type outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createuserroleinenvtype method: POST description: Adds a User or a Group to an Environment Type with a Role outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-env-types-envType-users-userId path: /orgs/{orgId}/env-types/{envType}/users/{userId} operations: - name: getuserroleinenvtype method: GET description: Get the role of a User or a Group on an Environment Type outputRawFormat: json outputParameters: - name: result type: object value: $. - name: deleteuserroleinenvtype method: DELETE description: Remove the role of a User or a Group on an Environment Type outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updateuserroleinenvtype method: PATCH description: Update the role of a User or a Group on an Environment Type outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-events path: /orgs/{orgId}/events operations: - name: get method: GET description: List Events outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: orgs-orgId-groups path: /orgs/{orgId}/groups operations: - name: creategroup method: POST description: Create a group 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-groups-groupId-users path: /orgs/{orgId}/groups/{groupId}/users operations: - name: listgroupusers method: GET description: List users in a group. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-humanitec-keys path: /orgs/{orgId}/humanitec-keys operations: - name: listhumanitecpublickeys method: GET description: List all the public keys Humanitec shares with an organization. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The organization ID. required: true - name: active in: query type: boolean description: If set to true, the response includes only the active key, if set to false only non-active keys, otherwise both active and non-active keys. - name: orgs-orgId-images path: /orgs/{orgId}/images operations: - name: listdeprecatedimages method: GET description: List all Container Images outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The organization ID. required: true - name: orgs-orgId-images-imageId path: /orgs/{orgId}/images/{imageId} operations: - name: getdeprecatedimage method: GET description: Get a specific Image Object outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The organization ID. required: true - name: imageId in: path type: string description: The Image ID. required: true - 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 outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The organization ID. required: true - name: imageId in: path type: string description: The Image ID. required: true - name: createdeprecatedimagebuild method: POST description: Add a new Image Build outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The organization ID. required: true - name: imageId in: path type: string description: The Image ID. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-invitations path: /orgs/{orgId}/invitations operations: - name: listinvitesinorg method: GET description: List the invites issued for the organization. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createinviteinorg method: POST description: Invites a user to an Organization with a specified role. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-keys path: /orgs/{orgId}/keys operations: - name: createpublickey method: POST description: Associate a new RSA public key 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: listpublickeys method: GET description: List all public keys associated 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: fingerprint in: query type: string description: The fingerprint (the hexadecimal representation of the sha256 hash of the DER representation of the key) of the requested key. If a value is provided, the resul - name: orgs-orgId-keys-keyId path: /orgs/{orgId}/keys/{keyId} operations: - name: deletepublickey method: DELETE description: Delete a public key associated 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: keyId in: path type: string description: The public key ID. required: true - name: getpublickey method: GET description: Retrieve a single public key associated 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: keyId in: path type: string description: The public key ID. required: true - name: orgs-orgId-pipeline-runs path: /orgs/{orgId}/pipeline-runs operations: - name: listpipelinerunsbyorg method: GET description: List all pipeline runs within the Org ordered newest to oldest. This can be filtered by app, pipeline, and status. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-pipeline-schemas-latest path: /orgs/{orgId}/pipeline-schemas/latest operations: - name: getlatestpipelinedefinitionschema method: GET description: Gets the latest pipeline schema outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-pipelines path: /orgs/{orgId}/pipelines operations: - name: listpipelinesinorg method: GET description: List all Pipelines within an Organization. This can be filtered by Application. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-registries path: /orgs/{orgId}/registries operations: - name: get method: GET description: Lists available registries for the organization. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: Unique (alpha-numerical) organization identifier. required: true - name: post method: POST description: Creates a new registry record. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: Unique (alpha-numerical) organization identifier. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-registries-regId path: /orgs/{orgId}/registries/{regId} operations: - name: get method: GET description: Loads a registry record details. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: Unique (alpha-numerical) organization identifier. required: true - name: regId in: path type: string description: Unique (alpha-numerical) registry identifier. required: true - name: delete method: DELETE description: Deletes an existing registry record and all associated credentials and secrets. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: Unique (alpha-numerical) organization identifier. required: true - name: regId in: path type: string description: Unique (alpha-numerical) registry identifier. required: true - name: patch method: PATCH description: Updates (patches) an existing registry record. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: Unique (alpha-numerical) organization identifier. required: true - name: regId in: path type: string description: Unique (alpha-numerical) registry identifier. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-registries-regId-creds path: /orgs/{orgId}/registries/{regId}/creds operations: - name: get method: GET description: Returns current account credentials or secret details for the registry. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: Unique (alpha-numerical) organization identifier. required: true - name: regId in: path type: string description: Unique (alpha-numerical) registry identifier. required: true - name: orgs-orgId-resources-account-types path: /orgs/{orgId}/resources/account-types operations: - name: listresourceaccounttypes method: GET description: List Resource Account Types available to the organization. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: orgs-orgId-resources-accounts path: /orgs/{orgId}/resources/accounts operations: - name: listresourceaccounts method: GET description: List Resource Accounts in the organization. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: createresourceaccount method: POST description: Create a new Resource Account in the organization. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: dry_run in: query type: boolean description: Validate the request but do not persist the change. - name: check_credential in: query type: boolean description: Validate that the Account credential authenticates successfully. - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-resources-accounts-accId path: /orgs/{orgId}/resources/accounts/{accId} operations: - name: getresourceaccount method: GET description: Get a Resource Account. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: accId in: path type: string description: The Resource Account ID. required: true - name: deleteresourceaccount method: DELETE description: Delete an unused Resource Account. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: accId in: path type: string description: The Resource Account ID. required: true - name: patchresourceaccount method: PATCH description: Update a Resource Account. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: accId in: path type: string description: The Resource Account ID. required: true - name: dry_run in: query type: boolean description: Validate the request but do not persist the change. - name: check_credential in: query type: boolean description: Validate that the Account credential authenticates successfully. - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-resources-accounts-accId-actions-check path: /orgs/{orgId}/resources/accounts/{accId}/actions/check operations: - name: checkresourceaccount method: POST description: Check the credentials of an existing Resource Account outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: accId in: path type: string description: The Resource Account ID. required: true - name: orgs-orgId-resources-classes path: /orgs/{orgId}/resources/classes operations: - name: listresourceclasses method: GET description: List resource classes. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The organization ID. required: true - name: orgs-orgId-resources-defs path: /orgs/{orgId}/resources/defs operations: - name: listresourcedefinitions method: GET description: List Resource Definitions. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: app in: query type: string description: (Optional) Filter Resource Definitions that may match a specific Application. - name: env in: query type: string description: (Optional) Filter Resource Definitions that may match a specific Environment. - name: env_type in: query type: string description: (Optional) Filter Resource Definitions that may match a specific Environment Type. - name: res in: query type: string description: (Optional) Filter Resource Definitions that may match a specific Resource. - name: res_type in: query type: string description: (Optional) Filter Resource Definitions that may match a specific Resource Type. - name: class in: query type: string description: (Optional) Filter Resource Definitions that may match a specific Class. - name: deleted in: query type: boolean description: If returns also resource definitions which has been deleted. - name: createresourcedefinition method: POST description: Create a new Resource Definition. 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-resources-defs-defId path: /orgs/{orgId}/resources/defs/{defId} operations: - name: getresourcedefinition method: GET description: Get a Resource Definition. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: defId in: path type: string description: The Resource Definition ID. required: true - name: deleted in: query type: boolean description: If returns the resource definition even if it has been deleted. - name: updateresourcedefinition method: PUT description: Update a Resource Definition. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: defId in: path type: string description: The Resource Definition ID. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: deleteresourcedefinition method: DELETE description: Delete a Resource Definition. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: defId in: path type: string description: The Resource Definition ID. required: true - name: force in: query type: boolean description: If set to `true`, will mark the Resource Definition for deletion, even if it affects existing Active Resources. - name: patchresourcedefinition method: PATCH description: Update a Resource Definition. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: defId in: path type: string description: The Resource Definition ID. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-resources-defs-defId-criteria path: /orgs/{orgId}/resources/defs/{defId}/criteria operations: - name: updateresourcedefinitioncriteria method: PUT description: Update all Matching Criteria of a Resource Definition. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: defId in: path type: string description: The Resource Definition ID. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: createresourcedefinitioncriteria method: POST description: Add a new Matching Criteria to a Resource Definition. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: defId in: path type: string description: The Resource Definition ID. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-resources-defs-defId-criteria-criteriaId path: /orgs/{orgId}/resources/defs/{defId}/criteria/{criteriaId} operations: - name: deleteresourcedefinitioncriteria method: DELETE description: Delete a Matching Criteria from a Resource Definition. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: defId in: path type: string description: The Resource Definition ID. required: true - name: criteriaId in: path type: string description: The Matching Criteria ID. required: true - name: force in: query type: boolean description: If set to `true`, the Matching Criteria is deleted immediately, even if this action affects existing Active Resources. - name: orgs-orgId-resources-defs-defId-resources path: /orgs/{orgId}/resources/defs/{defId}/resources operations: - name: listactiveresourcebydefinition method: GET description: List Active Resources provisioned via a specific Resource Definition. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: defId in: path type: string description: The Resource Definition ID. required: true - name: orgs-orgId-resources-defs-defId-versions path: /orgs/{orgId}/resources/defs/{defId}/versions operations: - name: listresourcedefinitionversions method: GET description: Get Versions of a Resource Definition. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-resources-defs-defId-versions-defVersionId path: /orgs/{orgId}/resources/defs/{defId}/versions/{defVersionId} operations: - name: getresourcedefinitionversion method: GET description: Get a Resource Definition Version. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-resources-defs-defId-versions-defVersionId-actions-archive path: /orgs/{orgId}/resources/defs/{defId}/versions/{defVersionId}/actions/archive operations: - name: archiveresourcedefinitionversion method: POST description: Mark/unmark the Resource Definition Version as archived. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-resources-defs-defId-versions-defVersionId-actions-promote path: /orgs/{orgId}/resources/defs/{defId}/versions/{defVersionId}/actions/promote operations: - name: promoteresourcedefinitionversion method: POST description: Promote the Resource Definition Version as active. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-resources-drivers path: /orgs/{orgId}/resources/drivers operations: - name: listresourcedrivers method: GET description: List Resource Drivers. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: createresourcedriver method: POST description: Register a new Resource Driver. 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-resources-drivers-driverId path: /orgs/{orgId}/resources/drivers/{driverId} operations: - name: getresourcedriver method: GET description: Get a Resource Driver. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: driverId in: path type: string description: The Resource Driver ID. required: true - name: updateresourcedriver method: PUT description: Update a Resource Driver. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: driverId in: path type: string description: The Resource Driver ID. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: deleteresourcedriver method: DELETE description: Delete a Resources Driver. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: driverId in: path type: string description: The Resources Driver ID to delete. required: true - name: orgs-orgId-resources-types path: /orgs/{orgId}/resources/types operations: - name: listresourcetypes method: GET description: List Resource Types. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: createresourcetype method: POST description: Creates a new Resources Type. 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-resources-types-typeId path: /orgs/{orgId}/resources/types/{typeId} operations: - name: deleteresourcetype method: DELETE description: Delete a Resource Type. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: typeId in: path type: string description: The Resource Type id. The type id should be provided as url encoded string. required: true - name: patchresourcetype method: PATCH description: Update a Resource Type. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: typeId in: path type: string description: The Resource Type id. The type id should be provided as url encoded string. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: updateresourcetype method: PUT description: Update a Resource Type. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: typeId in: path type: string description: The Resource Type id. The type id should be provided as url encoded string. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-resources-types-typeId-classes path: /orgs/{orgId}/resources/types/{typeId}/classes operations: - name: createresourceclass method: POST description: Creates a new resources class. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The organization ID. required: true - name: typeId in: path type: string description: The resource type. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-resources-types-typeId-classes-classId path: /orgs/{orgId}/resources/types/{typeId}/classes/{classId} operations: - name: getresourceclass method: GET description: Get resource class by ID. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The organization ID. required: true - name: typeId in: path type: string description: The resource type. required: true - name: classId in: path type: string description: The resource class ID. required: true - name: updateresourceclass method: PATCH description: Update a resource class description. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The organization ID. required: true - name: typeId in: path type: string description: The resource type ID. required: true - name: classId in: path type: string description: The resource class ID. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: deleteresourceclass method: DELETE description: Delete a resource class. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The organization ID. required: true - name: typeId in: path type: string description: The resource type. required: true - name: classId in: path type: string description: The resource class id. required: true - name: orgs-orgId-runtime-actions-check-connectivity path: /orgs/{orgId}/runtime/actions/check-connectivity operations: - name: checkclusterconnectivity method: POST description: Provision and check the cluster connectivity in 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-secretstores path: /orgs/{orgId}/secretstores operations: - name: get method: GET description: Get list of Secret Stores for the given organization. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: post method: POST description: Create a Secret Store for the given 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-secretstores-storeId path: /orgs/{orgId}/secretstores/{storeId} operations: - name: get method: GET description: Get the Secret Store. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: storeId in: path type: string description: The Secret Store ID. required: true - name: delete method: DELETE description: Delete the Secret Store. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: storeId in: path type: string description: The Secret Store ID. required: true - name: patch method: PATCH description: Update the Secret Store. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: orgId in: path type: string description: The Organization ID. required: true - name: storeId in: path type: string description: The Secret Store ID. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-users path: /orgs/{orgId}/users operations: - name: listuserrolesinorg method: GET description: List Users and Groups with roles in an Organization outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createserviceuserinorg method: POST description: Creates a new service user. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-users-userId path: /orgs/{orgId}/users/{userId} operations: - name: getuserroleinorg method: GET description: Get the role of a User or a Group on an Organization outputRawFormat: json outputParameters: - name: result type: object value: $. - name: deleteuserroleinorg method: DELETE description: Remove the role of a User or a Group on an Organization outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updateuserroleinorg method: PATCH description: Update the role of a User or a Group on 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-users-userId-groups path: /orgs/{orgId}/users/{userId}/groups operations: - name: listusergroupsinorg method: GET description: Get the groups in an organization a user belongs to. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-users-userId-perms path: /orgs/{orgId}/users/{userId}/perms operations: - name: getsubjectpermsinorg method: GET description: Get the permissions of a User or Group on the objects in an Organization outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-workload-profile-chart-versions path: /orgs/{orgId}/workload-profile-chart-versions operations: - name: createworkloadprofilechartversion method: POST description: Add new Workload Profile Chart Version outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: listworkloadprofilechartversions method: GET description: Workload Profile Chart Versions for the given organization. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: query type: string description: Filter Chart Versions by Chart Version ID. - name: version in: query type: string description: Filter Chart Versions by Chart Version. - name: orgs-orgId-workload-profile-features path: /orgs/{orgId}/workload-profile-features operations: - name: listworkloadprofilefeatures method: GET description: List workload profile features available to the organization. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-workload-profiles path: /orgs/{orgId}/workload-profiles operations: - name: listworkloadprofiles method: GET description: List workload profiles available to the organization. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: createworkloadprofile method: POST description: Create new Workload Profile outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: orgs-orgId-workload-profiles-profileQid path: /orgs/{orgId}/workload-profiles/{profileQid} operations: - name: getworkloadprofile method: GET description: Get a Workload Profile outputRawFormat: json outputParameters: - name: result type: object value: $. - name: updateworkloadprofile method: PUT description: Update a Workload Profile outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: body in: body type: object description: Request body (JSON). required: true - name: deleteworkloadprofile method: DELETE description: Delete a Workload Profile outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-workload-profiles-profileQid-versions path: /orgs/{orgId}/workload-profiles/{profileQid}/versions operations: - name: listworkloadprofileversions method: GET description: List versions of the given workload profile. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: orgs-orgId-workload-profiles-profileQid-versions-latest path: /orgs/{orgId}/workload-profiles/{profileQid}/versions/latest operations: - name: getlatestworkloadprofileversion method: GET description: Latest version of the given workload profile with optional constraint. outputRawFormat: json outputParameters: - name: result type: object value: $. - name: users-userId-tokens path: /users/{userId}/tokens operations: - name: listusertokens method: GET description: Lists tokens associated with a user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: userId in: path type: string description: The user ID. required: true - name: createusertoken method: POST description: Creates a new static token for a user. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: userId in: path type: string description: The user ID. required: true - name: body in: body type: object description: Request body (JSON). required: true - name: users-userId-tokens-tokenId path: /users/{userId}/tokens/{tokenId} operations: - name: getusertoken method: GET description: Gets a specific token associated with a user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: userId in: path type: string description: The user ID. required: true - name: tokenId in: path type: string description: The token ID. required: true - name: deleteusertoken method: DELETE description: Deletes a specific token associated with a user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: userId in: path type: string description: The user ID. required: true - name: tokenId in: path type: string description: The token ID. required: true exposes: - type: rest namespace: humanitec-public-rest port: 8080 description: REST adapter for Humanitec API — public. One Spectral-compliant resource per consumed operation, prefixed with /v1. resources: - path: /v1/current-user name: current-user description: REST surface for current-user. operations: - method: GET name: getcurrentuser description: Gets the extended profile of the current user call: humanitec-public.getcurrentuser outputParameters: - type: object mapping: $. - method: PATCH name: updatecurrentuser description: Updates the extended profile of the current user. call: humanitec-public.updatecurrentuser with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs name: orgs description: REST surface for orgs. operations: - method: GET name: listorganizations description: List active organizations the user has access to. call: humanitec-public.listorganizations outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid} name: orgs-orgid description: REST surface for orgs-orgId. operations: - method: GET name: getorganization description: Get the specified Organization. call: humanitec-public.getorganization outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/agents name: orgs-orgid-agents description: REST surface for orgs-orgId-agents. operations: - method: POST name: createagent description: Register a new Agent under an Organization. call: humanitec-public.createagent with: body: rest.body outputParameters: - type: object mapping: $. - method: GET name: listagents description: List all the agents in an Organization. call: humanitec-public.listagents outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/agents/{agentid} name: orgs-orgid-agents-agentid description: REST surface for orgs-orgId-agents-agentId. operations: - method: DELETE name: deleteagent description: Delete an Agent (and its keys) stored under an Organization. call: humanitec-public.deleteagent outputParameters: - type: object mapping: $. - method: PATCH name: patchagent description: Update the description of an Agent. call: humanitec-public.patchagent with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/agents/{agentid}/keys name: orgs-orgid-agents-agentid-keys description: REST surface for orgs-orgId-agents-agentId-keys. operations: - method: GET name: listkeysinagent description: List all the keys registered under an Agent in an Organization. call: humanitec-public.listkeysinagent outputParameters: - type: object mapping: $. - method: POST name: createkey description: Register a new Key under an Agent in an Organization. call: humanitec-public.createkey with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/agents/{agentid}/keys/{fingerprint} name: orgs-orgid-agents-agentid-keys-fingerprint description: REST surface for orgs-orgId-agents-agentId-keys-fingerprint. operations: - method: DELETE name: deletekeyinagent description: Delete a key registered under a Agent. call: humanitec-public.deletekeyinagent outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps name: orgs-orgid-apps description: REST surface for orgs-orgId-apps. operations: - method: GET name: listapplications description: List all Applications in an Organization. call: humanitec-public.listapplications with: orgId: rest.orgId outputParameters: - type: object mapping: $. - method: POST name: createapplication description: Add a new Application to an Organization call: humanitec-public.createapplication with: orgId: rest.orgId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid} name: orgs-orgid-apps-appid description: REST surface for orgs-orgId-apps-appId. operations: - method: GET name: getapplication description: Get an existing Application call: humanitec-public.getapplication with: orgId: rest.orgId appId: rest.appId outputParameters: - type: object mapping: $. - method: PATCH name: patchapplication description: Update metadata of an existing Application call: humanitec-public.patchapplication with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deleteapplication description: Delete an Application call: humanitec-public.deleteapplication with: orgId: rest.orgId appId: rest.appId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/approvals name: orgs-orgid-apps-appid-approvals description: REST surface for orgs-orgId-apps-appId-approvals. operations: - method: GET name: listpipelineapprovalrequests description: List of the approval requests call: humanitec-public.listpipelineapprovalrequests outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/deltas name: orgs-orgid-apps-appid-deltas description: REST surface for orgs-orgId-apps-appId-deltas. operations: - method: GET name: listdeltas description: List Deltas in an Application call: humanitec-public.listdeltas with: archived: rest.archived env: rest.env outputParameters: - type: object mapping: $. - method: POST name: createdelta description: Create a new Delta call: humanitec-public.createdelta with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/deltas/{deltaid} name: orgs-orgid-apps-appid-deltas-deltaid description: REST surface for orgs-orgId-apps-appId-deltas-deltaId. operations: - method: GET name: getdelta description: Fetch an existing Delta call: humanitec-public.getdelta with: deltaId: rest.deltaId outputParameters: - type: object mapping: $. - method: PATCH name: patchdelta description: Update an existing Delta call: humanitec-public.patchdelta with: deltaId: rest.deltaId body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: putdelta description: Update an existing Delta call: humanitec-public.putdelta with: deltaId: rest.deltaId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/deltas/{deltaid}/metadata/archived name: orgs-orgid-apps-appid-deltas-deltaid-metadata-archived description: REST surface for orgs-orgId-apps-appId-deltas-deltaId-metadata-archived. operations: - method: PUT name: archivedelta description: Mark a Delta as "archived" call: humanitec-public.archivedelta with: deltaId: rest.deltaId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/deltas/{deltaid}/metadata/env-id name: orgs-orgid-apps-appid-deltas-deltaid-metadata-env-id description: REST surface for orgs-orgId-apps-appId-deltas-deltaId-metadata-env_id. operations: - method: PUT name: changeenvofdelta description: Change the Environment of a Delta call: humanitec-public.changeenvofdelta with: deltaId: rest.deltaId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/deltas/{deltaid}/metadata/name name: orgs-orgid-apps-appid-deltas-deltaid-metadata-name description: REST surface for orgs-orgId-apps-appId-deltas-deltaId-metadata-name. operations: - method: PUT name: changenameofdelta description: Change the name of a Delta call: humanitec-public.changenameofdelta with: deltaId: rest.deltaId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs name: orgs-orgid-apps-appid-envs description: REST surface for orgs-orgId-apps-appId-envs. operations: - method: GET name: listenvironments description: List all Environments. call: humanitec-public.listenvironments with: orgId: rest.orgId appId: rest.appId outputParameters: - type: object mapping: $. - method: POST name: createenvironment description: Add a new Environment to an Application. call: humanitec-public.createenvironment with: orgId: rest.orgId appId: rest.appId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid} name: orgs-orgid-apps-appid-envs-envid description: REST surface for orgs-orgId-apps-appId-envs-envId. operations: - method: GET name: getenvironment description: Get a specific Environment. call: humanitec-public.getenvironment with: orgId: rest.orgId appId: rest.appId envId: rest.envId outputParameters: - type: object mapping: $. - method: PATCH name: updateenvironment description: Update a specific Environment. call: humanitec-public.updateenvironment with: orgId: rest.orgId appId: rest.appId envId: rest.envId body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deleteenvironment description: Delete a specific Environment. call: humanitec-public.deleteenvironment with: orgId: rest.orgId appId: rest.appId envId: rest.envId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/deploys name: orgs-orgid-apps-appid-envs-envid-deploys description: REST surface for orgs-orgId-apps-appId-envs-envId-deploys. operations: - method: GET name: listdeployments description: List Deployments in an Environment. call: humanitec-public.listdeployments with: orgId: rest.orgId appId: rest.appId envId: rest.envId pipelineRunId: rest.pipelineRunId outputParameters: - type: object mapping: $. - method: POST name: createdeployment description: Start a new Deployment. call: humanitec-public.createdeployment with: orgId: rest.orgId appId: rest.appId envId: rest.envId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/deploys/{deployid} name: orgs-orgid-apps-appid-envs-envid-deploys-deployid description: REST surface for orgs-orgId-apps-appId-envs-envId-deploys-deployId. operations: - method: GET name: getdeployment description: Get a specific Deployment. call: humanitec-public.getdeployment with: orgId: rest.orgId appId: rest.appId envId: rest.envId deployId: rest.deployId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/deploys/{deployid}/errors name: orgs-orgid-apps-appid-envs-envid-deploys-deployid-errors description: REST surface for orgs-orgId-apps-appId-envs-envId-deploys-deployId-errors. operations: - method: GET name: listdeploymenterrors description: List errors that occurred in a Deployment. call: humanitec-public.listdeploymenterrors with: orgId: rest.orgId appId: rest.appId envId: rest.envId deployId: rest.deployId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/from-deploy-id name: orgs-orgid-apps-appid-envs-envid-from-deploy-id description: REST surface for orgs-orgId-apps-appId-envs-envId-from_deploy_id. operations: - method: PUT name: rebaseenvironment description: Rebase to a different Deployment. call: humanitec-public.rebaseenvironment with: orgId: rest.orgId appId: rest.appId envId: rest.envId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/logs name: orgs-orgid-apps-appid-envs-envid-logs description: REST surface for orgs-orgId-apps-appId-envs-envId-logs. operations: - method: GET name: get description: Get container log entries for the environment call: humanitec-public.get with: orgId: rest.orgId appId: rest.appId envId: rest.envId workload_id: rest.workload_id container_id: rest.container_id deployment_id: rest.deployment_id timestamp_from: rest.timestamp_from timestamp_to: rest.timestamp_to limit: rest.limit asc: rest.asc invert: rest.invert outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/resources name: orgs-orgid-apps-appid-envs-envid-resources description: REST surface for orgs-orgId-apps-appId-envs-envId-resources. operations: - method: GET name: listactiveresources description: List Active Resources provisioned in an environment. call: humanitec-public.listactiveresources with: orgId: rest.orgId appId: rest.appId envId: rest.envId scheduled_deletion: rest.scheduled_deletion outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/resources/graph name: orgs-orgid-apps-appid-envs-envid-resources-graph description: REST surface for orgs-orgId-apps-appId-envs-envId-resources-graph. operations: - method: POST name: queryresourcegraph description: Lists the resource objects that hold the information needed to provision the resources specified in the request and the resources they depend on. call: humanitec-public.queryresourcegraph with: orgId: rest.orgId appId: rest.appId envId: rest.envId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/resources/graphs name: orgs-orgid-apps-appid-envs-envid-resources-graphs description: REST surface for orgs-orgId-apps-appId-envs-envId-resources-graphs. operations: - method: POST name: createdependencygraph 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. call: humanitec-public.createdependencygraph with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/resources/graphs/{graphid} name: orgs-orgid-apps-appid-envs-envid-resources-graphs-graphid description: REST surface for orgs-orgId-apps-appId-envs-envId-resources-graphs-graphId. operations: - method: GET name: getdependencygraph description: Retrieve a Dependency Graph by its ID. call: humanitec-public.getdependencygraph outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/resources/{type}/{resid} name: orgs-orgid-apps-appid-envs-envid-resources-type-resid description: REST surface for orgs-orgId-apps-appId-envs-envId-resources-type-resId. operations: - method: DELETE name: deleteactiveresource description: Delete Active Resource. call: humanitec-public.deleteactiveresource with: orgId: rest.orgId appId: rest.appId envId: rest.envId type: rest.type resId: rest.resId detach: rest.detach outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/resources/{type}/{resid}/actions/pin name: orgs-orgid-apps-appid-envs-envid-resources-type-resid-actions-pin description: REST surface for orgs-orgId-apps-appId-envs-envId-resources-type-resId-actions-pin. operations: - method: POST name: pinactiveresource description: Pin Active Resource to a target Resource Definition Version. call: humanitec-public.pinactiveresource with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/rules name: orgs-orgid-apps-appid-envs-envid-rules description: REST surface for orgs-orgId-apps-appId-envs-envId-rules. operations: - method: GET name: listautomationrules description: List all Automation Rules in an Environment. call: humanitec-public.listautomationrules outputParameters: - type: object mapping: $. - method: POST name: createautomationrule description: Create a new Automation Rule for an Environment. call: humanitec-public.createautomationrule with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/rules/{ruleid} name: orgs-orgid-apps-appid-envs-envid-rules-ruleid description: REST surface for orgs-orgId-apps-appId-envs-envId-rules-ruleId. operations: - method: GET name: getautomationrule description: Get a specific Automation Rule for an Environment. call: humanitec-public.getautomationrule with: ruleId: rest.ruleId outputParameters: - type: object mapping: $. - method: PUT name: updateautomationrule description: Update an existing Automation Rule for an Environment. call: humanitec-public.updateautomationrule with: ruleId: rest.ruleId body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deleteautomationrule description: Delete Automation Rule from an Environment. call: humanitec-public.deleteautomationrule with: ruleId: rest.ruleId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/runtime name: orgs-orgid-apps-appid-envs-envid-runtime description: REST surface for orgs-orgId-apps-appId-envs-envId-runtime. operations: - method: GET name: getruntime description: Get Runtime information about the environment. call: humanitec-public.getruntime outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/runtime/paused name: orgs-orgid-apps-appid-envs-envid-runtime-paused description: REST surface for orgs-orgId-apps-appId-envs-envId-runtime-paused. operations: - method: PUT name: updatepaused description: Pause / Resume an environment. call: humanitec-public.updatepaused with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/runtime/replicas name: orgs-orgid-apps-appid-envs-envid-runtime-replicas description: REST surface for orgs-orgId-apps-appId-envs-envId-runtime-replicas. operations: - method: PATCH name: patchreplicas description: Set number of replicas for an environment's modules. call: humanitec-public.patchreplicas with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/value-set-versions name: orgs-orgid-apps-appid-envs-envid-value-set-versions description: REST surface for orgs-orgId-apps-appId-envs-envId-value-set-versions. operations: - method: GET name: get description: List Value Set Versions in an Environment of an App call: humanitec-public.get with: orgId: rest.orgId appId: rest.appId envId: rest.envId key_changed: rest.key_changed outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/value-set-versions/{valuesetversionid} name: orgs-orgid-apps-appid-envs-envid-value-set-versions-valuesetversionid description: REST surface for orgs-orgId-apps-appId-envs-envId-value-set-versions-valueSetVersionId. operations: - method: GET name: 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. call: humanitec-public.get with: orgId: rest.orgId appId: rest.appId envId: rest.envId valueSetVersionId: rest.valueSetVersionId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/value-set-versions/{valuesetversionid}/purge/{key} name: orgs-orgid-apps-appid-envs-envid-value-set-versions-valuesetversionid-purge-key description: REST surface for orgs-orgId-apps-appId-envs-envId-value-set-versions-valueSetVersionId-purge-key. operations: - method: POST name: post description: Purge the value of a specific Shared Value from the App Environment Version history. call: humanitec-public.post with: orgId: rest.orgId appId: rest.appId envId: rest.envId valueSetVersionId: rest.valueSetVersionId key: rest.key body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/value-set-versions/{valuesetversionid}/restore name: orgs-orgid-apps-appid-envs-envid-value-set-versions-valuesetversionid-restore description: REST surface for orgs-orgId-apps-appId-envs-envId-value-set-versions-valueSetVersionId-restore. operations: - method: POST name: post description: Restore a Value Set Version in an Environment of an App call: humanitec-public.post with: orgId: rest.orgId appId: rest.appId envId: rest.envId valueSetVersionId: rest.valueSetVersionId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/value-set-versions/{valuesetversionid}/restore/{key} name: orgs-orgid-apps-appid-envs-envid-value-set-versions-valuesetversionid-restore-ke description: REST surface for orgs-orgId-apps-appId-envs-envId-value-set-versions-valueSetVersionId-restore-ke. operations: - method: POST name: post description: Restore a specific key from the Value Set Version in an Environment of an App call: humanitec-public.post with: orgId: rest.orgId appId: rest.appId envId: rest.envId valueSetVersionId: rest.valueSetVersionId key: rest.key body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/values name: orgs-orgid-apps-appid-envs-envid-values description: REST surface for orgs-orgId-apps-appId-envs-envId-values. operations: - method: GET name: get description: List Shared Values in an Environment call: humanitec-public.get with: orgId: rest.orgId appId: rest.appId envId: rest.envId outputParameters: - type: object mapping: $. - method: POST name: post description: Create a Shared Value for an Environment call: humanitec-public.post with: orgId: rest.orgId appId: rest.appId envId: rest.envId body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: delete description: Delete all Shared Value for an Environment call: humanitec-public.delete with: orgId: rest.orgId appId: rest.appId envId: rest.envId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/envs/{envid}/values/{key} name: orgs-orgid-apps-appid-envs-envid-values-key description: REST surface for orgs-orgId-apps-appId-envs-envId-values-key. operations: - method: PUT name: put description: Update Shared Value for an Environment call: humanitec-public.put with: orgId: rest.orgId appId: rest.appId envId: rest.envId key: rest.key body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: delete description: Delete Shared Value for an Environment call: humanitec-public.delete with: orgId: rest.orgId appId: rest.appId envId: rest.envId key: rest.key outputParameters: - type: object mapping: $. - method: PATCH name: patch description: Update Shared Value for an Environment call: humanitec-public.patch with: orgId: rest.orgId appId: rest.appId envId: rest.envId key: rest.key body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/jobs name: orgs-orgid-apps-appid-jobs description: REST surface for orgs-orgId-apps-appId-jobs. operations: - method: DELETE name: delete description: Deletes all Jobs for the Application call: humanitec-public.delete with: orgId: rest.orgId appId: rest.appId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/pipeline-criteria name: orgs-orgid-apps-appid-pipeline-criteria description: REST surface for orgs-orgId-apps-appId-pipeline-criteria. operations: - method: GET name: listpipelinecriteriainapp description: List the trigger matching criteria defined for Pipelines in this Application. call: humanitec-public.listpipelinecriteriainapp with: pipeline: rest.pipeline match: rest.match outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/pipeline-runs name: orgs-orgid-apps-appid-pipeline-runs description: REST surface for orgs-orgId-apps-appId-pipeline-runs. operations: - method: POST name: createpipelinerunbytriggercriteria description: Create a Pipeline Run in the appropriate Pipeline based on the trigger and inputs. call: humanitec-public.createpipelinerunbytriggercriteria with: dry_run: rest.dry_run body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/pipelines name: orgs-orgid-apps-appid-pipelines description: REST surface for orgs-orgId-apps-appId-pipelines. operations: - method: GET name: listpipelines description: List Pipelines within an Application. call: humanitec-public.listpipelines outputParameters: - type: object mapping: $. - method: POST name: createpipeline description: Create a Pipeline within an Application. call: humanitec-public.createpipeline with: dry_run: rest.dry_run body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid} name: orgs-orgid-apps-appid-pipelines-pipelineid description: REST surface for orgs-orgId-apps-appId-pipelines-pipelineId. operations: - method: GET name: getpipeline description: Get a Pipeline within an Application. call: humanitec-public.getpipeline outputParameters: - type: object mapping: $. - method: PATCH name: updatepipeline description: update a Pipeline within an Application. call: humanitec-public.updatepipeline with: dry_run: rest.dry_run body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deletepipeline description: Delete a pipeline within an application. call: humanitec-public.deletepipeline outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/batches/{batchtype} name: orgs-orgid-apps-appid-pipelines-pipelineid-batches-batchtype description: REST surface for orgs-orgId-apps-appId-pipelines-pipelineId-batches-batchType. operations: - method: GET name: getbatch description: Read the current state of a trigger batch call: humanitec-public.getbatch outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/criteria name: orgs-orgid-apps-appid-pipelines-pipelineid-criteria description: REST surface for orgs-orgId-apps-appId-pipelines-pipelineId-criteria. operations: - method: POST name: createpipelinecriteria description: Create a new trigger matching criteria for this Pipeline. call: humanitec-public.createpipelinecriteria with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/criteria/{criteriaid} name: orgs-orgid-apps-appid-pipelines-pipelineid-criteria-criteriaid description: REST surface for orgs-orgId-apps-appId-pipelines-pipelineId-criteria-criteriaId. operations: - method: GET name: getpipelinecriteria description: Get the Pipeline Criteria with the given id. call: humanitec-public.getpipelinecriteria with: criteriaId: rest.criteriaId outputParameters: - type: object mapping: $. - method: DELETE name: deletepipelinecriteria description: Delete the Pipeline Criteria with the given id. call: humanitec-public.deletepipelinecriteria with: criteriaId: rest.criteriaId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/runs name: orgs-orgid-apps-appid-pipelines-pipelineid-runs description: REST surface for orgs-orgId-apps-appId-pipelines-pipelineId-runs. operations: - method: GET name: listpipelineruns description: List runs within a pipeline ordered newest to oldest. call: humanitec-public.listpipelineruns outputParameters: - type: object mapping: $. - method: POST name: createpipelinerun description: Create a run within a pipeline. call: humanitec-public.createpipelinerun with: dry_run: rest.dry_run body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/runs/{runid} name: orgs-orgid-apps-appid-pipelines-pipelineid-runs-runid description: REST surface for orgs-orgId-apps-appId-pipelines-pipelineId-runs-runId. operations: - method: GET name: getpipelinerun description: Get a run within an pipeline. call: humanitec-public.getpipelinerun outputParameters: - type: object mapping: $. - method: DELETE name: deletepipelinerun description: Deleting a completed Run within a Pipeline. call: humanitec-public.deletepipelinerun outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/runs/{runid}/cancel name: orgs-orgid-apps-appid-pipelines-pipelineid-runs-runid-cancel description: REST surface for orgs-orgId-apps-appId-pipelines-pipelineId-runs-runId-cancel. operations: - method: POST name: cancelpipelinerun description: Cancel a Run within an Pipeline. call: humanitec-public.cancelpipelinerun outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/runs/{runid}/jobs name: orgs-orgid-apps-appid-pipelines-pipelineid-runs-runid-jobs description: REST surface for orgs-orgId-apps-appId-pipelines-pipelineId-runs-runId-jobs. operations: - method: GET name: listpipelinejobs description: List the details of the jobs within a pipeline run. call: humanitec-public.listpipelinejobs outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/runs/{runid}/jobs/{jobid} name: orgs-orgid-apps-appid-pipelines-pipelineid-runs-runid-jobs-jobid description: REST surface for orgs-orgId-apps-appId-pipelines-pipelineId-runs-runId-jobs-jobId. operations: - method: GET name: getpipelinejob description: List the details of a Job including Step information call: humanitec-public.getpipelinejob outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/runs/{runid}/jobs/{jobid}/approvals/{approvalid} name: orgs-orgid-apps-appid-pipelines-pipelineid-runs-runid-jobs-jobid-approvals-appro description: REST surface for orgs-orgId-apps-appId-pipelines-pipelineId-runs-runId-jobs-jobId-approvals-appro. operations: - method: GET name: getpipelineapprovalrequest description: Get an approval request call: humanitec-public.getpipelineapprovalrequest outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/runs/{runid}/jobs/{jobid}/approvals/{approvalid}/approve name: orgs-orgid-apps-appid-pipelines-pipelineid-runs-runid-jobs-jobid-approvals-appro description: REST surface for orgs-orgId-apps-appId-pipelines-pipelineId-runs-runId-jobs-jobId-approvals-appro. operations: - method: POST name: approvepipelineapprovalrequest description: Approve the approval request call: humanitec-public.approvepipelineapprovalrequest outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/runs/{runid}/jobs/{jobid}/approvals/{approvalid}/deny name: orgs-orgid-apps-appid-pipelines-pipelineid-runs-runid-jobs-jobid-approvals-appro description: REST surface for orgs-orgId-apps-appId-pipelines-pipelineId-runs-runId-jobs-jobId-approvals-appro. operations: - method: POST name: denypipelineapprovalrequest description: Deny the approval request call: humanitec-public.denypipelineapprovalrequest outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/runs/{runid}/jobs/{jobid}/steps/{stepindex}/logs name: orgs-orgid-apps-appid-pipelines-pipelineid-runs-runid-jobs-jobid-steps-stepindex description: REST surface for orgs-orgId-apps-appId-pipelines-pipelineId-runs-runId-jobs-jobId-steps-stepIndex. operations: - method: GET name: listpipelinesteplogs description: Get a page of log output for a given step within a job. call: humanitec-public.listpipelinesteplogs outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/runs/{runid}/restart name: orgs-orgid-apps-appid-pipelines-pipelineid-runs-runid-restart description: REST surface for orgs-orgId-apps-appId-pipelines-pipelineId-runs-runId-restart. operations: - method: POST name: restartpipelinerun description: Restart a Run within an Pipeline by cloning it with the same trigger and inputs. call: humanitec-public.restartpipelinerun outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/schema name: orgs-orgid-apps-appid-pipelines-pipelineid-schema description: REST surface for orgs-orgId-apps-appId-pipelines-pipelineId-schema. operations: - method: GET name: getpipelinedefinition description: Get a pipeline schema. call: humanitec-public.getpipelinedefinition with: Accept: rest.Accept outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/pipelines/{pipelineid}/versions name: orgs-orgid-apps-appid-pipelines-pipelineid-versions description: REST surface for orgs-orgId-apps-appId-pipelines-pipelineId-versions. operations: - method: GET name: listpipelineversions description: List all versions of the pipeline call: humanitec-public.listpipelineversions outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/runtime name: orgs-orgid-apps-appid-runtime description: REST surface for orgs-orgId-apps-appId-runtime. operations: - method: GET name: listruntime description: Get Runtime information about specific multiple environments. call: humanitec-public.listruntime with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/sets name: orgs-orgid-apps-appid-sets description: REST surface for orgs-orgId-apps-appId-sets. operations: - method: GET name: listsets description: Get all Deployment Sets call: humanitec-public.listsets outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/sets/{setid} name: orgs-orgid-apps-appid-sets-setid description: REST surface for orgs-orgId-apps-appId-sets-setId. operations: - method: GET name: getset description: Get a Deployment Set call: humanitec-public.getset with: setId: rest.setId diff: rest.diff outputParameters: - type: object mapping: $. - method: POST name: updateset description: Apply a Deployment Delta to a Deployment Set call: humanitec-public.updateset with: setId: rest.setId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/sets/{setid}/diff/{sourcesetid} name: orgs-orgid-apps-appid-sets-setid-diff-sourcesetid description: REST surface for orgs-orgId-apps-appId-sets-setId-diff-sourceSetId. operations: - method: GET name: getdiff description: Get the difference between 2 Deployment Sets call: humanitec-public.getdiff with: setId: rest.setId sourceSetId: rest.sourceSetId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/sets/{setid}/resources name: orgs-orgid-apps-appid-sets-setid-resources description: REST surface for orgs-orgId-apps-appId-sets-setId-resources. operations: - method: GET name: getsetresourceinputs description: Get Resource Inputs for the given Deployment Set call: humanitec-public.getsetresourceinputs with: setId: rest.setId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/users name: orgs-orgid-apps-appid-users description: REST surface for orgs-orgId-apps-appId-users. operations: - method: GET name: listuserrolesinapp description: List Users or Groups with roles in an App call: humanitec-public.listuserrolesinapp outputParameters: - type: object mapping: $. - method: POST name: createuserroleinapp description: Adds a User or a Group to an Application with a Role call: humanitec-public.createuserroleinapp with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/users/{userid} name: orgs-orgid-apps-appid-users-userid description: REST surface for orgs-orgId-apps-appId-users-userId. operations: - method: GET name: getuserroleinapp description: Get the role of a User or a Group on an Application call: humanitec-public.getuserroleinapp outputParameters: - type: object mapping: $. - method: DELETE name: deleteuserroleinapp description: Remove the role of a User or a Group on an Application call: humanitec-public.deleteuserroleinapp outputParameters: - type: object mapping: $. - method: PATCH name: updateuserroleinapp description: Update the role of a User or a Group on an Application call: humanitec-public.updateuserroleinapp with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/value-set-versions name: orgs-orgid-apps-appid-value-set-versions description: REST surface for orgs-orgId-apps-appId-value-set-versions. operations: - method: GET name: get description: List Value Set Versions in the App call: humanitec-public.get with: orgId: rest.orgId appId: rest.appId key_changed: rest.key_changed outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/value-set-versions/{valuesetversionid} name: orgs-orgid-apps-appid-value-set-versions-valuesetversionid description: REST surface for orgs-orgId-apps-appId-value-set-versions-valueSetVersionId. operations: - method: GET name: get description: Get a single Value Set Version from the App call: humanitec-public.get with: orgId: rest.orgId appId: rest.appId valueSetVersionId: rest.valueSetVersionId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/value-set-versions/{valuesetversionid}/purge/{key} name: orgs-orgid-apps-appid-value-set-versions-valuesetversionid-purge-key description: REST surface for orgs-orgId-apps-appId-value-set-versions-valueSetVersionId-purge-key. operations: - method: POST name: post description: Purge the value of a specific Shared Value from the App Version history. call: humanitec-public.post with: orgId: rest.orgId appId: rest.appId valueSetVersionId: rest.valueSetVersionId key: rest.key body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/value-set-versions/{valuesetversionid}/restore name: orgs-orgid-apps-appid-value-set-versions-valuesetversionid-restore description: REST surface for orgs-orgId-apps-appId-value-set-versions-valueSetVersionId-restore. operations: - method: POST name: post description: Restore a Value Set Version in an App call: humanitec-public.post with: orgId: rest.orgId appId: rest.appId valueSetVersionId: rest.valueSetVersionId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/value-set-versions/{valuesetversionid}/restore/{key} name: orgs-orgid-apps-appid-value-set-versions-valuesetversionid-restore-key description: REST surface for orgs-orgId-apps-appId-value-set-versions-valueSetVersionId-restore-key. operations: - method: POST name: post description: Restore a specific key from the Value Set Version in an App call: humanitec-public.post with: orgId: rest.orgId appId: rest.appId valueSetVersionId: rest.valueSetVersionId key: rest.key body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/values name: orgs-orgid-apps-appid-values description: REST surface for orgs-orgId-apps-appId-values. operations: - method: GET name: get description: List Shared Values in an Application call: humanitec-public.get with: orgId: rest.orgId appId: rest.appId outputParameters: - type: object mapping: $. - method: POST name: post description: Create a Shared Value for an Application call: humanitec-public.post with: orgId: rest.orgId appId: rest.appId body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: delete description: Delete all Shared Value for an App call: humanitec-public.delete with: orgId: rest.orgId appId: rest.appId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/values/{key} name: orgs-orgid-apps-appid-values-key description: REST surface for orgs-orgId-apps-appId-values-key. operations: - method: PUT name: put description: Update Shared Value for an Application call: humanitec-public.put with: orgId: rest.orgId appId: rest.appId key: rest.key body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: delete description: Delete Shared Value for an Application call: humanitec-public.delete with: orgId: rest.orgId appId: rest.appId key: rest.key outputParameters: - type: object mapping: $. - method: PATCH name: patch description: Update Shared Value for an Application call: humanitec-public.patch with: orgId: rest.orgId appId: rest.appId key: rest.key body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/webhooks name: orgs-orgid-apps-appid-webhooks description: REST surface for orgs-orgId-apps-appId-webhooks. operations: - method: GET name: get description: List Webhooks call: humanitec-public.get with: orgId: rest.orgId appId: rest.appId outputParameters: - type: object mapping: $. - method: POST name: post description: Create a new Webhook call: humanitec-public.post with: orgId: rest.orgId appId: rest.appId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/apps/{appid}/webhooks/{jobid} name: orgs-orgid-apps-appid-webhooks-jobid description: REST surface for orgs-orgId-apps-appId-webhooks-jobId. operations: - method: GET name: get description: Get a Webhook call: humanitec-public.get with: orgId: rest.orgId appId: rest.appId jobId: rest.jobId outputParameters: - type: object mapping: $. - method: DELETE name: delete description: Delete a Webhook call: humanitec-public.delete with: orgId: rest.orgId appId: rest.appId jobId: rest.jobId outputParameters: - type: object mapping: $. - method: PATCH name: patch description: Update a Webhook call: humanitec-public.patch with: orgId: rest.orgId appId: rest.appId jobId: rest.jobId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/artefact-versions name: orgs-orgid-artefact-versions description: REST surface for orgs-orgId-artefact-versions. operations: - method: GET name: listartefactversionsinorg description: List all Artefacts Versions in the org. call: humanitec-public.listartefactversionsinorg with: orgId: rest.orgId name: rest.name reference: rest.reference archived: rest.archived type: rest.type outputParameters: - type: object mapping: $. - method: POST name: createartefactversion description: Register a new Artefact Version with your organization. call: humanitec-public.createartefactversion with: orgId: rest.orgId vcs: rest.vcs dry_run: rest.dry_run Accept: rest.Accept body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/artefact-versions/convert-score name: orgs-orgid-artefact-versions-convert-score description: REST surface for orgs-orgId-artefact-versions-convert-score. operations: - method: POST name: convertscoretoset description: Convert a Score specification, optional overrides, and extensions into the contents for a deployment set. call: humanitec-public.convertscoretoset with: orgId: rest.orgId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/artefact-versions/{artefactversionid} name: orgs-orgid-artefact-versions-artefactversionid description: REST surface for orgs-orgId-artefact-versions-artefactVersionId. operations: - method: GET name: getartefactversion description: Get an Artefacts Versions. call: humanitec-public.getartefactversion with: orgId: rest.orgId artefactVersionId: rest.artefactVersionId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/artefact-versions/{artefactversionid}/workload-deployment-set name: orgs-orgid-artefact-versions-artefactversionid-workload-deployment-set description: REST surface for orgs-orgId-artefact-versions-artefactVersionId-workload-deployment-set. operations: - method: GET name: getworkloadartefactversiondeploymentset description: Get the Humanitec module definition of this Workload Artefact Version as a deployment set call: humanitec-public.getworkloadartefactversiondeploymentset with: orgId: rest.orgId artefactVersionId: rest.artefactVersionId Accept: rest.Accept outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/artefact-versions/{artefactversionid}/workload-spec name: orgs-orgid-artefact-versions-artefactversionid-workload-spec description: REST surface for orgs-orgId-artefact-versions-artefactVersionId-workload-spec. operations: - method: GET name: getworkloadartefactversionspec description: Get the spec of this Workload Artefact Version call: humanitec-public.getworkloadartefactversionspec with: orgId: rest.orgId artefactVersionId: rest.artefactVersionId Accept: rest.Accept outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/artefacts name: orgs-orgid-artefacts description: REST surface for orgs-orgId-artefacts. operations: - method: GET name: listartefacts description: List all Artefacts. call: humanitec-public.listartefacts with: orgId: rest.orgId type: rest.type name: rest.name outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/artefacts/{artefactid} name: orgs-orgid-artefacts-artefactid description: REST surface for orgs-orgId-artefacts-artefactId. operations: - method: DELETE name: deleteartefact description: Delete Artefact and all related Artefact Versions call: humanitec-public.deleteartefact with: orgId: rest.orgId artefactId: rest.artefactId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/artefacts/{artefactid}/versions name: orgs-orgid-artefacts-artefactid-versions description: REST surface for orgs-orgId-artefacts-artefactId-versions. operations: - method: GET name: listartefactversions description: List all Artefact Versions of an Artefact. call: humanitec-public.listartefactversions with: orgId: rest.orgId artefactId: rest.artefactId archived: rest.archived reference: rest.reference limit: rest.limit outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/artefacts/{artefactid}/versions/{versionid} name: orgs-orgid-artefacts-artefactid-versions-versionid description: REST surface for orgs-orgId-artefacts-artefactId-versions-versionId. operations: - method: PATCH name: patchartefactversion description: Update Version of an Artefact. call: humanitec-public.patchartefactversion with: orgId: rest.orgId artefactId: rest.artefactId versionId: rest.versionId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/audit-logs name: orgs-orgid-audit-logs description: REST surface for orgs-orgId-audit-logs. operations: - method: GET name: listauditlogentries description: List audit log entries by Organization call: humanitec-public.listauditlogentries with: from: rest.from to: rest.to outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/env-types name: orgs-orgid-env-types description: REST surface for orgs-orgId-env-types. operations: - method: GET name: listenvironmenttypes description: List all Environment Types call: humanitec-public.listenvironmenttypes with: orgId: rest.orgId outputParameters: - type: object mapping: $. - method: POST name: createenvironmenttype description: Add a new Environment Type call: humanitec-public.createenvironmenttype with: orgId: rest.orgId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/env-types/{envtypeid} name: orgs-orgid-env-types-envtypeid description: REST surface for orgs-orgId-env-types-envTypeId. operations: - method: GET name: getenvironmenttype description: Get an Environment Type call: humanitec-public.getenvironmenttype with: orgId: rest.orgId envTypeId: rest.envTypeId outputParameters: - type: object mapping: $. - method: DELETE name: deleteenvironmenttype description: Deletes an Environment Type call: humanitec-public.deleteenvironmenttype with: orgId: rest.orgId envTypeId: rest.envTypeId outputParameters: - type: object mapping: $. - method: PATCH name: updateenvironmenttype description: Updates Environment Type call: humanitec-public.updateenvironmenttype with: orgId: rest.orgId envTypeId: rest.envTypeId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/env-types/{envtype}/users name: orgs-orgid-env-types-envtype-users description: REST surface for orgs-orgId-env-types-envType-users. operations: - method: GET name: listuserrolesinenvtype description: List Users and Groups with roles in an Environment Type call: humanitec-public.listuserrolesinenvtype outputParameters: - type: object mapping: $. - method: POST name: createuserroleinenvtype description: Adds a User or a Group to an Environment Type with a Role call: humanitec-public.createuserroleinenvtype with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/env-types/{envtype}/users/{userid} name: orgs-orgid-env-types-envtype-users-userid description: REST surface for orgs-orgId-env-types-envType-users-userId. operations: - method: GET name: getuserroleinenvtype description: Get the role of a User or a Group on an Environment Type call: humanitec-public.getuserroleinenvtype outputParameters: - type: object mapping: $. - method: DELETE name: deleteuserroleinenvtype description: Remove the role of a User or a Group on an Environment Type call: humanitec-public.deleteuserroleinenvtype outputParameters: - type: object mapping: $. - method: PATCH name: updateuserroleinenvtype description: Update the role of a User or a Group on an Environment Type call: humanitec-public.updateuserroleinenvtype with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/events name: orgs-orgid-events description: REST surface for orgs-orgId-events. operations: - method: GET name: get description: List Events call: humanitec-public.get with: orgId: rest.orgId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/groups name: orgs-orgid-groups description: REST surface for orgs-orgId-groups. operations: - method: POST name: creategroup description: Create a group in an organization call: humanitec-public.creategroup with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/groups/{groupid}/users name: orgs-orgid-groups-groupid-users description: REST surface for orgs-orgId-groups-groupId-users. operations: - method: GET name: listgroupusers description: List users in a group. call: humanitec-public.listgroupusers outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/humanitec-keys name: orgs-orgid-humanitec-keys description: REST surface for orgs-orgId-humanitec-keys. operations: - method: GET name: listhumanitecpublickeys description: List all the public keys Humanitec shares with an organization. call: humanitec-public.listhumanitecpublickeys with: orgId: rest.orgId active: rest.active outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/images name: orgs-orgid-images description: REST surface for orgs-orgId-images. operations: - method: GET name: listdeprecatedimages description: List all Container Images call: humanitec-public.listdeprecatedimages with: orgId: rest.orgId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/images/{imageid} name: orgs-orgid-images-imageid description: REST surface for orgs-orgId-images-imageId. operations: - method: GET name: getdeprecatedimage description: Get a specific Image Object call: humanitec-public.getdeprecatedimage with: orgId: rest.orgId imageId: rest.imageId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/images/{imageid}/builds name: orgs-orgid-images-imageid-builds description: REST surface for orgs-orgId-images-imageId-builds. operations: - method: GET name: listdeprecatedimagebuilds description: Lists all the Builds of an Image call: humanitec-public.listdeprecatedimagebuilds with: orgId: rest.orgId imageId: rest.imageId outputParameters: - type: object mapping: $. - method: POST name: createdeprecatedimagebuild description: Add a new Image Build call: humanitec-public.createdeprecatedimagebuild with: orgId: rest.orgId imageId: rest.imageId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/invitations name: orgs-orgid-invitations description: REST surface for orgs-orgId-invitations. operations: - method: GET name: listinvitesinorg description: List the invites issued for the organization. call: humanitec-public.listinvitesinorg outputParameters: - type: object mapping: $. - method: POST name: createinviteinorg description: Invites a user to an Organization with a specified role. call: humanitec-public.createinviteinorg with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/keys name: orgs-orgid-keys description: REST surface for orgs-orgId-keys. operations: - method: POST name: createpublickey description: Associate a new RSA public key to an organization. call: humanitec-public.createpublickey with: orgId: rest.orgId body: rest.body outputParameters: - type: object mapping: $. - method: GET name: listpublickeys description: List all public keys associated to an organization. call: humanitec-public.listpublickeys with: orgId: rest.orgId fingerprint: rest.fingerprint outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/keys/{keyid} name: orgs-orgid-keys-keyid description: REST surface for orgs-orgId-keys-keyId. operations: - method: DELETE name: deletepublickey description: Delete a public key associated to an organization. call: humanitec-public.deletepublickey with: orgId: rest.orgId keyId: rest.keyId outputParameters: - type: object mapping: $. - method: GET name: getpublickey description: Retrieve a single public key associated to an organization. call: humanitec-public.getpublickey with: orgId: rest.orgId keyId: rest.keyId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/pipeline-runs name: orgs-orgid-pipeline-runs description: REST surface for orgs-orgId-pipeline-runs. operations: - method: GET name: listpipelinerunsbyorg description: List all pipeline runs within the Org ordered newest to oldest. This can be filtered by app, pipeline, and status. call: humanitec-public.listpipelinerunsbyorg outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/pipeline-schemas/latest name: orgs-orgid-pipeline-schemas-latest description: REST surface for orgs-orgId-pipeline-schemas-latest. operations: - method: GET name: getlatestpipelinedefinitionschema description: Gets the latest pipeline schema call: humanitec-public.getlatestpipelinedefinitionschema outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/pipelines name: orgs-orgid-pipelines description: REST surface for orgs-orgId-pipelines. operations: - method: GET name: listpipelinesinorg description: List all Pipelines within an Organization. This can be filtered by Application. call: humanitec-public.listpipelinesinorg outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/registries name: orgs-orgid-registries description: REST surface for orgs-orgId-registries. operations: - method: GET name: get description: Lists available registries for the organization. call: humanitec-public.get with: orgId: rest.orgId outputParameters: - type: object mapping: $. - method: POST name: post description: Creates a new registry record. call: humanitec-public.post with: orgId: rest.orgId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/registries/{regid} name: orgs-orgid-registries-regid description: REST surface for orgs-orgId-registries-regId. operations: - method: GET name: get description: Loads a registry record details. call: humanitec-public.get with: orgId: rest.orgId regId: rest.regId outputParameters: - type: object mapping: $. - method: DELETE name: delete description: Deletes an existing registry record and all associated credentials and secrets. call: humanitec-public.delete with: orgId: rest.orgId regId: rest.regId outputParameters: - type: object mapping: $. - method: PATCH name: patch description: Updates (patches) an existing registry record. call: humanitec-public.patch with: orgId: rest.orgId regId: rest.regId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/registries/{regid}/creds name: orgs-orgid-registries-regid-creds description: REST surface for orgs-orgId-registries-regId-creds. operations: - method: GET name: get description: Returns current account credentials or secret details for the registry. call: humanitec-public.get with: orgId: rest.orgId regId: rest.regId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/resources/account-types name: orgs-orgid-resources-account-types description: REST surface for orgs-orgId-resources-account-types. operations: - method: GET name: listresourceaccounttypes description: List Resource Account Types available to the organization. call: humanitec-public.listresourceaccounttypes with: orgId: rest.orgId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/resources/accounts name: orgs-orgid-resources-accounts description: REST surface for orgs-orgId-resources-accounts. operations: - method: GET name: listresourceaccounts description: List Resource Accounts in the organization. call: humanitec-public.listresourceaccounts with: orgId: rest.orgId outputParameters: - type: object mapping: $. - method: POST name: createresourceaccount description: Create a new Resource Account in the organization. call: humanitec-public.createresourceaccount with: orgId: rest.orgId dry_run: rest.dry_run check_credential: rest.check_credential body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/resources/accounts/{accid} name: orgs-orgid-resources-accounts-accid description: REST surface for orgs-orgId-resources-accounts-accId. operations: - method: GET name: getresourceaccount description: Get a Resource Account. call: humanitec-public.getresourceaccount with: orgId: rest.orgId accId: rest.accId outputParameters: - type: object mapping: $. - method: DELETE name: deleteresourceaccount description: Delete an unused Resource Account. call: humanitec-public.deleteresourceaccount with: orgId: rest.orgId accId: rest.accId outputParameters: - type: object mapping: $. - method: PATCH name: patchresourceaccount description: Update a Resource Account. call: humanitec-public.patchresourceaccount with: orgId: rest.orgId accId: rest.accId dry_run: rest.dry_run check_credential: rest.check_credential body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/resources/accounts/{accid}/actions/check name: orgs-orgid-resources-accounts-accid-actions-check description: REST surface for orgs-orgId-resources-accounts-accId-actions-check. operations: - method: POST name: checkresourceaccount description: Check the credentials of an existing Resource Account call: humanitec-public.checkresourceaccount with: orgId: rest.orgId accId: rest.accId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/resources/classes name: orgs-orgid-resources-classes description: REST surface for orgs-orgId-resources-classes. operations: - method: GET name: listresourceclasses description: List resource classes. call: humanitec-public.listresourceclasses with: orgId: rest.orgId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/resources/defs name: orgs-orgid-resources-defs description: REST surface for orgs-orgId-resources-defs. operations: - method: GET name: listresourcedefinitions description: List Resource Definitions. call: humanitec-public.listresourcedefinitions with: orgId: rest.orgId app: rest.app env: rest.env env_type: rest.env_type res: rest.res res_type: rest.res_type class: rest.class deleted: rest.deleted outputParameters: - type: object mapping: $. - method: POST name: createresourcedefinition description: Create a new Resource Definition. call: humanitec-public.createresourcedefinition with: orgId: rest.orgId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/resources/defs/{defid} name: orgs-orgid-resources-defs-defid description: REST surface for orgs-orgId-resources-defs-defId. operations: - method: GET name: getresourcedefinition description: Get a Resource Definition. call: humanitec-public.getresourcedefinition with: orgId: rest.orgId defId: rest.defId deleted: rest.deleted outputParameters: - type: object mapping: $. - method: PUT name: updateresourcedefinition description: Update a Resource Definition. call: humanitec-public.updateresourcedefinition with: orgId: rest.orgId defId: rest.defId body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deleteresourcedefinition description: Delete a Resource Definition. call: humanitec-public.deleteresourcedefinition with: orgId: rest.orgId defId: rest.defId force: rest.force outputParameters: - type: object mapping: $. - method: PATCH name: patchresourcedefinition description: Update a Resource Definition. call: humanitec-public.patchresourcedefinition with: orgId: rest.orgId defId: rest.defId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/resources/defs/{defid}/criteria name: orgs-orgid-resources-defs-defid-criteria description: REST surface for orgs-orgId-resources-defs-defId-criteria. operations: - method: PUT name: updateresourcedefinitioncriteria description: Update all Matching Criteria of a Resource Definition. call: humanitec-public.updateresourcedefinitioncriteria with: orgId: rest.orgId defId: rest.defId body: rest.body outputParameters: - type: object mapping: $. - method: POST name: createresourcedefinitioncriteria description: Add a new Matching Criteria to a Resource Definition. call: humanitec-public.createresourcedefinitioncriteria with: orgId: rest.orgId defId: rest.defId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/resources/defs/{defid}/criteria/{criteriaid} name: orgs-orgid-resources-defs-defid-criteria-criteriaid description: REST surface for orgs-orgId-resources-defs-defId-criteria-criteriaId. operations: - method: DELETE name: deleteresourcedefinitioncriteria description: Delete a Matching Criteria from a Resource Definition. call: humanitec-public.deleteresourcedefinitioncriteria with: orgId: rest.orgId defId: rest.defId criteriaId: rest.criteriaId force: rest.force outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/resources/defs/{defid}/resources name: orgs-orgid-resources-defs-defid-resources description: REST surface for orgs-orgId-resources-defs-defId-resources. operations: - method: GET name: listactiveresourcebydefinition description: List Active Resources provisioned via a specific Resource Definition. call: humanitec-public.listactiveresourcebydefinition with: orgId: rest.orgId defId: rest.defId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/resources/defs/{defid}/versions name: orgs-orgid-resources-defs-defid-versions description: REST surface for orgs-orgId-resources-defs-defId-versions. operations: - method: GET name: listresourcedefinitionversions description: Get Versions of a Resource Definition. call: humanitec-public.listresourcedefinitionversions outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/resources/defs/{defid}/versions/{defversionid} name: orgs-orgid-resources-defs-defid-versions-defversionid description: REST surface for orgs-orgId-resources-defs-defId-versions-defVersionId. operations: - method: GET name: getresourcedefinitionversion description: Get a Resource Definition Version. call: humanitec-public.getresourcedefinitionversion outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/resources/defs/{defid}/versions/{defversionid}/actions/archive name: orgs-orgid-resources-defs-defid-versions-defversionid-actions-archive description: REST surface for orgs-orgId-resources-defs-defId-versions-defVersionId-actions-archive. operations: - method: POST name: archiveresourcedefinitionversion description: Mark/unmark the Resource Definition Version as archived. call: humanitec-public.archiveresourcedefinitionversion with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/resources/defs/{defid}/versions/{defversionid}/actions/promote name: orgs-orgid-resources-defs-defid-versions-defversionid-actions-promote description: REST surface for orgs-orgId-resources-defs-defId-versions-defVersionId-actions-promote. operations: - method: POST name: promoteresourcedefinitionversion description: Promote the Resource Definition Version as active. call: humanitec-public.promoteresourcedefinitionversion outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/resources/drivers name: orgs-orgid-resources-drivers description: REST surface for orgs-orgId-resources-drivers. operations: - method: GET name: listresourcedrivers description: List Resource Drivers. call: humanitec-public.listresourcedrivers with: orgId: rest.orgId outputParameters: - type: object mapping: $. - method: POST name: createresourcedriver description: Register a new Resource Driver. call: humanitec-public.createresourcedriver with: orgId: rest.orgId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/resources/drivers/{driverid} name: orgs-orgid-resources-drivers-driverid description: REST surface for orgs-orgId-resources-drivers-driverId. operations: - method: GET name: getresourcedriver description: Get a Resource Driver. call: humanitec-public.getresourcedriver with: orgId: rest.orgId driverId: rest.driverId outputParameters: - type: object mapping: $. - method: PUT name: updateresourcedriver description: Update a Resource Driver. call: humanitec-public.updateresourcedriver with: orgId: rest.orgId driverId: rest.driverId body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deleteresourcedriver description: Delete a Resources Driver. call: humanitec-public.deleteresourcedriver with: orgId: rest.orgId driverId: rest.driverId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/resources/types name: orgs-orgid-resources-types description: REST surface for orgs-orgId-resources-types. operations: - method: GET name: listresourcetypes description: List Resource Types. call: humanitec-public.listresourcetypes with: orgId: rest.orgId outputParameters: - type: object mapping: $. - method: POST name: createresourcetype description: Creates a new Resources Type. call: humanitec-public.createresourcetype with: orgId: rest.orgId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/resources/types/{typeid} name: orgs-orgid-resources-types-typeid description: REST surface for orgs-orgId-resources-types-typeId. operations: - method: DELETE name: deleteresourcetype description: Delete a Resource Type. call: humanitec-public.deleteresourcetype with: orgId: rest.orgId typeId: rest.typeId outputParameters: - type: object mapping: $. - method: PATCH name: patchresourcetype description: Update a Resource Type. call: humanitec-public.patchresourcetype with: orgId: rest.orgId typeId: rest.typeId body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: updateresourcetype description: Update a Resource Type. call: humanitec-public.updateresourcetype with: orgId: rest.orgId typeId: rest.typeId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/resources/types/{typeid}/classes name: orgs-orgid-resources-types-typeid-classes description: REST surface for orgs-orgId-resources-types-typeId-classes. operations: - method: POST name: createresourceclass description: Creates a new resources class. call: humanitec-public.createresourceclass with: orgId: rest.orgId typeId: rest.typeId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/resources/types/{typeid}/classes/{classid} name: orgs-orgid-resources-types-typeid-classes-classid description: REST surface for orgs-orgId-resources-types-typeId-classes-classId. operations: - method: GET name: getresourceclass description: Get resource class by ID. call: humanitec-public.getresourceclass with: orgId: rest.orgId typeId: rest.typeId classId: rest.classId outputParameters: - type: object mapping: $. - method: PATCH name: updateresourceclass description: Update a resource class description. call: humanitec-public.updateresourceclass with: orgId: rest.orgId typeId: rest.typeId classId: rest.classId body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deleteresourceclass description: Delete a resource class. call: humanitec-public.deleteresourceclass with: orgId: rest.orgId typeId: rest.typeId classId: rest.classId outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/runtime/actions/check-connectivity name: orgs-orgid-runtime-actions-check-connectivity description: REST surface for orgs-orgId-runtime-actions-check-connectivity. operations: - method: POST name: checkclusterconnectivity description: Provision and check the cluster connectivity in an environment call: humanitec-public.checkclusterconnectivity with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/secretstores name: orgs-orgid-secretstores description: REST surface for orgs-orgId-secretstores. operations: - method: GET name: get description: Get list of Secret Stores for the given organization. call: humanitec-public.get with: orgId: rest.orgId outputParameters: - type: object mapping: $. - method: POST name: post description: Create a Secret Store for the given organization. call: humanitec-public.post with: orgId: rest.orgId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/secretstores/{storeid} name: orgs-orgid-secretstores-storeid description: REST surface for orgs-orgId-secretstores-storeId. operations: - method: GET name: get description: Get the Secret Store. call: humanitec-public.get with: orgId: rest.orgId storeId: rest.storeId outputParameters: - type: object mapping: $. - method: DELETE name: delete description: Delete the Secret Store. call: humanitec-public.delete with: orgId: rest.orgId storeId: rest.storeId outputParameters: - type: object mapping: $. - method: PATCH name: patch description: Update the Secret Store. call: humanitec-public.patch with: orgId: rest.orgId storeId: rest.storeId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/users name: orgs-orgid-users description: REST surface for orgs-orgId-users. operations: - method: GET name: listuserrolesinorg description: List Users and Groups with roles in an Organization call: humanitec-public.listuserrolesinorg outputParameters: - type: object mapping: $. - method: POST name: createserviceuserinorg description: Creates a new service user. call: humanitec-public.createserviceuserinorg with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/users/{userid} name: orgs-orgid-users-userid description: REST surface for orgs-orgId-users-userId. operations: - method: GET name: getuserroleinorg description: Get the role of a User or a Group on an Organization call: humanitec-public.getuserroleinorg outputParameters: - type: object mapping: $. - method: DELETE name: deleteuserroleinorg description: Remove the role of a User or a Group on an Organization call: humanitec-public.deleteuserroleinorg outputParameters: - type: object mapping: $. - method: PATCH name: updateuserroleinorg description: Update the role of a User or a Group on an Organization call: humanitec-public.updateuserroleinorg with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/users/{userid}/groups name: orgs-orgid-users-userid-groups description: REST surface for orgs-orgId-users-userId-groups. operations: - method: GET name: listusergroupsinorg description: Get the groups in an organization a user belongs to. call: humanitec-public.listusergroupsinorg outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/users/{userid}/perms name: orgs-orgid-users-userid-perms description: REST surface for orgs-orgId-users-userId-perms. operations: - method: GET name: getsubjectpermsinorg description: Get the permissions of a User or Group on the objects in an Organization call: humanitec-public.getsubjectpermsinorg outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/workload-profile-chart-versions name: orgs-orgid-workload-profile-chart-versions description: REST surface for orgs-orgId-workload-profile-chart-versions. operations: - method: POST name: createworkloadprofilechartversion description: Add new Workload Profile Chart Version call: humanitec-public.createworkloadprofilechartversion with: body: rest.body outputParameters: - type: object mapping: $. - method: GET name: listworkloadprofilechartversions description: Workload Profile Chart Versions for the given organization. call: humanitec-public.listworkloadprofilechartversions with: id: rest.id version: rest.version outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/workload-profile-features name: orgs-orgid-workload-profile-features description: REST surface for orgs-orgId-workload-profile-features. operations: - method: GET name: listworkloadprofilefeatures description: List workload profile features available to the organization. call: humanitec-public.listworkloadprofilefeatures outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/workload-profiles name: orgs-orgid-workload-profiles description: REST surface for orgs-orgId-workload-profiles. operations: - method: GET name: listworkloadprofiles description: List workload profiles available to the organization. call: humanitec-public.listworkloadprofiles outputParameters: - type: object mapping: $. - method: POST name: createworkloadprofile description: Create new Workload Profile call: humanitec-public.createworkloadprofile with: body: rest.body outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/workload-profiles/{profileqid} name: orgs-orgid-workload-profiles-profileqid description: REST surface for orgs-orgId-workload-profiles-profileQid. operations: - method: GET name: getworkloadprofile description: Get a Workload Profile call: humanitec-public.getworkloadprofile outputParameters: - type: object mapping: $. - method: PUT name: updateworkloadprofile description: Update a Workload Profile call: humanitec-public.updateworkloadprofile with: body: rest.body outputParameters: - type: object mapping: $. - method: DELETE name: deleteworkloadprofile description: Delete a Workload Profile call: humanitec-public.deleteworkloadprofile outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/workload-profiles/{profileqid}/versions name: orgs-orgid-workload-profiles-profileqid-versions description: REST surface for orgs-orgId-workload-profiles-profileQid-versions. operations: - method: GET name: listworkloadprofileversions description: List versions of the given workload profile. call: humanitec-public.listworkloadprofileversions outputParameters: - type: object mapping: $. - path: /v1/orgs/{orgid}/workload-profiles/{profileqid}/versions/latest name: orgs-orgid-workload-profiles-profileqid-versions-latest description: REST surface for orgs-orgId-workload-profiles-profileQid-versions-latest. operations: - method: GET name: getlatestworkloadprofileversion description: Latest version of the given workload profile with optional constraint. call: humanitec-public.getlatestworkloadprofileversion outputParameters: - type: object mapping: $. - path: /v1/users/{userid}/tokens name: users-userid-tokens description: REST surface for users-userId-tokens. operations: - method: GET name: listusertokens description: Lists tokens associated with a user call: humanitec-public.listusertokens with: userId: rest.userId outputParameters: - type: object mapping: $. - method: POST name: createusertoken description: Creates a new static token for a user. call: humanitec-public.createusertoken with: userId: rest.userId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/users/{userid}/tokens/{tokenid} name: users-userid-tokens-tokenid description: REST surface for users-userId-tokens-tokenId. operations: - method: GET name: getusertoken description: Gets a specific token associated with a user call: humanitec-public.getusertoken with: userId: rest.userId tokenId: rest.tokenId outputParameters: - type: object mapping: $. - method: DELETE name: deleteusertoken description: Deletes a specific token associated with a user call: humanitec-public.deleteusertoken with: userId: rest.userId tokenId: rest.tokenId outputParameters: - type: object mapping: $. - type: mcp namespace: humanitec-public-mcp port: 9090 transport: http description: MCP adapter for Humanitec API — public. One tool per consumed operation, routed inline through this capability's consumes block. tools: - name: gets-extended-profile-current-user description: Gets the extended profile of the current user hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getcurrentuser outputParameters: - type: object mapping: $. - name: updates-extended-profile-current-user description: Updates the extended profile of the current user. hints: readOnly: false destructive: false idempotent: true call: humanitec-public.updatecurrentuser with: body: tools.body outputParameters: - type: object mapping: $. - name: list-active-organizations-user-has description: List active organizations the user has access to. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listorganizations outputParameters: - type: object mapping: $. - name: get-specified-organization description: Get the specified Organization. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getorganization outputParameters: - type: object mapping: $. - name: register-new-agent-under-organization description: Register a new Agent under an Organization. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createagent with: body: tools.body outputParameters: - type: object mapping: $. - name: list-all-agents-organization description: List all the agents in an Organization. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listagents outputParameters: - type: object mapping: $. - name: delete-agent-and-its-keys description: Delete an Agent (and its keys) stored under an Organization. hints: readOnly: false destructive: true idempotent: true call: humanitec-public.deleteagent outputParameters: - type: object mapping: $. - name: update-description-agent description: Update the description of an Agent. hints: readOnly: false destructive: false idempotent: true call: humanitec-public.patchagent with: body: tools.body outputParameters: - type: object mapping: $. - name: list-all-keys-registered-under description: List all the keys registered under an Agent in an Organization. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listkeysinagent outputParameters: - type: object mapping: $. - name: register-new-key-under-agent description: Register a new Key under an Agent in an Organization. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createkey with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-key-registered-under-agent description: Delete a key registered under a Agent. hints: readOnly: false destructive: true idempotent: true call: humanitec-public.deletekeyinagent outputParameters: - type: object mapping: $. - name: list-all-applications-organization description: List all Applications in an Organization. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listapplications with: orgId: tools.orgId outputParameters: - type: object mapping: $. - name: add-new-application-organization description: Add a new Application to an Organization hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createapplication with: orgId: tools.orgId body: tools.body outputParameters: - type: object mapping: $. - name: get-existing-application description: Get an existing Application hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getapplication with: orgId: tools.orgId appId: tools.appId outputParameters: - type: object mapping: $. - name: update-metadata-existing-application description: Update metadata of an existing Application hints: readOnly: false destructive: false idempotent: true call: humanitec-public.patchapplication with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-application description: Delete an Application hints: readOnly: false destructive: true idempotent: true call: humanitec-public.deleteapplication with: orgId: tools.orgId appId: tools.appId outputParameters: - type: object mapping: $. - name: list-approval-requests description: List of the approval requests hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listpipelineapprovalrequests outputParameters: - type: object mapping: $. - name: list-deltas-application description: List Deltas in an Application hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listdeltas with: archived: tools.archived env: tools.env outputParameters: - type: object mapping: $. - name: create-new-delta description: Create a new Delta hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createdelta with: body: tools.body outputParameters: - type: object mapping: $. - name: fetch-existing-delta description: Fetch an existing Delta hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getdelta with: deltaId: tools.deltaId outputParameters: - type: object mapping: $. - name: update-existing-delta description: Update an existing Delta hints: readOnly: false destructive: false idempotent: true call: humanitec-public.patchdelta with: deltaId: tools.deltaId body: tools.body outputParameters: - type: object mapping: $. - name: update-existing-delta-2 description: Update an existing Delta hints: readOnly: false destructive: false idempotent: true call: humanitec-public.putdelta with: deltaId: tools.deltaId body: tools.body outputParameters: - type: object mapping: $. - name: mark-delta-archived description: Mark a Delta as "archived" hints: readOnly: false destructive: false idempotent: true call: humanitec-public.archivedelta with: deltaId: tools.deltaId body: tools.body outputParameters: - type: object mapping: $. - name: change-environment-delta description: Change the Environment of a Delta hints: readOnly: false destructive: false idempotent: true call: humanitec-public.changeenvofdelta with: deltaId: tools.deltaId body: tools.body outputParameters: - type: object mapping: $. - name: change-name-delta description: Change the name of a Delta hints: readOnly: false destructive: false idempotent: true call: humanitec-public.changenameofdelta with: deltaId: tools.deltaId body: tools.body outputParameters: - type: object mapping: $. - name: list-all-environments description: List all Environments. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listenvironments with: orgId: tools.orgId appId: tools.appId outputParameters: - type: object mapping: $. - name: add-new-environment-application description: Add a new Environment to an Application. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createenvironment with: orgId: tools.orgId appId: tools.appId body: tools.body outputParameters: - type: object mapping: $. - name: get-specific-environment description: Get a specific Environment. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getenvironment with: orgId: tools.orgId appId: tools.appId envId: tools.envId outputParameters: - type: object mapping: $. - name: update-specific-environment description: Update a specific Environment. hints: readOnly: false destructive: false idempotent: true call: humanitec-public.updateenvironment with: orgId: tools.orgId appId: tools.appId envId: tools.envId body: tools.body outputParameters: - type: object mapping: $. - name: delete-specific-environment description: Delete a specific Environment. hints: readOnly: false destructive: true idempotent: true call: humanitec-public.deleteenvironment with: orgId: tools.orgId appId: tools.appId envId: tools.envId outputParameters: - type: object mapping: $. - name: list-deployments-environment description: List Deployments in an Environment. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listdeployments with: orgId: tools.orgId appId: tools.appId envId: tools.envId pipelineRunId: tools.pipelineRunId outputParameters: - type: object mapping: $. - name: start-new-deployment description: Start a new Deployment. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createdeployment with: orgId: tools.orgId appId: tools.appId envId: tools.envId body: tools.body outputParameters: - type: object mapping: $. - name: get-specific-deployment description: Get a specific Deployment. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getdeployment with: orgId: tools.orgId appId: tools.appId envId: tools.envId deployId: tools.deployId outputParameters: - type: object mapping: $. - name: list-errors-that-occurred-deployment description: List errors that occurred in a Deployment. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listdeploymenterrors with: orgId: tools.orgId appId: tools.appId envId: tools.envId deployId: tools.deployId outputParameters: - type: object mapping: $. - name: rebase-different-deployment description: Rebase to a different Deployment. hints: readOnly: false destructive: false idempotent: true call: humanitec-public.rebaseenvironment with: orgId: tools.orgId appId: tools.appId envId: tools.envId body: tools.body outputParameters: - type: object mapping: $. - name: get-container-log-entries-environment description: Get container log entries for the environment hints: readOnly: true destructive: false idempotent: true call: humanitec-public.get with: orgId: tools.orgId appId: tools.appId envId: tools.envId workload_id: tools.workload_id container_id: tools.container_id deployment_id: tools.deployment_id timestamp_from: tools.timestamp_from timestamp_to: tools.timestamp_to limit: tools.limit asc: tools.asc invert: tools.invert outputParameters: - type: object mapping: $. - name: list-active-resources-provisioned-environment description: List Active Resources provisioned in an environment. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listactiveresources with: orgId: tools.orgId appId: tools.appId envId: tools.envId scheduled_deletion: tools.scheduled_deletion outputParameters: - type: object mapping: $. - name: lists-resource-objects-that-hold description: Lists the resource objects that hold the information needed to provision the resources specified in the request and the resources they depend on. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.queryresourcegraph with: orgId: tools.orgId appId: tools.appId envId: tools.envId body: tools.body outputParameters: - type: object mapping: $. - name: create-dependency-graph-which-is 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. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createdependencygraph with: body: tools.body outputParameters: - type: object mapping: $. - name: retrieve-dependency-graph-its-id description: Retrieve a Dependency Graph by its ID. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getdependencygraph outputParameters: - type: object mapping: $. - name: delete-active-resource description: Delete Active Resource. hints: readOnly: false destructive: true idempotent: true call: humanitec-public.deleteactiveresource with: orgId: tools.orgId appId: tools.appId envId: tools.envId type: tools.type resId: tools.resId detach: tools.detach outputParameters: - type: object mapping: $. - name: pin-active-resource-target-resource description: Pin Active Resource to a target Resource Definition Version. hints: readOnly: true destructive: false idempotent: false call: humanitec-public.pinactiveresource with: body: tools.body outputParameters: - type: object mapping: $. - name: list-all-automation-rules-environment description: List all Automation Rules in an Environment. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listautomationrules outputParameters: - type: object mapping: $. - name: create-new-automation-rule-environment description: Create a new Automation Rule for an Environment. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createautomationrule with: body: tools.body outputParameters: - type: object mapping: $. - name: get-specific-automation-rule-environment description: Get a specific Automation Rule for an Environment. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getautomationrule with: ruleId: tools.ruleId outputParameters: - type: object mapping: $. - name: update-existing-automation-rule-environment description: Update an existing Automation Rule for an Environment. hints: readOnly: false destructive: false idempotent: true call: humanitec-public.updateautomationrule with: ruleId: tools.ruleId body: tools.body outputParameters: - type: object mapping: $. - name: delete-automation-rule-environment description: Delete Automation Rule from an Environment. hints: readOnly: false destructive: true idempotent: true call: humanitec-public.deleteautomationrule with: ruleId: tools.ruleId outputParameters: - type: object mapping: $. - name: get-runtime-information-about-environment description: Get Runtime information about the environment. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getruntime outputParameters: - type: object mapping: $. - name: pause-resume-environment description: Pause / Resume an environment. hints: readOnly: false destructive: false idempotent: true call: humanitec-public.updatepaused with: body: tools.body outputParameters: - type: object mapping: $. - name: set-number-replicas-environment-s-modules description: Set number of replicas for an environment's modules. hints: readOnly: false destructive: false idempotent: true call: humanitec-public.patchreplicas with: body: tools.body outputParameters: - type: object mapping: $. - name: list-value-set-versions-environment description: List Value Set Versions in an Environment of an App hints: readOnly: true destructive: false idempotent: true call: humanitec-public.get with: orgId: tools.orgId appId: tools.appId envId: tools.envId key_changed: tools.key_changed outputParameters: - type: object mapping: $. - name: get-single-value-set-version 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. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.get with: orgId: tools.orgId appId: tools.appId envId: tools.envId valueSetVersionId: tools.valueSetVersionId outputParameters: - type: object mapping: $. - name: purge-value-specific-shared-value description: Purge the value of a specific Shared Value from the App Environment Version history. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.post with: orgId: tools.orgId appId: tools.appId envId: tools.envId valueSetVersionId: tools.valueSetVersionId key: tools.key body: tools.body outputParameters: - type: object mapping: $. - name: restore-value-set-version-environment description: Restore a Value Set Version in an Environment of an App hints: readOnly: false destructive: false idempotent: false call: humanitec-public.post with: orgId: tools.orgId appId: tools.appId envId: tools.envId valueSetVersionId: tools.valueSetVersionId body: tools.body outputParameters: - type: object mapping: $. - name: restore-specific-key-value-set description: Restore a specific key from the Value Set Version in an Environment of an App hints: readOnly: false destructive: false idempotent: false call: humanitec-public.post with: orgId: tools.orgId appId: tools.appId envId: tools.envId valueSetVersionId: tools.valueSetVersionId key: tools.key body: tools.body outputParameters: - type: object mapping: $. - name: list-shared-values-environment description: List Shared Values in an Environment hints: readOnly: true destructive: false idempotent: true call: humanitec-public.get with: orgId: tools.orgId appId: tools.appId envId: tools.envId outputParameters: - type: object mapping: $. - name: create-shared-value-environment description: Create a Shared Value for an Environment hints: readOnly: false destructive: false idempotent: false call: humanitec-public.post with: orgId: tools.orgId appId: tools.appId envId: tools.envId body: tools.body outputParameters: - type: object mapping: $. - name: delete-all-shared-value-environment description: Delete all Shared Value for an Environment hints: readOnly: false destructive: true idempotent: true call: humanitec-public.delete with: orgId: tools.orgId appId: tools.appId envId: tools.envId outputParameters: - type: object mapping: $. - name: update-shared-value-environment description: Update Shared Value for an Environment hints: readOnly: false destructive: false idempotent: true call: humanitec-public.put with: orgId: tools.orgId appId: tools.appId envId: tools.envId key: tools.key body: tools.body outputParameters: - type: object mapping: $. - name: delete-shared-value-environment description: Delete Shared Value for an Environment hints: readOnly: false destructive: true idempotent: true call: humanitec-public.delete with: orgId: tools.orgId appId: tools.appId envId: tools.envId key: tools.key outputParameters: - type: object mapping: $. - name: update-shared-value-environment-2 description: Update Shared Value for an Environment hints: readOnly: false destructive: false idempotent: true call: humanitec-public.patch with: orgId: tools.orgId appId: tools.appId envId: tools.envId key: tools.key body: tools.body outputParameters: - type: object mapping: $. - name: deletes-all-jobs-application description: Deletes all Jobs for the Application hints: readOnly: false destructive: true idempotent: true call: humanitec-public.delete with: orgId: tools.orgId appId: tools.appId outputParameters: - type: object mapping: $. - name: list-trigger-matching-criteria-defined description: List the trigger matching criteria defined for Pipelines in this Application. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listpipelinecriteriainapp with: pipeline: tools.pipeline match: tools.match outputParameters: - type: object mapping: $. - name: create-pipeline-run-appropriate-pipeline description: Create a Pipeline Run in the appropriate Pipeline based on the trigger and inputs. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createpipelinerunbytriggercriteria with: dry_run: tools.dry_run body: tools.body outputParameters: - type: object mapping: $. - name: list-pipelines-within-application description: List Pipelines within an Application. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listpipelines outputParameters: - type: object mapping: $. - name: create-pipeline-within-application description: Create a Pipeline within an Application. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createpipeline with: dry_run: tools.dry_run body: tools.body outputParameters: - type: object mapping: $. - name: get-pipeline-within-application description: Get a Pipeline within an Application. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getpipeline outputParameters: - type: object mapping: $. - name: update-pipeline-within-application description: update a Pipeline within an Application. hints: readOnly: false destructive: false idempotent: true call: humanitec-public.updatepipeline with: dry_run: tools.dry_run body: tools.body outputParameters: - type: object mapping: $. - name: delete-pipeline-within-application description: Delete a pipeline within an application. hints: readOnly: false destructive: true idempotent: true call: humanitec-public.deletepipeline outputParameters: - type: object mapping: $. - name: read-current-state-trigger-batch description: Read the current state of a trigger batch hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getbatch outputParameters: - type: object mapping: $. - name: create-new-trigger-matching-criteria description: Create a new trigger matching criteria for this Pipeline. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createpipelinecriteria with: body: tools.body outputParameters: - type: object mapping: $. - name: get-pipeline-criteria-given-id description: Get the Pipeline Criteria with the given id. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getpipelinecriteria with: criteriaId: tools.criteriaId outputParameters: - type: object mapping: $. - name: delete-pipeline-criteria-given-id description: Delete the Pipeline Criteria with the given id. hints: readOnly: false destructive: true idempotent: true call: humanitec-public.deletepipelinecriteria with: criteriaId: tools.criteriaId outputParameters: - type: object mapping: $. - name: list-runs-within-pipeline-ordered description: List runs within a pipeline ordered newest to oldest. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listpipelineruns outputParameters: - type: object mapping: $. - name: create-run-within-pipeline description: Create a run within a pipeline. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createpipelinerun with: dry_run: tools.dry_run body: tools.body outputParameters: - type: object mapping: $. - name: get-run-within-pipeline description: Get a run within an pipeline. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getpipelinerun outputParameters: - type: object mapping: $. - name: deleting-completed-run-within-pipeline description: Deleting a completed Run within a Pipeline. hints: readOnly: false destructive: true idempotent: true call: humanitec-public.deletepipelinerun outputParameters: - type: object mapping: $. - name: cancel-run-within-pipeline description: Cancel a Run within an Pipeline. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.cancelpipelinerun outputParameters: - type: object mapping: $. - name: list-details-jobs-within-pipeline description: List the details of the jobs within a pipeline run. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listpipelinejobs outputParameters: - type: object mapping: $. - name: list-details-job-including-step description: List the details of a Job including Step information hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getpipelinejob outputParameters: - type: object mapping: $. - name: get-approval-request description: Get an approval request hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getpipelineapprovalrequest outputParameters: - type: object mapping: $. - name: approve-approval-request description: Approve the approval request hints: readOnly: false destructive: false idempotent: false call: humanitec-public.approvepipelineapprovalrequest outputParameters: - type: object mapping: $. - name: deny-approval-request description: Deny the approval request hints: readOnly: false destructive: false idempotent: false call: humanitec-public.denypipelineapprovalrequest outputParameters: - type: object mapping: $. - name: get-page-log-output-given description: Get a page of log output for a given step within a job. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listpipelinesteplogs outputParameters: - type: object mapping: $. - name: restart-run-within-pipeline-cloning description: Restart a Run within an Pipeline by cloning it with the same trigger and inputs. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.restartpipelinerun outputParameters: - type: object mapping: $. - name: get-pipeline-schema description: Get a pipeline schema. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getpipelinedefinition with: Accept: tools.Accept outputParameters: - type: object mapping: $. - name: list-all-versions-pipeline description: List all versions of the pipeline hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listpipelineversions outputParameters: - type: object mapping: $. - name: get-runtime-information-about-specific description: Get Runtime information about specific multiple environments. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listruntime with: id: tools.id outputParameters: - type: object mapping: $. - name: get-all-deployment-sets description: Get all Deployment Sets hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listsets outputParameters: - type: object mapping: $. - name: get-deployment-set description: Get a Deployment Set hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getset with: setId: tools.setId diff: tools.diff outputParameters: - type: object mapping: $. - name: apply-deployment-delta-deployment-set description: Apply a Deployment Delta to a Deployment Set hints: readOnly: false destructive: false idempotent: false call: humanitec-public.updateset with: setId: tools.setId body: tools.body outputParameters: - type: object mapping: $. - name: get-difference-between-2-deployment description: Get the difference between 2 Deployment Sets hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getdiff with: setId: tools.setId sourceSetId: tools.sourceSetId outputParameters: - type: object mapping: $. - name: get-resource-inputs-given-deployment description: Get Resource Inputs for the given Deployment Set hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getsetresourceinputs with: setId: tools.setId outputParameters: - type: object mapping: $. - name: list-users-groups-roles-app description: List Users or Groups with roles in an App hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listuserrolesinapp outputParameters: - type: object mapping: $. - name: adds-user-group-application-role description: Adds a User or a Group to an Application with a Role hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createuserroleinapp with: body: tools.body outputParameters: - type: object mapping: $. - name: get-role-user-group-application description: Get the role of a User or a Group on an Application hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getuserroleinapp outputParameters: - type: object mapping: $. - name: remove-role-user-group-application description: Remove the role of a User or a Group on an Application hints: readOnly: false destructive: true idempotent: true call: humanitec-public.deleteuserroleinapp outputParameters: - type: object mapping: $. - name: update-role-user-group-application description: Update the role of a User or a Group on an Application hints: readOnly: false destructive: false idempotent: true call: humanitec-public.updateuserroleinapp with: body: tools.body outputParameters: - type: object mapping: $. - name: list-value-set-versions-app description: List Value Set Versions in the App hints: readOnly: true destructive: false idempotent: true call: humanitec-public.get with: orgId: tools.orgId appId: tools.appId key_changed: tools.key_changed outputParameters: - type: object mapping: $. - name: get-single-value-set-version-2 description: Get a single Value Set Version from the App hints: readOnly: true destructive: false idempotent: true call: humanitec-public.get with: orgId: tools.orgId appId: tools.appId valueSetVersionId: tools.valueSetVersionId outputParameters: - type: object mapping: $. - name: purge-value-specific-shared-value-2 description: Purge the value of a specific Shared Value from the App Version history. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.post with: orgId: tools.orgId appId: tools.appId valueSetVersionId: tools.valueSetVersionId key: tools.key body: tools.body outputParameters: - type: object mapping: $. - name: restore-value-set-version-app description: Restore a Value Set Version in an App hints: readOnly: false destructive: false idempotent: false call: humanitec-public.post with: orgId: tools.orgId appId: tools.appId valueSetVersionId: tools.valueSetVersionId body: tools.body outputParameters: - type: object mapping: $. - name: restore-specific-key-value-set-2 description: Restore a specific key from the Value Set Version in an App hints: readOnly: false destructive: false idempotent: false call: humanitec-public.post with: orgId: tools.orgId appId: tools.appId valueSetVersionId: tools.valueSetVersionId key: tools.key body: tools.body outputParameters: - type: object mapping: $. - name: list-shared-values-application description: List Shared Values in an Application hints: readOnly: true destructive: false idempotent: true call: humanitec-public.get with: orgId: tools.orgId appId: tools.appId outputParameters: - type: object mapping: $. - name: create-shared-value-application description: Create a Shared Value for an Application hints: readOnly: false destructive: false idempotent: false call: humanitec-public.post with: orgId: tools.orgId appId: tools.appId body: tools.body outputParameters: - type: object mapping: $. - name: delete-all-shared-value-app description: Delete all Shared Value for an App hints: readOnly: false destructive: true idempotent: true call: humanitec-public.delete with: orgId: tools.orgId appId: tools.appId outputParameters: - type: object mapping: $. - name: update-shared-value-application description: Update Shared Value for an Application hints: readOnly: false destructive: false idempotent: true call: humanitec-public.put with: orgId: tools.orgId appId: tools.appId key: tools.key body: tools.body outputParameters: - type: object mapping: $. - name: delete-shared-value-application description: Delete Shared Value for an Application hints: readOnly: false destructive: true idempotent: true call: humanitec-public.delete with: orgId: tools.orgId appId: tools.appId key: tools.key outputParameters: - type: object mapping: $. - name: update-shared-value-application-2 description: Update Shared Value for an Application hints: readOnly: false destructive: false idempotent: true call: humanitec-public.patch with: orgId: tools.orgId appId: tools.appId key: tools.key body: tools.body outputParameters: - type: object mapping: $. - name: list-webhooks description: List Webhooks hints: readOnly: true destructive: false idempotent: true call: humanitec-public.get with: orgId: tools.orgId appId: tools.appId outputParameters: - type: object mapping: $. - name: create-new-webhook description: Create a new Webhook hints: readOnly: false destructive: false idempotent: false call: humanitec-public.post with: orgId: tools.orgId appId: tools.appId body: tools.body outputParameters: - type: object mapping: $. - name: get-webhook description: Get a Webhook hints: readOnly: true destructive: false idempotent: true call: humanitec-public.get with: orgId: tools.orgId appId: tools.appId jobId: tools.jobId outputParameters: - type: object mapping: $. - name: delete-webhook description: Delete a Webhook hints: readOnly: false destructive: true idempotent: true call: humanitec-public.delete with: orgId: tools.orgId appId: tools.appId jobId: tools.jobId outputParameters: - type: object mapping: $. - name: update-webhook description: Update a Webhook hints: readOnly: false destructive: false idempotent: true call: humanitec-public.patch with: orgId: tools.orgId appId: tools.appId jobId: tools.jobId body: tools.body outputParameters: - type: object mapping: $. - name: list-all-artefacts-versions-org description: List all Artefacts Versions in the org. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listartefactversionsinorg with: orgId: tools.orgId name: tools.name reference: tools.reference archived: tools.archived type: tools.type outputParameters: - type: object mapping: $. - name: register-new-artefact-version-your description: Register a new Artefact Version with your organization. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createartefactversion with: orgId: tools.orgId vcs: tools.vcs dry_run: tools.dry_run Accept: tools.Accept body: tools.body outputParameters: - type: object mapping: $. - name: convert-score-specification-optional-overrides 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-public.convertscoretoset with: orgId: tools.orgId body: tools.body outputParameters: - type: object mapping: $. - name: get-artefacts-versions description: Get an Artefacts Versions. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getartefactversion with: orgId: tools.orgId artefactVersionId: tools.artefactVersionId outputParameters: - type: object mapping: $. - name: get-humanitec-module-definition-this description: Get the Humanitec module definition of this Workload Artefact Version as a deployment set hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getworkloadartefactversiondeploymentset with: orgId: tools.orgId artefactVersionId: tools.artefactVersionId Accept: tools.Accept outputParameters: - type: object mapping: $. - name: get-spec-this-workload-artefact description: Get the spec of this Workload Artefact Version hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getworkloadartefactversionspec with: orgId: tools.orgId artefactVersionId: tools.artefactVersionId Accept: tools.Accept outputParameters: - type: object mapping: $. - name: list-all-artefacts description: List all Artefacts. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listartefacts with: orgId: tools.orgId type: tools.type name: tools.name outputParameters: - type: object mapping: $. - name: delete-artefact-and-all-related description: Delete Artefact and all related Artefact Versions hints: readOnly: false destructive: true idempotent: true call: humanitec-public.deleteartefact with: orgId: tools.orgId artefactId: tools.artefactId outputParameters: - type: object mapping: $. - name: list-all-artefact-versions-artefact description: List all Artefact Versions of an Artefact. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listartefactversions with: orgId: tools.orgId artefactId: tools.artefactId archived: tools.archived reference: tools.reference limit: tools.limit outputParameters: - type: object mapping: $. - name: update-version-artefact description: Update Version of an Artefact. hints: readOnly: false destructive: false idempotent: true call: humanitec-public.patchartefactversion with: orgId: tools.orgId artefactId: tools.artefactId versionId: tools.versionId body: tools.body outputParameters: - type: object mapping: $. - name: list-audit-log-entries-organization description: List audit log entries by Organization hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listauditlogentries with: from: tools.from to: tools.to outputParameters: - type: object mapping: $. - name: list-all-environment-types description: List all Environment Types hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listenvironmenttypes with: orgId: tools.orgId outputParameters: - type: object mapping: $. - name: add-new-environment-type description: Add a new Environment Type hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createenvironmenttype with: orgId: tools.orgId body: tools.body outputParameters: - type: object mapping: $. - name: get-environment-type description: Get an Environment Type hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getenvironmenttype with: orgId: tools.orgId envTypeId: tools.envTypeId outputParameters: - type: object mapping: $. - name: deletes-environment-type description: Deletes an Environment Type hints: readOnly: false destructive: true idempotent: true call: humanitec-public.deleteenvironmenttype with: orgId: tools.orgId envTypeId: tools.envTypeId outputParameters: - type: object mapping: $. - name: updates-environment-type description: Updates Environment Type hints: readOnly: false destructive: false idempotent: true call: humanitec-public.updateenvironmenttype with: orgId: tools.orgId envTypeId: tools.envTypeId body: tools.body outputParameters: - type: object mapping: $. - name: list-users-and-groups-roles description: List Users and Groups with roles in an Environment Type hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listuserrolesinenvtype outputParameters: - type: object mapping: $. - name: adds-user-group-environment-type description: Adds a User or a Group to an Environment Type with a Role hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createuserroleinenvtype with: body: tools.body outputParameters: - type: object mapping: $. - name: get-role-user-group-environment description: Get the role of a User or a Group on an Environment Type hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getuserroleinenvtype outputParameters: - type: object mapping: $. - name: remove-role-user-group-environment description: Remove the role of a User or a Group on an Environment Type hints: readOnly: false destructive: true idempotent: true call: humanitec-public.deleteuserroleinenvtype outputParameters: - type: object mapping: $. - name: update-role-user-group-environment description: Update the role of a User or a Group on an Environment Type hints: readOnly: false destructive: false idempotent: true call: humanitec-public.updateuserroleinenvtype with: body: tools.body outputParameters: - type: object mapping: $. - name: list-events description: List Events hints: readOnly: true destructive: false idempotent: true call: humanitec-public.get with: orgId: tools.orgId outputParameters: - type: object mapping: $. - name: create-group-organization description: Create a group in an organization hints: readOnly: false destructive: false idempotent: false call: humanitec-public.creategroup with: body: tools.body outputParameters: - type: object mapping: $. - name: list-users-group description: List users in a group. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listgroupusers outputParameters: - type: object mapping: $. - name: list-all-public-keys-humanitec description: List all the public keys Humanitec shares with an organization. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listhumanitecpublickeys with: orgId: tools.orgId active: tools.active outputParameters: - type: object mapping: $. - name: list-all-container-images description: List all Container Images hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listdeprecatedimages with: orgId: tools.orgId outputParameters: - type: object mapping: $. - name: get-specific-image-object description: Get a specific Image Object hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getdeprecatedimage with: orgId: tools.orgId imageId: tools.imageId outputParameters: - type: object mapping: $. - name: lists-all-builds-image description: Lists all the Builds of an Image hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listdeprecatedimagebuilds with: orgId: tools.orgId imageId: tools.imageId outputParameters: - type: object mapping: $. - name: add-new-image-build description: Add a new Image Build hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createdeprecatedimagebuild with: orgId: tools.orgId imageId: tools.imageId body: tools.body outputParameters: - type: object mapping: $. - name: list-invites-issued-organization description: List the invites issued for the organization. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listinvitesinorg outputParameters: - type: object mapping: $. - name: invites-user-organization-specified-role description: Invites a user to an Organization with a specified role. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createinviteinorg with: body: tools.body outputParameters: - type: object mapping: $. - name: associate-new-rsa-public-key description: Associate a new RSA public key to an organization. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createpublickey with: orgId: tools.orgId body: tools.body outputParameters: - type: object mapping: $. - name: list-all-public-keys-associated description: List all public keys associated to an organization. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listpublickeys with: orgId: tools.orgId fingerprint: tools.fingerprint outputParameters: - type: object mapping: $. - name: delete-public-key-associated-organization description: Delete a public key associated to an organization. hints: readOnly: false destructive: true idempotent: true call: humanitec-public.deletepublickey with: orgId: tools.orgId keyId: tools.keyId outputParameters: - type: object mapping: $. - name: retrieve-single-public-key-associated description: Retrieve a single public key associated to an organization. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getpublickey with: orgId: tools.orgId keyId: tools.keyId outputParameters: - type: object mapping: $. - name: list-all-pipeline-runs-within description: List all pipeline runs within the Org ordered newest to oldest. This can be filtered by app, pipeline, and status. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listpipelinerunsbyorg outputParameters: - type: object mapping: $. - name: gets-latest-pipeline-schema description: Gets the latest pipeline schema hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getlatestpipelinedefinitionschema outputParameters: - type: object mapping: $. - name: list-all-pipelines-within-organization description: List all Pipelines within an Organization. This can be filtered by Application. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listpipelinesinorg outputParameters: - type: object mapping: $. - name: lists-available-registries-organization description: Lists available registries for the organization. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.get with: orgId: tools.orgId outputParameters: - type: object mapping: $. - name: creates-new-registry-record description: Creates a new registry record. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.post with: orgId: tools.orgId body: tools.body outputParameters: - type: object mapping: $. - name: loads-registry-record-details description: Loads a registry record details. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.get with: orgId: tools.orgId regId: tools.regId outputParameters: - type: object mapping: $. - name: deletes-existing-registry-record-and description: Deletes an existing registry record and all associated credentials and secrets. hints: readOnly: false destructive: true idempotent: true call: humanitec-public.delete with: orgId: tools.orgId regId: tools.regId outputParameters: - type: object mapping: $. - name: updates-patches-existing-registry-record description: Updates (patches) an existing registry record. hints: readOnly: false destructive: false idempotent: true call: humanitec-public.patch with: orgId: tools.orgId regId: tools.regId body: tools.body outputParameters: - type: object mapping: $. - name: returns-current-account-credentials-secret description: Returns current account credentials or secret details for the registry. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.get with: orgId: tools.orgId regId: tools.regId outputParameters: - type: object mapping: $. - name: list-resource-account-types-available description: List Resource Account Types available to the organization. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listresourceaccounttypes with: orgId: tools.orgId outputParameters: - type: object mapping: $. - name: list-resource-accounts-organization description: List Resource Accounts in the organization. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listresourceaccounts with: orgId: tools.orgId outputParameters: - type: object mapping: $. - name: create-new-resource-account-organization description: Create a new Resource Account in the organization. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createresourceaccount with: orgId: tools.orgId dry_run: tools.dry_run check_credential: tools.check_credential body: tools.body outputParameters: - type: object mapping: $. - name: get-resource-account description: Get a Resource Account. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getresourceaccount with: orgId: tools.orgId accId: tools.accId outputParameters: - type: object mapping: $. - name: delete-unused-resource-account description: Delete an unused Resource Account. hints: readOnly: false destructive: true idempotent: true call: humanitec-public.deleteresourceaccount with: orgId: tools.orgId accId: tools.accId outputParameters: - type: object mapping: $. - name: update-resource-account description: Update a Resource Account. hints: readOnly: false destructive: false idempotent: true call: humanitec-public.patchresourceaccount with: orgId: tools.orgId accId: tools.accId dry_run: tools.dry_run check_credential: tools.check_credential body: tools.body outputParameters: - type: object mapping: $. - name: check-credentials-existing-resource-account description: Check the credentials of an existing Resource Account hints: readOnly: true destructive: false idempotent: false call: humanitec-public.checkresourceaccount with: orgId: tools.orgId accId: tools.accId outputParameters: - type: object mapping: $. - name: list-resource-classes description: List resource classes. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listresourceclasses with: orgId: tools.orgId outputParameters: - type: object mapping: $. - name: list-resource-definitions description: List Resource Definitions. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listresourcedefinitions with: orgId: tools.orgId app: tools.app env: tools.env env_type: tools.env_type res: tools.res res_type: tools.res_type class: tools.class deleted: tools.deleted outputParameters: - type: object mapping: $. - name: create-new-resource-definition description: Create a new Resource Definition. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createresourcedefinition with: orgId: tools.orgId body: tools.body outputParameters: - type: object mapping: $. - name: get-resource-definition description: Get a Resource Definition. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getresourcedefinition with: orgId: tools.orgId defId: tools.defId deleted: tools.deleted outputParameters: - type: object mapping: $. - name: update-resource-definition description: Update a Resource Definition. hints: readOnly: false destructive: false idempotent: true call: humanitec-public.updateresourcedefinition with: orgId: tools.orgId defId: tools.defId body: tools.body outputParameters: - type: object mapping: $. - name: delete-resource-definition description: Delete a Resource Definition. hints: readOnly: false destructive: true idempotent: true call: humanitec-public.deleteresourcedefinition with: orgId: tools.orgId defId: tools.defId force: tools.force outputParameters: - type: object mapping: $. - name: update-resource-definition-2 description: Update a Resource Definition. hints: readOnly: false destructive: false idempotent: true call: humanitec-public.patchresourcedefinition with: orgId: tools.orgId defId: tools.defId body: tools.body outputParameters: - type: object mapping: $. - name: update-all-matching-criteria-resource description: Update all Matching Criteria of a Resource Definition. hints: readOnly: false destructive: false idempotent: true call: humanitec-public.updateresourcedefinitioncriteria with: orgId: tools.orgId defId: tools.defId body: tools.body outputParameters: - type: object mapping: $. - name: add-new-matching-criteria-resource description: Add a new Matching Criteria to a Resource Definition. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createresourcedefinitioncriteria with: orgId: tools.orgId defId: tools.defId body: tools.body outputParameters: - type: object mapping: $. - name: delete-matching-criteria-resource-definition description: Delete a Matching Criteria from a Resource Definition. hints: readOnly: false destructive: true idempotent: true call: humanitec-public.deleteresourcedefinitioncriteria with: orgId: tools.orgId defId: tools.defId criteriaId: tools.criteriaId force: tools.force outputParameters: - type: object mapping: $. - name: list-active-resources-provisioned-specific description: List Active Resources provisioned via a specific Resource Definition. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listactiveresourcebydefinition with: orgId: tools.orgId defId: tools.defId outputParameters: - type: object mapping: $. - name: get-versions-resource-definition description: Get Versions of a Resource Definition. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listresourcedefinitionversions outputParameters: - type: object mapping: $. - name: get-resource-definition-version description: Get a Resource Definition Version. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getresourcedefinitionversion outputParameters: - type: object mapping: $. - name: mark-unmark-resource-definition-version description: Mark/unmark the Resource Definition Version as archived. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.archiveresourcedefinitionversion with: body: tools.body outputParameters: - type: object mapping: $. - name: promote-resource-definition-version-active description: Promote the Resource Definition Version as active. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.promoteresourcedefinitionversion outputParameters: - type: object mapping: $. - name: list-resource-drivers description: List Resource Drivers. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listresourcedrivers with: orgId: tools.orgId outputParameters: - type: object mapping: $. - name: register-new-resource-driver description: Register a new Resource Driver. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createresourcedriver with: orgId: tools.orgId body: tools.body outputParameters: - type: object mapping: $. - name: get-resource-driver description: Get a Resource Driver. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getresourcedriver with: orgId: tools.orgId driverId: tools.driverId outputParameters: - type: object mapping: $. - name: update-resource-driver description: Update a Resource Driver. hints: readOnly: false destructive: false idempotent: true call: humanitec-public.updateresourcedriver with: orgId: tools.orgId driverId: tools.driverId body: tools.body outputParameters: - type: object mapping: $. - name: delete-resources-driver description: Delete a Resources Driver. hints: readOnly: false destructive: true idempotent: true call: humanitec-public.deleteresourcedriver with: orgId: tools.orgId driverId: tools.driverId outputParameters: - type: object mapping: $. - name: list-resource-types description: List Resource Types. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listresourcetypes with: orgId: tools.orgId outputParameters: - type: object mapping: $. - name: creates-new-resources-type description: Creates a new Resources Type. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createresourcetype with: orgId: tools.orgId body: tools.body outputParameters: - type: object mapping: $. - name: delete-resource-type description: Delete a Resource Type. hints: readOnly: false destructive: true idempotent: true call: humanitec-public.deleteresourcetype with: orgId: tools.orgId typeId: tools.typeId outputParameters: - type: object mapping: $. - name: update-resource-type description: Update a Resource Type. hints: readOnly: false destructive: false idempotent: true call: humanitec-public.patchresourcetype with: orgId: tools.orgId typeId: tools.typeId body: tools.body outputParameters: - type: object mapping: $. - name: update-resource-type-2 description: Update a Resource Type. hints: readOnly: false destructive: false idempotent: true call: humanitec-public.updateresourcetype with: orgId: tools.orgId typeId: tools.typeId body: tools.body outputParameters: - type: object mapping: $. - name: creates-new-resources-class description: Creates a new resources class. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createresourceclass with: orgId: tools.orgId typeId: tools.typeId body: tools.body outputParameters: - type: object mapping: $. - name: get-resource-class-id description: Get resource class by ID. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getresourceclass with: orgId: tools.orgId typeId: tools.typeId classId: tools.classId outputParameters: - type: object mapping: $. - name: update-resource-class-description description: Update a resource class description. hints: readOnly: false destructive: false idempotent: true call: humanitec-public.updateresourceclass with: orgId: tools.orgId typeId: tools.typeId classId: tools.classId body: tools.body outputParameters: - type: object mapping: $. - name: delete-resource-class description: Delete a resource class. hints: readOnly: false destructive: true idempotent: true call: humanitec-public.deleteresourceclass with: orgId: tools.orgId typeId: tools.typeId classId: tools.classId outputParameters: - type: object mapping: $. - name: provision-and-check-cluster-connectivity description: Provision and check the cluster connectivity in an environment hints: readOnly: true destructive: false idempotent: false call: humanitec-public.checkclusterconnectivity with: body: tools.body outputParameters: - type: object mapping: $. - name: get-list-secret-stores-given description: Get list of Secret Stores for the given organization. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.get with: orgId: tools.orgId outputParameters: - type: object mapping: $. - name: create-secret-store-given-organization description: Create a Secret Store for the given organization. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.post with: orgId: tools.orgId body: tools.body outputParameters: - type: object mapping: $. - name: get-secret-store description: Get the Secret Store. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.get with: orgId: tools.orgId storeId: tools.storeId outputParameters: - type: object mapping: $. - name: delete-secret-store description: Delete the Secret Store. hints: readOnly: false destructive: true idempotent: true call: humanitec-public.delete with: orgId: tools.orgId storeId: tools.storeId outputParameters: - type: object mapping: $. - name: update-secret-store description: Update the Secret Store. hints: readOnly: false destructive: false idempotent: true call: humanitec-public.patch with: orgId: tools.orgId storeId: tools.storeId body: tools.body outputParameters: - type: object mapping: $. - name: list-users-and-groups-roles-2 description: List Users and Groups with roles in an Organization hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listuserrolesinorg outputParameters: - type: object mapping: $. - name: creates-new-service-user description: Creates a new service user. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createserviceuserinorg with: body: tools.body outputParameters: - type: object mapping: $. - name: get-role-user-group-organization description: Get the role of a User or a Group on an Organization hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getuserroleinorg outputParameters: - type: object mapping: $. - name: remove-role-user-group-organization description: Remove the role of a User or a Group on an Organization hints: readOnly: false destructive: true idempotent: true call: humanitec-public.deleteuserroleinorg outputParameters: - type: object mapping: $. - name: update-role-user-group-organization description: Update the role of a User or a Group on an Organization hints: readOnly: false destructive: false idempotent: true call: humanitec-public.updateuserroleinorg with: body: tools.body outputParameters: - type: object mapping: $. - name: get-groups-organization-user-belongs description: Get the groups in an organization a user belongs to. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listusergroupsinorg outputParameters: - type: object mapping: $. - name: get-permissions-user-group-objects description: Get the permissions of a User or Group on the objects in an Organization hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getsubjectpermsinorg outputParameters: - type: object mapping: $. - name: add-new-workload-profile-chart description: Add new Workload Profile Chart Version hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createworkloadprofilechartversion with: body: tools.body outputParameters: - type: object mapping: $. - name: workload-profile-chart-versions-given description: Workload Profile Chart Versions for the given organization. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listworkloadprofilechartversions with: id: tools.id version: tools.version outputParameters: - type: object mapping: $. - name: list-workload-profile-features-available description: List workload profile features available to the organization. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listworkloadprofilefeatures outputParameters: - type: object mapping: $. - name: list-workload-profiles-available-organization description: List workload profiles available to the organization. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listworkloadprofiles outputParameters: - type: object mapping: $. - name: create-new-workload-profile description: Create new Workload Profile hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createworkloadprofile with: body: tools.body outputParameters: - type: object mapping: $. - name: get-workload-profile description: Get a Workload Profile hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getworkloadprofile outputParameters: - type: object mapping: $. - name: update-workload-profile description: Update a Workload Profile hints: readOnly: false destructive: false idempotent: true call: humanitec-public.updateworkloadprofile with: body: tools.body outputParameters: - type: object mapping: $. - name: delete-workload-profile description: Delete a Workload Profile hints: readOnly: false destructive: true idempotent: true call: humanitec-public.deleteworkloadprofile outputParameters: - type: object mapping: $. - name: list-versions-given-workload-profile description: List versions of the given workload profile. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listworkloadprofileversions outputParameters: - type: object mapping: $. - name: latest-version-given-workload-profile description: Latest version of the given workload profile with optional constraint. hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getlatestworkloadprofileversion outputParameters: - type: object mapping: $. - name: lists-tokens-associated-user description: Lists tokens associated with a user hints: readOnly: true destructive: false idempotent: true call: humanitec-public.listusertokens with: userId: tools.userId outputParameters: - type: object mapping: $. - name: creates-new-static-token-user description: Creates a new static token for a user. hints: readOnly: false destructive: false idempotent: false call: humanitec-public.createusertoken with: userId: tools.userId body: tools.body outputParameters: - type: object mapping: $. - name: gets-specific-token-associated-user description: Gets a specific token associated with a user hints: readOnly: true destructive: false idempotent: true call: humanitec-public.getusertoken with: userId: tools.userId tokenId: tools.tokenId outputParameters: - type: object mapping: $. - name: deletes-specific-token-associated-user description: Deletes a specific token associated with a user hints: readOnly: false destructive: true idempotent: true call: humanitec-public.deleteusertoken with: userId: tools.userId tokenId: tools.tokenId outputParameters: - type: object mapping: $.