public
Set

Get all Deployment Sets

Changed on
get/orgs/{orgId}/apps/{appId}/sets

Request

  • Base URL
    https://api.humanitec.io
  • URL
    https://api.humanitec.io/orgs/{orgId}/apps/{appId}/sets
  • Auth
    none declared

Path parameters

orgIdstring required

The Organization ID

appIdstring required

The Application ID

Response

The Requested Deployment Set.

idstring required

The ID which is a hash of the content of the Deployment Set.

modulesobject required

The Modules (Profile Workloads) that make up the Set, deployed through their Workload Profile.

sharedobject required

Resources that are shared across the set

versioninteger required

The version of the Deployment Set Schema to use. (Currently, only 0 is supported, and if omitted, version 0 is assumed.)

workloadsobject

The Generic Workloads that make up the Set, deployed through their workload resource. A Set may hold these alongside modules, and both are deployed. Omitted when the Set holds no Workloads.

Example response

[
  {
    "modules": {
      "module-one": {
        "externals": {
          "db-one": {
            "params": {
              "extensions": {
                "uuid-ossp": {}
              }
            },
            "type": "postgres"
          }
        },
        "profile": "humanitec/default-module",
        "spec": {
          "containers": {
            "core-service": {
              "id": "core-service",
              "image": "registry.humanitec.io/my-org/core-service:VERSION_ONE",
              "readiness_probe": {
                "path": "/healtz",
                "port": 8080,
                "type": "http"
              },
              "variables": {
                "DBHOST": "${externals.db-one.name}",
                "DBNAME": "${externals.db-one.name}",
                "DBPASSWORD": "${externals.db-one.password}",
                "DBUSERNAME": "${externals.db-one.username}",
                "REDIS_URL": "redis://${modules.redis-cache.service.name}"
              }
            }
          }
        }
      },
      "redis-cache": {
        "profile": "humanitec/redis"
      }
    }
  }
]

Changes

  • 74d8727ef6b1Revision changes
    • warning

      removed the optional property //// from the response with the status

  • e21ad140ec3cRevision changes
    • info

      added the optional property / to the response with the status