latestOpenAPI 3.0.02026-08-10221235717.8 KB

e21ad140ec3c

public

Set

Get all Deployment Sets

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

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 that make up the Set

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 Workloads that make up the Set. A Set holding at least one Workload is deployed in Generic Mode. 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"
      }
    }
  }
]