Tenants

Create or Update the common variables associated with the tenant.

post/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

Request body

ConcurrencyTokenstring

The concurrency token returned when reading the tenant's variables. Always pass it back so the write is rejected if someone else changed the variables since your read; omitting it skips the check and risks silently overwriting their changes.

SpaceIdstring required
TenantIdstring required

Example request

{
  "SpaceId": "Spaces-1",
  "TenantId": "Tenants-1",
  "Variables": [
    {
      "Scope": {
        "EnvironmentIds": [
          "Environments-1",
          "..."
        ]
      }
    }
  ]
}

Response

The common variables associated with a tenant.

ConcurrencyTokenstring required
TenantIdstring required

Example response

{
  "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.