Humanitec

opencollection: 1.0.0
info:
  name: Humanitec API
  version: 0.28.24
items:
- info:
    name: Agents
    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: public
    type: folder
  items:
  - 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.


          '
    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.


          '
      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.


          '
      - name: appId
        value: ''
        type: path
        description: 'The Application ID.


          '
    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.


          '
      - name: appId
        value: ''
        type: path
        description: 'The Application ID.


          '
    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.


      _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.


          '
      - name: appId
        value: ''
        type: path
        description: 'The Application ID.


          '
    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.


          '
      - name: appId
        value: ''
        type: path
        description: 'The Application ID.


          '
      body:
        type: json
        data: '{}'
    docs: 'Creates a new Environment of the specified Type and associates it with the Application specified by `appId`.


      The 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.)


      The 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.


          '
      - name: appId
        value: ''
        type: path
        description: 'The Application ID.


          '
      - name: envId
        value: ''
        type: path
        description: 'The Environment ID.


          '
    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.


          '
      - name: appId
        value: ''
        type: path
        description: 'The Application ID.


          '
      - name: envId
        value: ''
        type: path
        description: 'The Environment ID.


          '
      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.


          '
      - name: appId
        value: ''
        type: path
        description: 'The Application ID.


          '
      - name: envId
        value: ''
        type: path
        description: 'The Environment ID.


          '
    docs: 'Deletes a specific Environment in an Application.


      Deleting an Environment will also delete the Deployment history of the Environment.


      _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.


          '
      - name: appId
        value: ''
        type: path
        description: 'The Application ID.


          '
      - name: envId
        value: ''
        type: path
        description: 'The Environment ID.


          '
      - 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.

          '
    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.


          '
      - name: appId
        value: ''
        type: path
        description: 'The Application ID.


          '
      - name: envId
        value: ''
        type: path
        description: 'The Environment ID.


          '
      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.


      When 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.


          '
      - name: appId
        value: ''
        type: path
        description: 'The Application ID.


          '
      - name: envId
        value: ''
        type: path
        description: 'The Environment ID.


          '
      - name: deployId
        value: ''
        type: path
        description: 'The Deployment ID.


          '
    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.


          '
      - name: appId
        value: ''
        type: path
        description: 'The Application ID.


          '
      - name: envId
        value: ''
        type: path
        description: 'The Environment ID.


          '
      - name: deployId
        value: ''
        type: path
        description: 'The Deployment ID.


          '
    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.


          '
      - name: appId
        value: ''
        type: path
        description: 'The Application ID.


          '
      - name: envId
        value: ''
        type: path
        description: 'The Environment ID.


          '
      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.


      _Running code will only be affected on the next Deployment to the Environment._


      Common use cases for rebasing an Environment:


      * _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.


          '
    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.


          '
      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.


          '
      - name: envTypeId
        value: ''
        type: path
        description: 'ID of the Environment Type.


          '
    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.


          '
      - name: envTypeId
        value: ''
        type: path
        description: 'ID of the Environment Type.


          '
      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.


          '
      - name: envTypeId
        value: ''
        type: path
        description: 'ID of the Environment Type.


          '
    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

      returned if it is not.

      '
  - 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

      returned if it is not.

      '
  - 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.


      Lists 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.


      The response includes a list of Image Builds as well as some metadata about the Image such as its Image Source.


      Note, `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.


      The 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.


      This endpoint is used by Continuous Integration (CI) pipelines to notify Humanitec that a new Image Build is available.


      If 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.huma

# --- truncated at 32 KB (148 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/humanitec/refs/heads/main/apis.yml