{ "opencollection": "1.0.0", "info": { "name": "Humanitec AccountType public API", "version": "0.28.24" }, "items": [ { "info": { "name": "public", "type": "folder" }, "items": [ { "info": { "name": "List all the agents in an Organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/agents", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "fingerprint", "value": "9be36d7e31323a00e88facdd50843accd95ddbcffaefea28e49c28c08399417d", "type": "query", "description": "The Key fingerprint (hexadecimal representation of sha256 hash of the DER representation of the key)." } ] }, "docs": "List all the agents in an Organization." }, { "info": { "name": "Register a new Agent under an Organization.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/agents", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Register a new Agent under an Organization." }, { "info": { "name": "Update the description of an Agent.", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.humanitec.io/orgs/:orgId/agents/:agentId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "agentId", "value": "my-agent", "type": "path", "description": "The Agent id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the description of an Agent." }, { "info": { "name": "Delete an Agent (and its keys) stored under an Organization.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/agents/:agentId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "agentId", "value": "my-agent", "type": "path", "description": "The Agent id." } ] }, "docs": "Delete an Agent (and its keys) stored under an Organization." }, { "info": { "name": "List all the keys registered under an Agent in an Organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/agents/:agentId/keys", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "agentId", "value": "my-agent", "type": "path", "description": "The Agent id." } ] }, "docs": "List all the keys registered under an Agent in an Organization." }, { "info": { "name": "Register a new Key under an Agent in an Organization.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/agents/:agentId/keys", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "agentId", "value": "my-agent", "type": "path", "description": "The Agent id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Register a new Key under an Agent in an Organization." }, { "info": { "name": "Delete a key registered under a Agent.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/agents/:agentId/keys/:fingerprint", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "agentId", "value": "my-agent", "type": "path", "description": "The Agent id." }, { "name": "fingerprint", "value": "9be36d7e31323a00e88facdd50843accd95ddbcffaefea28e49c28c08399417d", "type": "path", "description": "The Key fingerprint (hexadecimal representation of sha256 hash of the DER representation of the key)." } ] }, "docs": "Delete a key registered under a Agent." }, { "info": { "name": "List all Applications in an Organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" } ] }, "docs": "Listing or lists of all Applications that exist within a specific Organization." }, { "info": { "name": "Add a new Application to an Organization", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Application, then adds it to the specified Organization." }, { "info": { "name": "Get an existing Application", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" } ] }, "docs": "Gets a specific Application in the specified Organization by ID." }, { "info": { "name": "Update metadata of an existing Application", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update metadata of an existing Application in the specified Organization." }, { "info": { "name": "Delete an Application", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" } ] }, "docs": "Deleting an Application will also delete everything associated with it. This includes Environments, Deployment history on those Environments, and any shared values and secrets associated.\n\n_Deletions are currently irreversible._" }, { "info": { "name": "List all Environments.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" } ] }, "docs": "Lists all of the Environments in the Application." }, { "info": { "name": "Add a new Environment to an Application.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Environment of the specified Type and associates it with the Application specified by `appId`.\n\nThe Environment is also initialized to the **current or past state of Deployment in another Environment**. This ensures that every Environment is derived from a previously known state. This means it is not possible to create a new Environment for an Application until at least one Deployment has occurred. (The Deployment does not have to be successful.)\n\nThe Type of the Environment must b" }, { "info": { "name": "Get a specific Environment.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "envId", "value": "", "type": "path", "description": "The Environment ID.\n\n" } ] }, "docs": "Gets a specific Environment in an Application." }, { "info": { "name": "Update a specific Environment.", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "envId", "value": "", "type": "path", "description": "The Environment ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific Environment in an Application." }, { "info": { "name": "Delete a specific Environment.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "envId", "value": "", "type": "path", "description": "The Environment ID.\n\n" } ] }, "docs": "Deletes a specific Environment in an Application.\n\nDeleting an Environment will also delete the Deployment history of the Environment.\n\n_Deletions are currently irreversible._" }, { "info": { "name": "List Deployments in an Environment.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/deploys", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "envId", "value": "", "type": "path", "description": "The Environment ID.\n\n" }, { "name": "pipelineRunId", "value": "default,01234567-89ab-cdef-0123-456789abcdef", "type": "query", "description": "An optional filter by the Pipeline and Pipeline Run ID separated by a comma.\n" } ] }, "docs": "List all of the Deployments that have been carried out in the current Environment. Deployments are returned with the newest first." }, { "info": { "name": "Start a new Deployment.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/deploys", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "envId", "value": "", "type": "path", "description": "The Environment ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "At Humanitec, Deployments are defined as changes to the state of the Environment. The state can be changed by defining a set of desired changes to the current state via a Deployment Delta or by resetting the current state after a previous Deployment. (See Environment Rebase.) Both types of changes can be combined into a single Deployment during which the Delta is applied to the Rebased state.\n\nWhen specifying a Delta, a Delta ID must be used. That Delta must have been committed to the Delta stor" }, { "info": { "name": "Get a specific Deployment.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/deploys/:deployId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "envId", "value": "", "type": "path", "description": "The Environment ID.\n\n" }, { "name": "deployId", "value": "", "type": "path", "description": "The Deployment ID.\n\n" } ] }, "docs": "Gets a specific Deployment in an Application and an Environment." }, { "info": { "name": "List errors that occurred in a Deployment.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/deploys/:deployId/errors", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "envId", "value": "", "type": "path", "description": "The Environment ID.\n\n" }, { "name": "deployId", "value": "", "type": "path", "description": "The Deployment ID.\n\n" } ] }, "docs": "List errors that occurred in a Deployment." }, { "info": { "name": "Rebase to a different Deployment.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/from_deploy_id", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "envId", "value": "", "type": "path", "description": "The Environment ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Rebasing an Environment means that the next Deployment to the Environment will be based on the Deployment specified in the rebase rather than the last one in the Environment. The Deployment to rebase to can either be current or a previous Deployment. The Deployment can be from any Environment of the same Application.\n\n_Running code will only be affected on the next Deployment to the Environment._\n\nCommon use cases for rebasing an Environment:\n\n* _Rollback_: Rebasing to a previous Deployment in t" }, { "info": { "name": "List all Environment Types", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/env-types", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" } ] }, "docs": "Lists all Environment Types in an Organization." }, { "info": { "name": "Add a new Environment Type", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/env-types", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new Environment Type to an Organization." }, { "info": { "name": "Get an Environment Type", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/env-types/:envTypeId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "envTypeId", "value": "", "type": "path", "description": "ID of the Environment Type.\n\n" } ] }, "docs": "Gets a specific Environment Type within an Organization." }, { "info": { "name": "Updates Environment Type", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.humanitec.io/orgs/:orgId/env-types/:envTypeId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "envTypeId", "value": "", "type": "path", "description": "ID of the Environment Type.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates Environment Type." }, { "info": { "name": "Deletes an Environment Type", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/env-types/:envTypeId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "envTypeId", "value": "", "type": "path", "description": "ID of the Environment Type.\n\n" } ] }, "docs": "Deletes a specific Environment Type from an Organization. If there are Environments with this Type in the Organization, the operation will fail." }, { "info": { "name": "List all Artefacts Versions in the org.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/artefact-versions", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The organization ID." }, { "name": "name", "value": "registry.humanitec.io/public/sample-app", "type": "query", "description": "(Optional) Filter Artefact Versions by name." }, { "name": "reference", "value": "registry.humanitec.io/public/sample-app:v1@sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244", "type": "query", "description": "(Optional) Filter Artefact Versions by the reference to a Version of the same Artefact. This cannot be used together with `name`." }, { "name": "archived", "value": "false", "type": "query", "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 archived and non-archived Versions are returned." }, { "name": "type", "value": "containers", "type": "query", "description": "(Optional) Filter by artefact type." } ] }, "docs": "Returns the Artefact Versions registered with your organization. If no elements are found, an empty list is returned." }, { "info": { "name": "Register a new Artefact Version with your organization.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/artefact-versions", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The organization ID." }, { "name": "vcs", "value": "git", "type": "query", "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 ref, if not empty, is checked to ensure that it has the prefix \"refs/\"." }, { "name": "dry_run", "value": "false", "type": "query", "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 \"application/x.workload-deployment-set+x-yaml\", the generated deployment set will be returned." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Register a new Artefact Version with your organization." }, { "info": { "name": "Get an Artefacts Versions.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/artefact-versions/:artefactVersionId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The organization ID." }, { "name": "artefactVersionId", "value": "662b80db-cc71-40cf-b601-08d57983f6e4", "type": "path", "description": "The Artefact Version ID." } ] }, "docs": "Returns a specific Artefact Version." }, { "info": { "name": "Get the spec of this Workload Artefact Version", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/artefact-versions/:artefactVersionId/workload-spec", "headers": [ { "name": "Accept", "value": "application/json" } ], "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The organization ID." }, { "name": "artefactVersionId", "value": "662b80db-cc71-40cf-b601-08d57983f6e4", "type": "path", "description": "The Artefact Version ID." } ] }, "docs": "Returns the spec of this Artefact Version if it is of type workload. An error will be\nreturned if it is not.\n" }, { "info": { "name": "Get the Humanitec module definition of this Workload Artefact Version as a deployment set", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/artefact-versions/:artefactVersionId/workload-deployment-set", "headers": [ { "name": "Accept", "value": "application/json" } ], "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The organization ID." }, { "name": "artefactVersionId", "value": "662b80db-cc71-40cf-b601-08d57983f6e4", "type": "path", "description": "The Artefact Version ID." } ] }, "docs": "Returns the Humanitec workload module of this Artefact Version if it is of type workload. An error will be\nreturned if it is not.\n" }, { "info": { "name": "List all Artefacts.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/artefacts", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The organization ID." }, { "name": "type", "value": "container", "type": "query", "description": "(Optional) Filter Artefacts by type." }, { "name": "name", "value": "registry.humanitec.io/public/sample-app", "type": "query", "description": "(Optional) Filter Artefacts by name." } ] }, "docs": "Returns the Artefacts registered with your organization. If no elements are found, an empty list is returned." }, { "info": { "name": "Delete Artefact and all related Artefact Versions", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/artefacts/:artefactId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The organization ID." }, { "name": "artefactId", "value": "da97af75-2e7c-4ef3-bec0-755ce1e8dd29", "type": "path", "description": "The Artefact ID." } ] }, "docs": "The specified Artefact and its Artefact Versions will be permanently deleted. Only Administrators can delete an Artefact." }, { "info": { "name": "List all Artefact Versions of an Artefact.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/artefacts/:artefactId/versions", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The organization ID." }, { "name": "artefactId", "value": "da97af75-2e7c-4ef3-bec0-755ce1e8dd29", "type": "path", "description": "The Artefact ID." }, { "name": "archived", "value": "false", "type": "query", "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 archived and non-archived Versions are returned." }, { "name": "reference", "value": "registry.humanitec.io/public/sample-app:v1@sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244", "type": "query", "description": "(Optional) Filter Artefact Versions by by name including a version or digest." }, { "name": "limit", "value": "20", "type": "query", "description": "(Optional) Limit the number of versions returned by the endpoint." } ] }, "docs": "Returns the Artefact Versions of a specified Artefact registered with your organization. If no elements are found, an empty list is returned." }, { "info": { "name": "Update Version of an Artefact.", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.humanitec.io/orgs/:orgId/artefacts/:artefactId/versions/:versionId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The organization ID." }, { "name": "artefactId", "value": "da97af75-2e7c-4ef3-bec0-755ce1e8dd29", "type": "path", "description": "The Artefact ID." }, { "name": "versionId", "value": "da97af75-2e7c-4ef3-bec0-755ce1e8dd29", "type": "path", "description": "The Version ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the version of a specified Artefact registered with your organization\"." }, { "info": { "name": "List all Container Images", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/images", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The organization ID." } ] }, "docs": "DEPRECATED: This endpoint exists for historical compatibility and should not be used. Please use the [Artefact API](https://api-docs.humanitec.com/#tag/Artefact) instead.\n\nLists all of the Container Images registered for this organization." }, { "info": { "name": "Get a specific Image Object", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/images/:imageId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The organization ID." }, { "name": "imageId", "value": "sample-app", "type": "path", "description": "The Image ID." } ] }, "docs": "DEPRECATED: This endpoint exists for historical compatibility and should not be used. Please use the [Artefact API](https://api-docs.humanitec.com/#tag/Artefact) instead.\n\nThe response includes a list of Image Builds as well as some metadata about the Image such as its Image Source.\n\nNote, `imageId` may not be the same as the container name. `imageId` is determined by the system making notifications about new builds." }, { "info": { "name": "Lists all the Builds of an Image", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/images/:imageId/builds", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The organization ID." }, { "name": "imageId", "value": "sample-app", "type": "path", "description": "The Image ID." } ] }, "docs": "DEPRECATED: This endpoint exists for historical compatibility and should not be used. Please use the [Artefact API](https://api-docs.humanitec.com/#tag/Artefact) instead.\n\nThe response lists all available Image Builds of an Image." }, { "info": { "name": "Add a new Image Build", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/images/:imageId/builds", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The organization ID." }, { "name": "imageId", "value": "sample-app", "type": "path", "description": "The Image ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "DEPRECATED: This endpoint exists for historical compatibility and should not be used. Please use the [Artefact API](https://api-docs.humanitec.com/#tag/Artefact) instead.\n\nThis endpoint is used by Continuous Integration (CI) pipelines to notify Humanitec that a new Image Build is available.\n\nIf there is no Image with ID `imageId`, it will be automatically created." }, { "info": { "name": "Convert a Score specification, optional overrides, and extensions into the contents for a deployment set.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/artefact-versions/convert-score", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The organization ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Convert a Score specification, optional overrides, and extensions into the contents for a deployment set." }, { "info": { "name": "List audit log entries by Organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/audit-logs", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "per_page", "value": "50", "type": "query", "description": "The maximum number of items to return in a page of results" }, { "name": "page", "value": "AAAAAAAAAA==", "type": "query", "description": "The page token to request from" }, { "name": "from", "value": "2023-01-01T00:00:00Z", "type": "query", "description": "Optional filter for entries created after the given time." }, { "name": "to", "value": "2023-01-01T00:00:00Z", "type": "query", "description": "Optional filter for entries created before the given time." } ] }, "docs": "List all available audit log entries in the Organization that match the specified filters. This API returns entries from newest to oldest and is paginated. Only successful create, modify, or delete requests are stored in the audit log. This API may return a lot of data, depending on the size of the Organization, so it is recommended to use the \"to\" and \"from\" query parameters to limit the returned data to the time window of interest. Each response contains at most 32 days worth of data for per" }, { "info": { "name": "List all Automation Rules in an Environment.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/rules", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "envId", "value": "development", "type": "path", "description": "The Environment ID" } ] }, "docs": "List all Automation Rules in an Environment." }, { "info": { "name": "Create a new Automation Rule for an Environment.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/rules", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "envId", "value": "development", "type": "path", "description": "The Environment ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`." }, { "info": { "name": "Get a specific Automation Rule for an Environment.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/rules/:ruleId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "envId", "value": "development", "type": "path", "description": "The Environment ID" }, { "name": "ruleId", "value": "", "type": "path", "description": "The Automation Rule ID." } ] }, "docs": "Get a specific Automation Rule for an Environment." }, { "info": { "name": "Update an existing Automation Rule for an Environment.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/rules/:ruleId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "envId", "value": "development", "type": "path", "description": "The Environment ID" }, { "name": "ruleId", "value": "", "type": "path", "description": "The Automation Rule ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if `images_filter` (deprecated) and `artefacts_filter` are used in the same payload. The same is true for `exclude_images_filter` (deprecated) and `exclude_artefacts_filter`. `match` and `update_to` are still supported but will trigger an error if combined with `match_ref`." }, { "info": { "name": "Delete Automation Rule from an Environment.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/rules/:ruleId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "envId", "value": "development", "type": "path", "description": "The Environment ID" }, { "name": "ruleId", "value": "", "type": "path", "description": "The Automation Rule ID." } ] }, "docs": "Delete Automation Rule from an Environment." }, { "info": { "name": "List Deltas in an Application", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/deltas", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "archived", "value": "", "type": "query", "description": "If true, return archived Deltas.\n\n" }, { "name": "env", "value": "", "type": "query", "description": "Only return Deltas associated with the specified Environment.\n\n" } ] }, "docs": "List Deltas in an Application" }, { "info": { "name": "Create a new Delta", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/deltas", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Delta" }, { "info": { "name": "Fetch an existing Delta", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/deltas/:deltaId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "deltaId", "value": "", "type": "path", "description": "ID of the Delta to fetch.\n\n" } ] }, "docs": "Fetch an existing Delta" }, { "info": { "name": "Update an existing Delta", "type": "http" }, "http": { "method": "PUT", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/deltas/:deltaId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "deltaId", "value": "", "type": "path", "description": "ID of the Delta to update.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Delta" }, { "info": { "name": "Update an existing Delta", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/deltas/:deltaId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "deltaId", "value": "", "type": "path", "description": "ID of the Delta to update.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Delta" }, { "info": { "name": "Mark a Delta as \"archived\"", "type": "http" }, "http": { "method": "PUT", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/deltas/:deltaId/metadata/archived", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "deltaId", "value": "", "type": "path", "description": "ID of the Deployment Delta.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Archived Deltas are still accessible but can no longer be updated." }, { "info": { "name": "Change the Environment of a Delta", "type": "http" }, "http": { "method": "PUT", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/deltas/:deltaId/metadata/env_id", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "deltaId", "value": "", "type": "path", "description": "ID of the Deployment Delta.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the Environment of a Delta" }, { "info": { "name": "Change the name of a Delta", "type": "http" }, "http": { "method": "PUT", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/deltas/:deltaId/metadata/name", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "deltaId", "value": "", "type": "path", "description": "ID of the Deployment Delta.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the name of a Delta" }, { "info": { "name": "Get all Deployment Sets", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/sets", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" } ] }, "docs": "Get all Deployment Sets" }, { "info": { "name": "Get a Deployment Set", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/sets/:setId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "setId", "value": "", "type": "path", "description": "ID of the Deployment Set.\n\n" }, { "name": "diff", "value": "", "type": "query", "description": "ID of the Deployment Set to compared against." } ] }, "docs": "Get a Deployment Set" }, { "info": { "name": "Apply a Deployment Delta to a Deployment Set", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/sets/:setId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "setId", "value": "", "type": "path", "description": "ID of the Deployment Set.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Apply a Deployment Delta to a Deployment Set" }, { "info": { "name": "Get Resource Inputs for the given Deployment Set", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/sets/:setId/resources", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "setId", "value": "", "type": "path", "description": "ID of the Deployment Set." } ] }, "docs": "Get Resource Inputs for the given Deployment Set" }, { "info": { "name": "Get the difference between 2 Deployment Sets", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/sets/:setId/diff/:sourceSetId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "setId", "value": "", "type": "path", "description": "ID of the Deployment Set.\n\n" }, { "name": "sourceSetId", "value": "", "type": "path", "description": "ID of the Deployment Set to diff against.\n\n" } ] }, "docs": "Get the difference between 2 Deployment Sets" }, { "info": { "name": "Deletes all Jobs for the Application", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/jobs", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" } ] }, "docs": "Deletes all Jobs for the Application" }, { "info": { "name": "List Webhooks", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/webhooks", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" } ] }, "docs": "List Webhooks" }, { "info": { "name": "Create a new Webhook", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/webhooks", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Webhook" }, { "info": { "name": "Get a Webhook", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/webhooks/:jobId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "jobId", "value": "", "type": "path", "description": "The Webhook ID.\n\n" } ] }, "docs": "Get a Webhook" }, { "info": { "name": "Update a Webhook", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/webhooks/:jobId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "jobId", "value": "", "type": "path", "description": "The Webhook ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Webhook" }, { "info": { "name": "Delete a Webhook", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/webhooks/:jobId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "jobId", "value": "", "type": "path", "description": "The Webhook ID.\n\n" } ] }, "docs": "Delete a Webhook" }, { "info": { "name": "List Events", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/events", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" } ] }, "docs": "List Events" }, { "info": { "name": "List all public keys associated to an organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/keys", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The organization ID." }, { "name": "fingerprint", "value": "", "type": "query", "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 result will contain a single key, if any." } ] }, "docs": "List all public keys associated to an organization." }, { "info": { "name": "Associate a new RSA public key to an organization.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/keys", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The organization ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associate a new RSA public key to an organization." }, { "info": { "name": "Retrieve a single public key associated to an organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/keys/:keyId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The organization ID." }, { "name": "keyId", "value": "", "type": "path", "description": "The public key ID." } ] }, "docs": "Retrieve a single public key associated to an organization." }, { "info": { "name": "Delete a public key associated to an organization.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/keys/:keyId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The organization ID." }, { "name": "keyId", "value": "", "type": "path", "description": "The public key ID." } ] }, "docs": "Delete a public key associated to an organization." }, { "info": { "name": "List all the public keys Humanitec shares with an organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/humanitec-keys", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The organization ID." }, { "name": "active", "value": "", "type": "query", "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." } ] }, "docs": "List all the public keys Humanitec shares with an organization." }, { "info": { "name": "Get container log entries for the environment", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/logs", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID\n\n" }, { "name": "envId", "value": "", "type": "path", "description": "The Environment ID\n\n" }, { "name": "workload_id", "value": "", "type": "query", "description": "filter by workload ID\n\n" }, { "name": "container_id", "value": "", "type": "query", "description": "filter by container ID\n\n" }, { "name": "deployment_id", "value": "", "type": "query", "description": "filter by deployment ID\n\n" }, { "name": "timestamp_from", "value": "", "type": "query", "description": "filter by min time, RFC 3339 format, e.g. \"2021-10-02T15:01:23.045Z\"\n\n" }, { "name": "timestamp_to", "value": "", "type": "query", "description": "filter by max time, RFC 3330 format, e.g. \"2021-10-02T15:01:23.045Z\"\n\n" }, { "name": "limit", "value": "", "type": "query", "description": "limit log entries returned\n\n" }, { "name": "asc", "value": "", "type": "query", "description": "if true request results in ascending order, default order is descending\n\n" }, { "name": "invert", "value": "", "type": "query", "description": "if true reverse the order of the log entries in the output\n\n" } ] }, "docs": "Get container log entries for the environment" }, { "info": { "name": "List active organizations the user has access to.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs" }, "docs": "List active organizations the user has access to." }, { "info": { "name": "Get the specified Organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" } ] }, "docs": "Get the specified Organization." }, { "info": { "name": "List all Pipelines within an Organization. This can be filtered by Application.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/pipelines", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "app", "value": "", "type": "query", "description": "An optional list of Application IDs." }, { "name": "per_page", "value": "50", "type": "query", "description": "The maximum number of items to return in a page of results" }, { "name": "page", "value": "AAAAAAAAAA==", "type": "query", "description": "The page token to request from" }, { "name": "trigger", "value": "pipeline_call", "type": "query", "description": "An optional filter by trigger type." }, { "name": "metadata", "value": "", "type": "query", "description": "Optional filter by pipeline metadata" } ] }, "docs": "List all Pipelines within an Organization. This can be filtered by Application." }, { "info": { "name": "List Pipelines within an Application.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipelines", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "per_page", "value": "50", "type": "query", "description": "The maximum number of items to return in a page of results" }, { "name": "page", "value": "AAAAAAAAAA==", "type": "query", "description": "The page token to request from" }, { "name": "trigger", "value": "pipeline_call", "type": "query", "description": "An optional filter by trigger type." }, { "name": "metadata", "value": "", "type": "query", "description": "Optional filter by pipeline metadata" } ] }, "docs": "List Pipelines within an Application." }, { "info": { "name": "Create a Pipeline within an Application.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipelines", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "dry_run", "value": "false", "type": "query", "description": "Optionally validate the request but do not persist the actual Pipeline." } ] }, "docs": "Create a Pipeline within an Application." }, { "info": { "name": "Get a Pipeline within an Application.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipelines/:pipelineId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "pipelineId", "value": "sample-pipeline", "type": "path", "description": "The Pipeline ID" }, { "name": "version", "value": "01234567-89ab-cdef-0123-456789abcdef", "type": "query", "description": "An optional Pipeline Version ID." } ] }, "docs": "Get a Pipeline within an Application." }, { "info": { "name": "update a Pipeline within an Application.", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipelines/:pipelineId", "headers": [ { "name": "If-Match", "value": "1234567890abcdef" } ], "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "pipelineId", "value": "sample-pipeline", "type": "path", "description": "The Pipeline ID" }, { "name": "dry_run", "value": "false", "type": "query", "description": "Optionally validate the request but do not persist the update." } ] }, "docs": "update a Pipeline within an Application." }, { "info": { "name": "Delete a pipeline within an application.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipelines/:pipelineId", "headers": [ { "name": "If-Match", "value": "1234567890abcdef" } ], "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "pipelineId", "value": "sample-pipeline", "type": "path", "description": "The Pipeline ID" } ] }, "docs": "Delete a pipeline within an application." }, { "info": { "name": "List all versions of the pipeline", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipelines/:pipelineId/versions", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "pipelineId", "value": "sample-pipeline", "type": "path", "description": "The Pipeline ID" }, { "name": "per_page", "value": "50", "type": "query", "description": "The maximum number of items to return in a page of results" }, { "name": "page", "value": "AAAAAAAAAA==", "type": "query", "description": "The page token to request from" } ] }, "docs": "List all versions of the pipeline" }, { "info": { "name": "Get a pipeline schema.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipelines/:pipelineId/schema", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "pipelineId", "value": "sample-pipeline", "type": "path", "description": "The Pipeline ID" }, { "name": "version", "value": "01234567-89ab-cdef-0123-456789abcdef", "type": "query", "description": "An optional Pipeline Version ID." } ] }, "docs": "Get a pipeline schema." }, { "info": { "name": "List the trigger matching criteria defined for Pipelines in this Application.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipeline-criteria", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "pipeline", "value": "", "type": "query", "description": "An optional filter by Pipeline ID." }, { "name": "match", "value": "[object Object]", "type": "query", "description": "Optional key value match filters on the criteria." }, { "name": "per_page", "value": "50", "type": "query", "description": "The maximum number of items to return in a page of results" }, { "name": "page", "value": "AAAAAAAAAA==", "type": "query", "description": "The page token to request from" } ] }, "docs": "Lists the trigger matching criteria defined for Pipelines in this Application. Trigger matching criteria link requests in an environment to the appropriate Pipeline based on the trigger and inputs.\n" }, { "info": { "name": "Create a new trigger matching criteria for this Pipeline.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipelines/:pipelineId/criteria", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "pipelineId", "value": "sample-pipeline", "type": "path", "description": "The Pipeline ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new trigger matching criteria for this Pipeline. This must not conflict with an existing criteria for the same trigger on this or any other Pipeline that applies to this Application.\n" }, { "info": { "name": "Get the Pipeline Criteria with the given id.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipelines/:pipelineId/criteria/:criteriaId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "pipelineId", "value": "sample-pipeline", "type": "path", "description": "The Pipeline ID" }, { "name": "criteriaId", "value": "01234567-89ab-cdef-0123-456789abcdef", "type": "path", "description": "The Criteria ID" } ] }, "docs": "Get the Pipeline Criteria with the given id." }, { "info": { "name": "Delete the Pipeline Criteria with the given id.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipelines/:pipelineId/criteria/:criteriaId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "pipelineId", "value": "sample-pipeline", "type": "path", "description": "The Pipeline ID" }, { "name": "criteriaId", "value": "01234567-89ab-cdef-0123-456789abcdef", "type": "path", "description": "The Criteria ID" } ] }, "docs": "Delete the Pipeline Criteria with the given id." }, { "info": { "name": "Gets the latest pipeline schema", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/pipeline-schemas/latest", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" } ] }, "docs": "Gets the latest pipeline schema" }, { "info": { "name": "List all pipeline runs within the Org ordered newest to oldest. This can be filtered by app, pipeline, and status.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/pipeline-runs", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "app", "value": "", "type": "query", "description": "An optional list of Application IDs." }, { "name": "pipeline", "value": "", "type": "query", "description": "An optional list of Pipeline IDs." }, { "name": "env", "value": "", "type": "query", "description": "An optional Environment ID" }, { "name": "status", "value": "", "type": "query", "description": "Optional filter by status." }, { "name": "completed", "value": "true", "type": "query", "description": "Optional filer by completed or not." }, { "name": "created_after", "value": "2018-03-20T09:12:28Z", "type": "query", "description": "Optional filter by creation after date time." }, { "name": "created_before", "value": "2018-03-20T09:12:28Z", "type": "query", "description": "Optional filter by creation before date time" }, { "name": "per_page", "value": "50", "type": "query", "description": "The maximum number of items to return in a page of results" }, { "name": "page", "value": "AAAAAAAAAA==", "type": "query", "description": "The page token to request from" } ] }, "docs": "List all pipeline runs within the Org ordered newest to oldest. This can be filtered by app, pipeline, and status." }, { "info": { "name": "Create a Pipeline Run in the appropriate Pipeline based on the trigger and inputs.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipeline-runs", "headers": [ { "name": "Idempotency-Key", "value": "0xr$P0Cu4@DB" } ], "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "dry_run", "value": "false", "type": "query", "description": "Optionally validate the request but do not persist the actual Pipeline Run." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Pipeline Run in the appropriate Pipeline based on the trigger and inputs." }, { "info": { "name": "List runs within a pipeline ordered newest to oldest.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipelines/:pipelineId/runs", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "pipelineId", "value": "sample-pipeline", "type": "path", "description": "The Pipeline ID" }, { "name": "env", "value": "", "type": "query", "description": "An optional Environment ID" }, { "name": "status", "value": "", "type": "query", "description": "Optional filter by status." }, { "name": "completed", "value": "true", "type": "query", "description": "Optional filer by completed or not." }, { "name": "created_after", "value": "2018-03-20T09:12:28Z", "type": "query", "description": "Optional filter by creation after date time." }, { "name": "created_before", "value": "2018-03-20T09:12:28Z", "type": "query", "description": "Optional filter by creation before date time" }, { "name": "per_page", "value": "50", "type": "query", "description": "The maximum number of items to return in a page of results" }, { "name": "page", "value": "AAAAAAAAAA==", "type": "query", "description": "The page token to request from" } ] }, "docs": "List runs within a pipeline ordered newest to oldest." }, { "info": { "name": "Create a run within a pipeline.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipelines/:pipelineId/runs", "headers": [ { "name": "Idempotency-Key", "value": "0xr$P0Cu4@DB" } ], "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "pipelineId", "value": "sample-pipeline", "type": "path", "description": "The Pipeline ID" }, { "name": "dry_run", "value": "false", "type": "query", "description": "Optionally validate the request but do not persist the actual Pipeline Run." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a run within a pipeline." }, { "info": { "name": "Get a run within an pipeline.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipelines/:pipelineId/runs/:runId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "pipelineId", "value": "sample-pipeline", "type": "path", "description": "The Pipeline ID" }, { "name": "runId", "value": "01234567-89ab-cdef-0123-456789abcdef", "type": "path", "description": "The Run ID" } ] }, "docs": "Get a run within an pipeline." }, { "info": { "name": "Deleting a completed Run within a Pipeline.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipelines/:pipelineId/runs/:runId", "headers": [ { "name": "If-Match", "value": "1234567890abcdef" } ], "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "pipelineId", "value": "sample-pipeline", "type": "path", "description": "The Pipeline ID" }, { "name": "runId", "value": "01234567-89ab-cdef-0123-456789abcdef", "type": "path", "description": "The Run ID" } ] }, "docs": "Deleting a completed Run within a Pipeline." }, { "info": { "name": "Cancel a Run within an Pipeline.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipelines/:pipelineId/runs/:runId/cancel", "headers": [ { "name": "If-Match", "value": "1234567890abcdef" } ], "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "pipelineId", "value": "sample-pipeline", "type": "path", "description": "The Pipeline ID" }, { "name": "runId", "value": "01234567-89ab-cdef-0123-456789abcdef", "type": "path", "description": "The Run ID" } ] }, "docs": "Attempts to cancel the specified Run. If the Run is in a queued state, this cancellation will be applied\nimmediately. If the Run is executing, the cancellation will be stored and will be resolved by the next\nJob or Step that supports in-flight cancellation. Runs that are in any other state, are not cancellable.\n" }, { "info": { "name": "Restart a Run within an Pipeline by cloning it with the same trigger and inputs.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipelines/:pipelineId/runs/:runId/restart", "headers": [ { "name": "Idempotency-Key", "value": "0xr$P0Cu4@DB" } ], "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "pipelineId", "value": "sample-pipeline", "type": "path", "description": "The Pipeline ID" }, { "name": "runId", "value": "01234567-89ab-cdef-0123-456789abcdef", "type": "path", "description": "The Run ID" } ] }, "docs": "Attempts to copy and restart the specified Run. The run must be in a completed state.\n" }, { "info": { "name": "List the details of the jobs within a pipeline run.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipelines/:pipelineId/runs/:runId/jobs", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "pipelineId", "value": "sample-pipeline", "type": "path", "description": "The Pipeline ID" }, { "name": "runId", "value": "01234567-89ab-cdef-0123-456789abcdef", "type": "path", "description": "The Run ID" }, { "name": "status", "value": "", "type": "query", "description": "Optional filter by status." }, { "name": "per_page", "value": "50", "type": "query", "description": "The maximum number of items to return in a page of results" }, { "name": "page", "value": "AAAAAAAAAA==", "type": "query", "description": "The page token to request from" } ] }, "docs": "List the details of the jobs within a pipeline run." }, { "info": { "name": "List the details of a Job including Step information", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipelines/:pipelineId/runs/:runId/jobs/:jobId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "pipelineId", "value": "sample-pipeline", "type": "path", "description": "The Pipeline ID" }, { "name": "runId", "value": "01234567-89ab-cdef-0123-456789abcdef", "type": "path", "description": "The Run ID" }, { "name": "jobId", "value": "deploy", "type": "path", "description": "The Job ID" } ] }, "docs": "List the details of a Job including Step information" }, { "info": { "name": "Get a page of log output for a given step within a job.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipelines/:pipelineId/runs/:runId/jobs/:jobId/steps/:stepIndex/logs", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "pipelineId", "value": "sample-pipeline", "type": "path", "description": "The Pipeline ID" }, { "name": "runId", "value": "01234567-89ab-cdef-0123-456789abcdef", "type": "path", "description": "The Run ID" }, { "name": "jobId", "value": "deploy", "type": "path", "description": "The Job ID" }, { "name": "stepIndex", "value": "0", "type": "path", "description": "The index of the step within the Job" }, { "name": "page", "value": "AAAAAAAAAA==", "type": "query", "description": "The page token to request from" } ] }, "docs": "Get a page of log output for a given step within a job." }, { "info": { "name": "List of the approval requests", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/approvals", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "per_page", "value": "50", "type": "query", "description": "The maximum number of items to return in a page of results" }, { "name": "page", "value": "AAAAAAAAAA==", "type": "query", "description": "The page token to request from" }, { "name": "pipeline", "value": "", "type": "query", "description": "An optional list of Pipeline IDs." }, { "name": "run", "value": "", "type": "query", "description": "An optional Pipeline Run ID." }, { "name": "status", "value": "denied", "type": "query", "description": "Optional filter by status." } ] }, "docs": "List of the approval requests with in an app.\n" }, { "info": { "name": "Get an approval request", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipelines/:pipelineId/runs/:runId/jobs/:jobId/approvals/:approvalId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "pipelineId", "value": "sample-pipeline", "type": "path", "description": "The Pipeline ID" }, { "name": "runId", "value": "01234567-89ab-cdef-0123-456789abcdef", "type": "path", "description": "The Run ID" }, { "name": "jobId", "value": "deploy", "type": "path", "description": "The Job ID" }, { "name": "approvalId", "value": "01234567-89ab-cdef-0123-456789abcdef", "type": "path", "description": "The Approval ID" } ] }, "docs": "Get an approval request." }, { "info": { "name": "Approve the approval request", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipelines/:pipelineId/runs/:runId/jobs/:jobId/approvals/:approvalId/approve", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "pipelineId", "value": "sample-pipeline", "type": "path", "description": "The Pipeline ID" }, { "name": "runId", "value": "01234567-89ab-cdef-0123-456789abcdef", "type": "path", "description": "The Run ID" }, { "name": "jobId", "value": "deploy", "type": "path", "description": "The Job ID" }, { "name": "approvalId", "value": "01234567-89ab-cdef-0123-456789abcdef", "type": "path", "description": "The Approval ID" } ] }, "docs": "Approve the approval requested." }, { "info": { "name": "Deny the approval request", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipelines/:pipelineId/runs/:runId/jobs/:jobId/approvals/:approvalId/deny", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "pipelineId", "value": "sample-pipeline", "type": "path", "description": "The Pipeline ID" }, { "name": "runId", "value": "01234567-89ab-cdef-0123-456789abcdef", "type": "path", "description": "The Run ID" }, { "name": "jobId", "value": "deploy", "type": "path", "description": "The Job ID" }, { "name": "approvalId", "value": "01234567-89ab-cdef-0123-456789abcdef", "type": "path", "description": "The Approval ID" } ] }, "docs": "Deny the approval requested." }, { "info": { "name": "Read the current state of a trigger batch", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/pipelines/:pipelineId/batches/:batchType", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "pipelineId", "value": "sample-pipeline", "type": "path", "description": "The Pipeline ID" }, { "name": "batchType", "value": "artefact", "type": "path", "description": "The batch type, only artefact is implemented." } ] }, "docs": "Read the current state of a trigger batch for a Pipeline if one exists" }, { "info": { "name": "Lists available registries for the organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/registries", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "Unique (alpha-numerical) organization identifier.\n\n" } ] }, "docs": "Lists available registries for the organization." }, { "info": { "name": "Creates a new registry record.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/registries", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "Unique (alpha-numerical) organization identifier.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new registry record." }, { "info": { "name": "Loads a registry record details.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/registries/:regId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "Unique (alpha-numerical) organization identifier.\n\n" }, { "name": "regId", "value": "", "type": "path", "description": "Unique (alpha-numerical) registry identifier.\n\n" } ] }, "docs": "Loads a registry record details." }, { "info": { "name": "Updates (patches) an existing registry record.", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.humanitec.io/orgs/:orgId/registries/:regId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "Unique (alpha-numerical) organization identifier.\n\n" }, { "name": "regId", "value": "", "type": "path", "description": "Unique (alpha-numerical) registry identifier.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates (patches) an existing registry record." }, { "info": { "name": "Deletes an existing registry record and all associated credentials and secrets.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/registries/:regId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "Unique (alpha-numerical) organization identifier.\n\n" }, { "name": "regId", "value": "", "type": "path", "description": "Unique (alpha-numerical) registry identifier.\n\n" } ] }, "docs": "_Deletions are currently irreversible._" }, { "info": { "name": "Returns current account credentials or secret details for the registry.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/registries/:regId/creds", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "Unique (alpha-numerical) organization identifier.\n\n" }, { "name": "regId", "value": "", "type": "path", "description": "Unique (alpha-numerical) registry identifier.\n\n" } ] }, "docs": "Returns current account credentials or secret details for the registry." }, { "info": { "name": "List Active Resources provisioned in an environment.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/resources", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "envId", "value": "", "type": "path", "description": "The Environment ID.\n\n" }, { "name": "scheduled_deletion", "value": "", "type": "query", "description": "If set to `true` or `false`, filters resources scheduled or not scheduled for deletion correspondingly.\n" } ] }, "docs": "List Active Resources provisioned in an environment." }, { "info": { "name": "Lists the resource objects that hold the information needed to provision the resources specified in the request and the resources they depend on.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/resources/graph", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "envId", "value": "", "type": "path", "description": "The Environment ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint is deprecated. Use `/orgs/{orgId}/apps/{appId}/envs/{envId}/resources/graphs` instead." }, { "info": { "name": "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.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/resources/graphs", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "envId", "value": "development", "type": "path", "description": "The Environment ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Retrieve a Dependency Graph by its ID.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/resources/graphs/:graphId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "envId", "value": "development", "type": "path", "description": "The Environment ID" }, { "name": "graphId", "value": "01234567-89ab-cdef-0123-4567890abcdef", "type": "path", "description": "The Dependency Graph ID." } ] }, "docs": "Retrieve a Dependency Graph by its ID." }, { "info": { "name": "Delete Active Resource.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/resources/:type/:resId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "envId", "value": "", "type": "path", "description": "The Environment ID.\n\n" }, { "name": "type", "value": "", "type": "path", "description": "The Resource Type, may include a resource class: {type}.{class}.\n\n" }, { "name": "resId", "value": "", "type": "path", "description": "The Resource ID.\n\n" }, { "name": "detach", "value": "", "type": "query", "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. \nDetaching can be done for any active resource. In case that the resource is an active one (i.e. not marked to be deleted), it would stay in use until the next deployment.\nDetaching active resources can cause inconsistent status (e.g. detaching a k8s-cluster might make it impossible to retrieve runtime information by or un-pause an environment)\nIf the resource has been provisioned via the Humanitec Operator, this does not delete the resource CR in the cluster. This must be done manually.\n" } ] }, "docs": "Delete Active Resource." }, { "info": { "name": "Pin Active Resource to a target Resource Definition Version.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/resources/:type/:resId/actions/pin", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "envId", "value": "development", "type": "path", "description": "The Environment ID" }, { "name": "type", "value": "", "type": "path", "description": "The Resource Type, may include a resource class: {type}.{class}.\n" }, { "name": "resId", "value": "", "type": "path", "description": "The Resource ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Pin Active Resource to a target Resource Definition Version." }, { "info": { "name": "List Resource Account Types available to the organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/resources/account-types", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" } ] }, "docs": "List Resource Account Types available to the organization." }, { "info": { "name": "List Resource Accounts in the organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/resources/accounts", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" } ] }, "docs": "List Resource Accounts in the organization." }, { "info": { "name": "Create a new Resource Account in the organization.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/resources/accounts", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID." }, { "name": "dry_run", "value": "true", "type": "query", "description": "Validate the request but do not persist the change." }, { "name": "check_credential", "value": "true", "type": "query", "description": "Validate that the Account credential authenticates successfully." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Resource Account in the organization." }, { "info": { "name": "Get a Resource Account.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/resources/accounts/:accId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "accId", "value": "", "type": "path", "description": "The Resource Account ID.\n\n" } ] }, "docs": "Get a Resource Account." }, { "info": { "name": "Update a Resource Account.", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.humanitec.io/orgs/:orgId/resources/accounts/:accId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "accId", "value": "", "type": "path", "description": "The Resource Account ID.\n\n" }, { "name": "dry_run", "value": "true", "type": "query", "description": "Validate the request but do not persist the change." }, { "name": "check_credential", "value": "true", "type": "query", "description": "Validate that the Account credential authenticates successfully." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Resource Account." }, { "info": { "name": "Delete an unused Resource Account.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/resources/accounts/:accId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "accId", "value": "", "type": "path", "description": "The Resource Account ID.\n\n" } ] }, "docs": "A Resource Account can be deleted if it is not referenced or referenced only by deleted Resource Definitions.\nResource Definition Versions which reference the deleted Resource Account cannot be used in deployments.\n" }, { "info": { "name": "Check the credentials of an existing Resource Account", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/resources/accounts/:accId/actions/check", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID." }, { "name": "accId", "value": "", "type": "path", "description": "The Resource Account ID." } ] }, "docs": "Check the validity of a Resource Account and return any problems that may cause it to not work as expected." }, { "info": { "name": "List Resource Definitions.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/resources/defs", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "app", "value": "", "type": "query", "description": "(Optional) Filter Resource Definitions that may match a specific Application.\n\n" }, { "name": "env", "value": "", "type": "query", "description": "(Optional) Filter Resource Definitions that may match a specific Environment.\n\n" }, { "name": "env_type", "value": "", "type": "query", "description": "(Optional) Filter Resource Definitions that may match a specific Environment Type.\n\n" }, { "name": "res", "value": "", "type": "query", "description": "(Optional) Filter Resource Definitions that may match a specific Resource.\n\n" }, { "name": "res_type", "value": "", "type": "query", "description": "(Optional) Filter Resource Definitions that may match a specific Resource Type.\n\n" }, { "name": "class", "value": "", "type": "query", "description": "(Optional) Filter Resource Definitions that may match a specific Class.\n\n" }, { "name": "deleted", "value": "", "type": "query", "description": "If returns also resource definitions which has been deleted." } ] }, "docs": "Filter criteria can be applied to obtain all the resource definitions that could match the filters, grouped by type and sorted by matching rank. Resources marked as deleted are not listed in the response, unless specified via `deleted` query parameter." }, { "info": { "name": "Create a new Resource Definition.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/resources/defs", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Resource Definition." }, { "info": { "name": "Get a Resource Definition.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/resources/defs/:defId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "defId", "value": "", "type": "path", "description": "The Resource Definition ID.\n\n" }, { "name": "deleted", "value": "", "type": "query", "description": "If returns the resource definition even if it has been deleted." } ] }, "docs": "If the resource is marked as deleted it is not shown in the response, unless specified via `deleted` query parameter." }, { "info": { "name": "Update a Resource Definition.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.humanitec.io/orgs/:orgId/resources/defs/:defId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "defId", "value": "", "type": "path", "description": "The Resource Definition ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Resource Definition." }, { "info": { "name": "Update a Resource Definition.", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.humanitec.io/orgs/:orgId/resources/defs/:defId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "defId", "value": "", "type": "path", "description": "The Resource Definition ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Resource Definition." }, { "info": { "name": "Delete a Resource Definition.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/resources/defs/:defId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "defId", "value": "", "type": "path", "description": "The Resource Definition ID.\n\n" }, { "name": "force", "value": "", "type": "query", "description": "If set to `true`, will mark the Resource Definition for deletion, even if it affects existing Active Resources.\n\n" } ] }, "docs": "If there **are no** Active Resources provisioned via the current definition, the Resource Definition is deleted immediately.\n\nIf there **are** Active Resources provisioned via the current definition, the request fails. The response will describe the changes to the affected Active Resources if operation is forced.\n\nThe request can take an optional `force` query parameter. If set to `true`, the current Resource Definition is deleted immediately even if there are Active Resources linked to it. \nTh" }, { "info": { "name": "Get Versions of a Resource Definition.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/resources/defs/:defId/versions", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "defId", "value": "sample-def", "type": "path", "description": "The Resource Definition ID." }, { "name": "deleted", "value": "true", "type": "query", "description": "If to show also deleted records in the response." }, { "name": "per_page", "value": "50", "type": "query", "description": "The maximum number of items to return in a page of results" }, { "name": "page", "value": "AAAAAAAAAA==", "type": "query", "description": "The page token to request from" } ] }, "docs": "First 50 Versions are kept along with all the Versions referenced by an Active Resource.\n\n To obtain Versions of a deleted Resource Definition, the `deleted` parameter needs to be used." }, { "info": { "name": "Get a Resource Definition Version.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/resources/defs/:defId/versions/:defVersionId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "defId", "value": "sample-def", "type": "path", "description": "The Resource Definition ID." }, { "name": "defVersionId", "value": "01234567-89ab-cdef-0123-4567890abcdef", "type": "path", "description": "The Resource Definition Version ID." } ] }, "docs": "Get a Resource Definition Version." }, { "info": { "name": "Mark/unmark the Resource Definition Version as archived.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/resources/defs/:defId/versions/:defVersionId/actions/archive", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "defId", "value": "sample-def", "type": "path", "description": "The Resource Definition ID." }, { "name": "defVersionId", "value": "01234567-89ab-cdef-0123-4567890abcdef", "type": "path", "description": "The Resource Definition Version ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Mark/unmark the Resource Definition Version as archived." }, { "info": { "name": "Promote the Resource Definition Version as active.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/resources/defs/:defId/versions/:defVersionId/actions/promote", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "defId", "value": "sample-def", "type": "path", "description": "The Resource Definition ID." }, { "name": "defVersionId", "value": "01234567-89ab-cdef-0123-4567890abcdef", "type": "path", "description": "The Resource Definition Version ID." } ] }, "docs": "Promote the Resource Definition Version as active." }, { "info": { "name": "Add a new Matching Criteria to a Resource Definition.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/resources/defs/:defId/criteria", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "defId", "value": "", "type": "path", "description": "The Resource Definition ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Matching Criteria are combined with Resource Type to select a specific definition. Matching Criteria can be set for any combination of Application ID, Environment ID, Environment Type, and Resource ID. In the event of multiple matches, the most specific match is chosen.\n\nFor example, given 3 sets of matching criteria for the same type:\n\n```\n 1. {\"env_type\":\"test\"}\n 2. {\"env_type\":\"development\"}\n 3. {\"env_type\":\"test\", \"app_id\":\"my-app\"}\n```\n\nIf, a resource of that type was needed in an Applicati" }, { "info": { "name": "Update all Matching Criteria of a Resource Definition.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.humanitec.io/orgs/:orgId/resources/defs/:defId/criteria", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "defId", "value": "", "type": "path", "description": "The Resource Definition ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Matching Criteria are combined with Resource Type to select a specific definition. Matching Criteria can be set for any combination of Application ID, Environment ID, Environment Type, and Resource ID. In the event of multiple matches, the most specific match is chosen.\n\nFor example, given 3 sets of matching criteria for the same type:\n\n```\n 1. {\"env_type\":\"test\"}\n 2. {\"env_type\":\"development\"}\n 3. {\"env_type\":\"test\", \"app_id\":\"my-app\"}\n```\n\nIf, a resource of that type was needed in an Applicati" }, { "info": { "name": "Delete a Matching Criteria from a Resource Definition.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/resources/defs/:defId/criteria/:criteriaId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "defId", "value": "", "type": "path", "description": "The Resource Definition ID.\n\n" }, { "name": "criteriaId", "value": "", "type": "path", "description": "The Matching Criteria ID.\n\n" }, { "name": "force", "value": "", "type": "query", "description": "If set to `true`, the Matching Criteria is deleted immediately, even if this action affects existing Active Resources.\n\n" } ] }, "docs": "If there **are no** Active Resources that would match to a different Resource Definition when the current Matching Criteria is deleted, the Matching Criteria is deleted immediately.\n\nIf there **are** Active Resources that would match to a different Resource Definition, the request fails with HTTP status code 409 (Conflict). The response content will list all of affected Active Resources and their new matches.\n\nThe request can take an optional `force` query parameter. If set to `true`, the Matchi" }, { "info": { "name": "List Active Resources provisioned via a specific Resource Definition.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/resources/defs/:defId/resources", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "defId", "value": "", "type": "path", "description": "The Resource Definition ID.\n\n" } ] }, "docs": "List Active Resources provisioned via a specific Resource Definition." }, { "info": { "name": "List Resource Drivers.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/resources/drivers", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" } ] }, "docs": "List Resource Drivers." }, { "info": { "name": "Register a new Resource Driver.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/resources/drivers", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Register a new Resource Driver." }, { "info": { "name": "Get a Resource Driver.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/resources/drivers/:driverId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "driverId", "value": "", "type": "path", "description": "The Resource Driver ID.\n\n" } ] }, "docs": "# Only drivers that belongs to the given organization or registered as `public` are accessible through this endpoint" }, { "info": { "name": "Update a Resource Driver.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.humanitec.io/orgs/:orgId/resources/drivers/:driverId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "driverId", "value": "", "type": "path", "description": "The Resource Driver ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Resource Driver." }, { "info": { "name": "Delete a Resources Driver.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/resources/drivers/:driverId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "driverId", "value": "", "type": "path", "description": "The Resources Driver ID to delete.\n\n" } ] }, "docs": "Delete a Resources Driver." }, { "info": { "name": "List Resource Types.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/resources/types", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" } ] }, "docs": "List Resource Types." }, { "info": { "name": "Creates a new Resources Type.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/resources/types", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Resources Type." }, { "info": { "name": "Update a Resource Type.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.humanitec.io/orgs/:orgId/resources/types/:typeId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n" }, { "name": "typeId", "value": "my-org%2Fmy-type", "type": "path", "description": "The Resource Type id. The type id should be provided as url encoded string.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Resource Type." }, { "info": { "name": "Update a Resource Type.", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.humanitec.io/orgs/:orgId/resources/types/:typeId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "typeId", "value": "my-org%2Fmy-type", "type": "path", "description": "The Resource Type id. The type id should be provided as url encoded string.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Resource Type." }, { "info": { "name": "Delete a Resource Type.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/resources/types/:typeId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "typeId", "value": "my-org%2Fmy-type", "type": "path", "description": "The Resource Type id. The type id should be provided as url encoded string.\n" } ] }, "docs": "Delete a Resource Type." }, { "info": { "name": "List resource classes.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/resources/classes", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The organization ID.\n" } ] }, "docs": "List resource classes." }, { "info": { "name": "Creates a new resources class.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/resources/types/:typeId/classes", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The organization ID.\n" }, { "name": "typeId", "value": "", "type": "path", "description": "The resource type.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new resources class." }, { "info": { "name": "Get resource class by ID.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/resources/types/:typeId/classes/:classId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The organization ID.\n" }, { "name": "typeId", "value": "", "type": "path", "description": "The resource type.\n" }, { "name": "classId", "value": "", "type": "path", "description": "The resource class ID.\n" } ] }, "docs": "Get resource class by ID." }, { "info": { "name": "Update a resource class description.", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.humanitec.io/orgs/:orgId/resources/types/:typeId/classes/:classId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The organization ID.\n" }, { "name": "typeId", "value": "", "type": "path", "description": "The resource type ID.\n" }, { "name": "classId", "value": "", "type": "path", "description": "The resource class ID.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a resource class description." }, { "info": { "name": "Delete a resource class.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/resources/types/:typeId/classes/:classId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The organization ID.\n" }, { "name": "typeId", "value": "", "type": "path", "description": "The resource type.\n" }, { "name": "classId", "value": "", "type": "path", "description": "The resource class id.\n" } ] }, "docs": "Delete a resource class." }, { "info": { "name": "Get Runtime information about the environment.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/runtime", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "envId", "value": "development", "type": "path", "description": "The Environment ID" } ] }, "docs": "Runtime info are fetched from the cluster provisioned by the Orchestrator with Resource Id `k8s-cluster-runtime`. If no cluster with that id is found, the system fetches information from a cluster provisioned with the default Resource Id `k8s-cluster`." }, { "info": { "name": "Pause / Resume an environment.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/runtime/paused", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "envId", "value": "development", "type": "path", "description": "The Environment ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "On pause requests, all the Kubernetes Deployment resources are scaled down to 0 replicas. On resume requests, all the Kubernetes Deployment resources are scaled up to the number of replicas running before the environment was paused. When an environment is paused, it is not possible to:```\n - Deploy the environment within Humanitec.\n - Scale the number of replicas running of any workload.\n```" }, { "info": { "name": "Set number of replicas for an environment's modules.", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/runtime/replicas", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "envId", "value": "development", "type": "path", "description": "The Environment ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set number of replicas for an environment's modules." }, { "info": { "name": "Get Runtime information about specific multiple environments.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/runtime", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "id", "value": "", "type": "query", "description": "Filter environments by ID (required). Up to 5 ids can be supplied per request." } ] }, "docs": "Get Runtime information about specific multiple environments." }, { "info": { "name": "Provision and check the cluster connectivity in an environment", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/runtime/actions/check-connectivity", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Provision and check the cluster connectivity in an environment" }, { "info": { "name": "Get list of Secret Stores for the given organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/secretstores", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" } ] }, "docs": "Get list of Secret Stores for the given organization." }, { "info": { "name": "Create a Secret Store for the given organization.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/secretstores", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Secret Store for the given organization." }, { "info": { "name": "Get the Secret Store.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/secretstores/:storeId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "storeId", "value": "", "type": "path", "description": "The Secret Store ID.\n\n" } ] }, "docs": "Get the Secret Store." }, { "info": { "name": "Update the Secret Store.", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.humanitec.io/orgs/:orgId/secretstores/:storeId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "storeId", "value": "", "type": "path", "description": "The Secret Store ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the Secret Store." }, { "info": { "name": "Delete the Secret Store.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/secretstores/:storeId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "storeId", "value": "", "type": "path", "description": "The Secret Store ID.\n\n" } ] }, "docs": "Delete the Secret Store." }, { "info": { "name": "Gets the extended profile of the current user", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/current-user" }, "docs": "Gets the extended profile of the current user" }, { "info": { "name": "Updates the extended profile of the current user.", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.humanitec.io/current-user", "body": { "type": "json", "data": "{}" } }, "docs": "Updates the extended profile of the current user." }, { "info": { "name": "Create a group in an organization", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/groups", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a group in an organization" }, { "info": { "name": "List users in a group.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/groups/:groupId/users", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "groupId", "value": "g-61048226-642c-438e-974f-ce5c013d94f8", "type": "path", "description": "The Group Id." } ] }, "docs": "List users in a group." }, { "info": { "name": "List Users or Groups with roles in an App", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/users", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "type", "value": "", "type": "query", "description": "Type of Subject. Either User or Group" } ] }, "docs": "List Users or Groups with roles in an App" }, { "info": { "name": "Adds a User or a Group to an Application with a Role", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/users", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a User or a Group to an Application with a Role" }, { "info": { "name": "Get the role of a User or a Group on an Application", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/users/:userId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "userId", "value": "61048226-642c-438e-974f-ce5c013d94f8", "type": "path", "description": "The User or Group Id." } ] }, "docs": "Get the role of a User or a Group on an Application" }, { "info": { "name": "Update the role of a User or a Group on an Application", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/users/:userId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "userId", "value": "61048226-642c-438e-974f-ce5c013d94f8", "type": "path", "description": "The User or Group Id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the role of a User or a Group on an Application" }, { "info": { "name": "Remove the role of a User or a Group on an Application", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/users/:userId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "appId", "value": "sample-app", "type": "path", "description": "The Application ID" }, { "name": "userId", "value": "61048226-642c-438e-974f-ce5c013d94f8", "type": "path", "description": "The User or Group Id." } ] }, "docs": "Remove the role of a User or a Group on an Application" }, { "info": { "name": "List Users and Groups with roles in an Environment Type", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/env-types/:envType/users", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "envType", "value": "", "type": "path", "description": "The Environment Type." }, { "name": "type", "value": "", "type": "query", "description": "Type of Subject. Either User or Group" } ] }, "docs": "List Users and Groups with roles in an Environment Type" }, { "info": { "name": "Adds a User or a Group to an Environment Type with a Role", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/env-types/:envType/users", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "envType", "value": "", "type": "path", "description": "The Environment Type." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a User or a Group to an Environment Type with a Role" }, { "info": { "name": "Get the role of a User or a Group on an Environment Type", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/env-types/:envType/users/:userId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "envType", "value": "", "type": "path", "description": "The Environment Type." }, { "name": "userId", "value": "61048226-642c-438e-974f-ce5c013d94f8", "type": "path", "description": "The User or Group Id." } ] }, "docs": "Get the role of a User or a Group on an Environment Type" }, { "info": { "name": "Update the role of a User or a Group on an Environment Type", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.humanitec.io/orgs/:orgId/env-types/:envType/users/:userId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "envType", "value": "", "type": "path", "description": "The Environment Type." }, { "name": "userId", "value": "61048226-642c-438e-974f-ce5c013d94f8", "type": "path", "description": "The User or Group Id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the role of a User or a Group on an Environment Type" }, { "info": { "name": "Remove the role of a User or a Group on an Environment Type", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/env-types/:envType/users/:userId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "envType", "value": "", "type": "path", "description": "The Environment Type." }, { "name": "userId", "value": "61048226-642c-438e-974f-ce5c013d94f8", "type": "path", "description": "The User or Group Id." } ] }, "docs": "Remove the role of a User or a Group on an Environment Type" }, { "info": { "name": "List the invites issued for the organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/invitations", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" } ] }, "docs": "List the invites issued for the organization." }, { "info": { "name": "Invites a user to an Organization with a specified role.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/invitations", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Invites a user to an Organization with a specified role." }, { "info": { "name": "List Users and Groups with roles in an Organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/users", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "type", "value": "", "type": "query", "description": "Type of Subject. Either User or Group" } ] }, "docs": "List Users and Groups with roles in an Organization" }, { "info": { "name": "Creates a new service user.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/users", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new service user." }, { "info": { "name": "Get the role of a User or a Group on an Organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/users/:userId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "userId", "value": "61048226-642c-438e-974f-ce5c013d94f8", "type": "path", "description": "The User or Group Id." } ] }, "docs": "Get the role of a User or a Group on an Organization" }, { "info": { "name": "Update the role of a User or a Group on an Organization", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.humanitec.io/orgs/:orgId/users/:userId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "userId", "value": "61048226-642c-438e-974f-ce5c013d94f8", "type": "path", "description": "The User or Group Id." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the role of a User or a Group on an Organization" }, { "info": { "name": "Remove the role of a User or a Group on an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/users/:userId", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "userId", "value": "61048226-642c-438e-974f-ce5c013d94f8", "type": "path", "description": "The User or Group Id." } ] }, "docs": "Remove the role of a User or a Group on an Organization" }, { "info": { "name": "Get the groups in an organization a user belongs to.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/users/:userId/groups", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "userId", "value": "61048226-642c-438e-974f-ce5c013d94f8", "type": "path", "description": "The User or Group Id." } ] }, "docs": "Get the groups in an organization a user belongs to." }, { "info": { "name": "Get the permissions of a User or Group on the objects in an Organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/users/:userId/perms", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "userId", "value": "61048226-642c-438e-974f-ce5c013d94f8", "type": "path", "description": "The User or Group Id." } ] }, "docs": "Get the permissions of a User or Group on the objects in an Organization" }, { "info": { "name": "Lists tokens associated with a user", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/users/:userId/tokens", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The user ID.\n\n" } ] }, "docs": "Lists tokens associated with a user" }, { "info": { "name": "Creates a new static token for a user.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/users/:userId/tokens", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The user ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This is only supported for users of type `service`." }, { "info": { "name": "Gets a specific token associated with a user", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/users/:userId/tokens/:tokenId", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The user ID.\n\n" }, { "name": "tokenId", "value": "", "type": "path", "description": "The token ID.\n\n" } ] }, "docs": "Gets a specific token associated with a user" }, { "info": { "name": "Deletes a specific token associated with a user", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/users/:userId/tokens/:tokenId", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The user ID.\n\n" }, { "name": "tokenId", "value": "", "type": "path", "description": "The token ID.\n\n" } ] }, "docs": "This endpoint deletes a user's session token. The deleted token can no longer be used to access the API. All other tokens for this user can still be used." }, { "info": { "name": "List Value Set Versions in an Environment of an App", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/value-set-versions", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "envId", "value": "", "type": "path", "description": "The Environment ID.\n\n" }, { "name": "key_changed", "value": "", "type": "query", "description": "(Optional) Return only value set version where the specified key changed\n\n" } ] }, "docs": "A new Value Set Version is created on every modification of a Value inside the an Environment of an App. In case this environment has no overrides the response is the same as the App level endpoint." }, { "info": { "name": "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.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/value-set-versions/:valueSetVersionId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "envId", "value": "", "type": "path", "description": "The Environment ID.\n\n" }, { "name": "valueSetVersionId", "value": "", "type": "path", "description": "The ValueSetVersion ID.\n\n" } ] }, "docs": "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." }, { "info": { "name": "Purge the value of a specific Shared Value from the App Environment Version history.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/value-set-versions/:valueSetVersionId/purge/:key", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "envId", "value": "", "type": "path", "description": "The Environment ID.\n\n" }, { "name": "valueSetVersionId", "value": "", "type": "path", "description": "The ValueSetVersion ID.\n\n" }, { "name": "key", "value": "", "type": "path", "description": "Key of the value to be purged.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Purging permanently removes the value of a specific Shared Value in an application. A purged value is no longer accessible, can't be restored and can't be used\nby deployments referencing a Value Set Version where the value was present.\n\nLearn more about purging in our [docs](https://docs.humanitec.com/reference/concepts/app-config/shared-app-values#purge).\n" }, { "info": { "name": "Restore a Value Set Version in an Environment of an App", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/value-set-versions/:valueSetVersionId/restore", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "envId", "value": "", "type": "path", "description": "The Environment ID.\n\n" }, { "name": "valueSetVersionId", "value": "", "type": "path", "description": "The ValueSetVersion ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restore the values of all Shared Values in an environment from a specific version. Keys not existing in the selected version are deleted.\n\nLearn more about reverting in our [docs](https://docs.humanitec.com/reference/concepts/app-config/shared-app-values#revert).\n" }, { "info": { "name": "Restore a specific key from the Value Set Version in an Environment of an App", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/value-set-versions/:valueSetVersionId/restore/:key", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "envId", "value": "", "type": "path", "description": "The Environment ID.\n\n" }, { "name": "valueSetVersionId", "value": "", "type": "path", "description": "The ValueSetVersion ID.\n\n" }, { "name": "key", "value": "", "type": "path", "description": "Key of the value to be restored.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restore the values of a single Shared Value in an Environment from a specific version.\n\nLearn more about reverting in our [docs](https://docs.humanitec.com/reference/concepts/app-config/shared-app-values#revert).\n" }, { "info": { "name": "List Shared Values in an Environment", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/values", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "envId", "value": "", "type": "path", "description": "The Environment ID.\n\n" } ] }, "docs": "The returned values will be the base Application values with the Environment overrides where applicable. The `source` field will specify the level from which the value is from." }, { "info": { "name": "Create a Shared Value for an Environment", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/values", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "envId", "value": "", "type": "path", "description": "The Environment ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The Shared Value created will only be available to the specific Environment.\n\nIf a Value is marked as a secret, it will be securely stored. It will not be possible to retrieve the value again through the API. The value of the secret can however be updated." }, { "info": { "name": "Delete all Shared Value for an Environment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/values", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "envId", "value": "", "type": "path", "description": "The Environment ID.\n\n" } ] }, "docs": "All Shared Values will be deleted. If the Shared Values are marked as a secret, they will also be deleted." }, { "info": { "name": "Update Shared Value for an Environment", "type": "http" }, "http": { "method": "PUT", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/values/:key", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "envId", "value": "", "type": "path", "description": "The Environment ID.\n\n" }, { "name": "key", "value": "", "type": "path", "description": "The key to update.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the value or description of the Shared Value. Shared Values marked as secret can also be updated." }, { "info": { "name": "Update Shared Value for an Environment", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/values/:key", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "envId", "value": "", "type": "path", "description": "The Environment ID.\n\n" }, { "name": "key", "value": "", "type": "path", "description": "The key to update.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the value or description of the Shared Value. Shared Values marked as secret can also be updated." }, { "info": { "name": "Delete Shared Value for an Environment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/envs/:envId/values/:key", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "envId", "value": "", "type": "path", "description": "The Environment ID.\n\n" }, { "name": "key", "value": "", "type": "path", "description": "The key to update.\n\n" } ] }, "docs": "The specified Shared Value will be permanently deleted. If the Shared Value is marked as a secret, it will also be permanently deleted." }, { "info": { "name": "List Value Set Versions in the App", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/value-set-versions", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "key_changed", "value": "", "type": "query", "description": "(Optional) Return only value set version where the specified key changed\n\n" } ] }, "docs": "A new Value Set Version is created on every modification of a Value inside the app." }, { "info": { "name": "Get a single Value Set Version from the App", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/value-set-versions/:valueSetVersionId", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "valueSetVersionId", "value": "", "type": "path", "description": "The ValueSetVersion ID.\n\n" } ] }, "docs": "Get a single Value Set Version from the App" }, { "info": { "name": "Purge the value of a specific Shared Value from the App Version history.", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/value-set-versions/:valueSetVersionId/purge/:key", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "valueSetVersionId", "value": "", "type": "path", "description": "The ValueSetVersion ID.\n\n" }, { "name": "key", "value": "", "type": "path", "description": "Key of the value to be purged.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Purging permanently removes the value of a specific Shared Value in an Application. A purged value is no longer accessible, can't be restored and can't be used\nby deployments referencing a Value Set Version where the value was present.\n\nLearn more about purging in our [docs](https://docs.humanitec.com/reference/concepts/app-config/shared-app-values#purge).\n" }, { "info": { "name": "Restore a Value Set Version in an App", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/value-set-versions/:valueSetVersionId/restore", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "valueSetVersionId", "value": "", "type": "path", "description": "The ValueSetVersion ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restore the values of all Shared Values in an application from a specific version. Keys not existing in the selected version are deleted.\n\nLearn more about reverting in our [docs](https://docs.humanitec.com/reference/concepts/app-config/shared-app-values#revert).\n" }, { "info": { "name": "Restore a specific key from the Value Set Version in an App", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/value-set-versions/:valueSetVersionId/restore/:key", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "valueSetVersionId", "value": "", "type": "path", "description": "The ValueSetVersion ID.\n\n" }, { "name": "key", "value": "", "type": "path", "description": "Key of the value to be restored.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restore the values of a single Shared Value in an application from a specific version.\n\nLearn more about reverting in our [docs](https://docs.humanitec.com/reference/concepts/app-config/shared-app-values#revert).\n" }, { "info": { "name": "List Shared Values in an Application", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/values", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" } ] }, "docs": "The returned values will be the \"base\" values for the Application. The overridden value for the Environment can be retrieved via the `/orgs/{orgId}/apps/{appId}/envs/{envId}/values` endpoint." }, { "info": { "name": "Create a Shared Value for an Application", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/values", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The Shared Value created will be available to all Environments in that Application.\n\nIf a Value is marked as a secret, it will be securely stored. It will not be possible to retrieve the value again through the API. The value of the secret can however be updated." }, { "info": { "name": "Delete all Shared Value for an App", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/values", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" } ] }, "docs": "All Shared Values will be deleted. If the Shared Values are marked as a secret, they will also be deleted." }, { "info": { "name": "Update Shared Value for an Application", "type": "http" }, "http": { "method": "PUT", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/values/:key", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "key", "value": "", "type": "path", "description": "The key to update.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the value or description of the Shared Value. Shared Values marked as secret can also be updated." }, { "info": { "name": "Update Shared Value for an Application", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/values/:key", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "key", "value": "", "type": "path", "description": "The key to update.\n\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the value or description of the Shared Value. Shared Values marked as secret can also be updated." }, { "info": { "name": "Delete Shared Value for an Application", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/apps/:appId/values/:key", "params": [ { "name": "orgId", "value": "", "type": "path", "description": "The Organization ID.\n\n" }, { "name": "appId", "value": "", "type": "path", "description": "The Application ID.\n\n" }, { "name": "key", "value": "", "type": "path", "description": "The key to update.\n\n" } ] }, "docs": "The specified Shared Value will be permanently deleted. If the Shared Value is marked as a secret, it will also be permanently deleted." }, { "info": { "name": "List workload profile features available to the organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/workload-profile-features", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" } ] }, "docs": "List workload profile features available to the organization." }, { "info": { "name": "List workload profiles available to the organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/workload-profiles", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "deprecated", "value": "true", "type": "query", "description": "Whether to include deprecated profiles" }, { "name": "per_page", "value": "50", "type": "query", "description": "The maximum number of items to return in a page of results" }, { "name": "page", "value": "AAAAAAAAAA==", "type": "query", "description": "The page token to request from" } ] }, "docs": "List workload profiles available to the organization." }, { "info": { "name": "Create new Workload Profile", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/workload-profiles", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create new Workload Profile" }, { "info": { "name": "Get a Workload Profile", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/workload-profiles/:profileQid", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "profileQid", "value": "", "type": "path", "description": "The Workload Profile ID." } ] }, "docs": "Get a Workload Profile" }, { "info": { "name": "Update a Workload Profile", "type": "http" }, "http": { "method": "PUT", "url": "https://api.humanitec.io/orgs/:orgId/workload-profiles/:profileQid", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "profileQid", "value": "", "type": "path", "description": "The Workload Profile ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Workload Profile" }, { "info": { "name": "Delete a Workload Profile", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.humanitec.io/orgs/:orgId/workload-profiles/:profileQid", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "profileQid", "value": "", "type": "path", "description": "The Workload Profile ID." } ] }, "docs": "This will also delete all versions of a workload profile.\n\nIt is not possible to delete profiles of other organizations." }, { "info": { "name": "List versions of the given workload profile.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/workload-profiles/:profileQid/versions", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "profileQid", "value": "", "type": "path", "description": "The Workload Profile ID." }, { "name": "per_page", "value": "50", "type": "query", "description": "The maximum number of items to return in a page of results" }, { "name": "page", "value": "AAAAAAAAAA==", "type": "query", "description": "The page token to request from" } ] }, "docs": "List versions of the given workload profile." }, { "info": { "name": "Latest version of the given workload profile with optional constraint.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/workload-profiles/:profileQid/versions/latest", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "profileQid", "value": "", "type": "path", "description": "The Workload Profile ID." } ] }, "docs": "Latest version of the given workload profile with optional constraint." }, { "info": { "name": "Workload Profile Chart Versions for the given organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.humanitec.io/orgs/:orgId/workload-profile-chart-versions", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" }, { "name": "per_page", "value": "50", "type": "query", "description": "The maximum number of items to return in a page of results" }, { "name": "page", "value": "AAAAAAAAAA==", "type": "query", "description": "The page token to request from" }, { "name": "id", "value": "", "type": "query", "description": "Filter Chart Versions by Chart Version ID." }, { "name": "version", "value": "", "type": "query", "description": "Filter Chart Versions by Chart Version." } ] }, "docs": "Returns all Workload Profile Chart Versions for the given organization." }, { "info": { "name": "Add new Workload Profile Chart Version", "type": "http" }, "http": { "method": "POST", "url": "https://api.humanitec.io/orgs/:orgId/workload-profile-chart-versions", "params": [ { "name": "orgId", "value": "sample-org", "type": "path", "description": "The Organization ID" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] } }, "docs": "Creates a Workload Profile Chart Version from the uploaded Helm chart. The name and version is retrieved from the chart's metadata (Charts.yaml file).\n\nThe request has content type `multipart/form-data` and the request body includes one part:\n\n1. `file` with `application/x-gzip` content type which is an archive containing a Helm chart.\n\nRequest body example:\n\n\tContent-Type: multipart/form-data; boundary=----boundary \t----boundary \tContent-Disposition: form-data; name=\"file\"; filename=\"my-workloa" } ] } ], "bundled": true }