// Tenant Variables

Get a tenant's variables for a project

Get the values a tenant gave a project's tenant variables, and which required ones are missing.

GET/api/tenant/variables

Description

Returns each of the project's tenant variables with the values this tenant gave it. A value with environmentId: null is used in all environments; a value for one environment wins over it there. Where neither is set, the variable's default is used.

isMissing is true when the variable is required and some of the tenant's environments get no value at all - missingEnvironmentIds says which.

Secret values are write-only: they are listed, so you can see one is set, but value is always null.

Parameters

NameInTypeRequiredDescription
tenantId query string yes ID of the tenant.
projectId query string yes ID of a project the tenant is connected to.

Errors

StatusMeaning
400 Invalid tenantId or projectId, or the tenant is not connected to the project.
401 Missing or invalid Basic auth credentials, or the service account lacks permission to manage tenants in this workspace.