// Tenant Variables

List a project's tenant variables

List the variables a project asks each tenant to fill in.

GET/api/project/tenant-variable-templates

Description

A tenant variable is a value each tenant fills in for a project - for example a customer's database name or licence key. Each tenant sets its values with PUT /api/tenant/variables.

A tenant variable's name can't be the same as a project variable or a workspace variable used in the project.

Secret defaults are never returned: defaultValue is always null for them, and hasDefault says whether one is set.

Parameters

Name	In	Type	Required	Description
`projectId`	query	string	yes	ID of the project.

Errors

Status	Meaning
`400`	Invalid `projectId`.
`401`	Missing or invalid Basic auth credentials, or the service account can't edit this project.

Request

GET /api/project/tenant-variable-templates?projectId=prj_abc123 HTTP/1.1
Authorization: Basic <base64(serviceAccountId:apiKey)>

Response

{
  "projectId": "prj_abc123",
  "templates": [
    {
      "templateId": "tvt_db",
      "projectId": "prj_abc123",
      "name": "DatabaseName",
      "description": "The customer's database",
      "variableType": "Text",
      "isRequired": true,
      "sortOrder": 0,
      "hasDefault": false,
      "defaultValue": null
    },
    {
      "templateId": "tvt_key",
      "projectId": "prj_abc123",
      "name": "LicenceKey",
      "description": null,
      "variableType": "Secret",
      "isRequired": false,
      "sortOrder": 1,
      "hasDefault": true,
      "defaultValue": null
    }
  ]
}