Tenants

Return a list of tenants who are missing required variables.

get/spaces/{spaceIdentifier}/tenants/variables-missing

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/spaces/{spaceIdentifier}/tenants/variables-missing
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Path parameters

spaceIdentifierstring required

Identifier (ID or slug) of the space

Query parameters

environmentIdstring

An Environment ID, to limit the set of inspected Tenants to those connected to a particular Environment. Example: Environments-202.

includeDetailsboolean

A switch to indicate whether missing variable details should be returned along with names. When false, each result names only the tenant, which is enough to check whether a tenant is missing anything at all.

projectIdstring

A Project ID, to limit the set of inspected Tenants to those connected to a particular Project. Example: Projects-202.

tenantIdstring

An ID for a Tenant. If supplied, will limit the result to variables missing for the Tenant identified by the ID. Example: Tenants-101.

Response

List of tenants who are missing required variables.

Linksobject
TenantIdstring

Example response

[
  {
    "MissingVariables": [
      {
        "EnvironmentId": "Environments-1"
      }
    ],
    "TenantId": "Tenants-1"
  }
]

Changes

No recorded changes to this operation across all 13 revisions of this API.