Tenants

Get the common variables associated with the tenant.

get/tenants/{tenantId}/commonvariables

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/tenants/{tenantId}/commonvariables
  • 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

tenantIdstring required

The ID of the tenant to read common variable values for. Example: Tenants-101.

Query parameters

includeMissingVariablesboolean

When true, the response also lists the library variable set templates the tenant is required to supply a value for but has not, along with each template's default value.

Response

The common variables associated with a tenant.

ConcurrencyTokenstring required
TenantIdstring required

Example response

{
  "MissingVariables": [
    {
      "LibraryVariableSetId": "LibraryVariableSets-1",
      "Scope": {
        "EnvironmentIds": [
          "Environments-1",
          "..."
        ]
      }
    }
  ],
  "TenantId": "Tenants-1",
  "Variables": [
    {
      "LibraryVariableSetId": "LibraryVariableSets-1",
      "Scope": {
        "EnvironmentIds": [
          "Environments-1",
          "..."
        ]
      }
    }
  ]
}

Changes

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