List Variables
List variables for a service, environment, project, or team. Service variables include their rendered values. Values are blank and values_redacted is true unless the connection has the read_variable_values privilege; names and references are always listed.
List variables for a service, environment, project, or team. Service variables include their rendered values. Values are blank and values_redacted is true unless the connection has the read_variable_values privilege; names and references are always listed.
Authorization
bearerAuth Access token or API key (unb_...) passed as Authorization: Bearer <token>.
In: header
Query Parameters
The type of variable
Value in
- "team"
- "project"
- "environment"
- "service"
If present, fetch project variables
If present, fetch environment variables - requires project_id
If present, fetch service variables - requires project_id and environment_id
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/variables/list?type=team&team_id=string"{ "data": { "values_redacted": true, "variables": [ { "name": "string", "provided": true, "references": [ { "key": "string", "resolved": true, "resolved_value": "string", "source_icon": "string", "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81", "source_name": "string", "source_type": "team", "token": "string" } ], "resolved_value": "string", "type": "team", "updates": [ "string" ], "value": "string" } ] }}Remove Deployment POST
Remove the active deployment by scaling the service to zero. The service stays offline until a new deployment is created.
List Available Variable References GET
List the sources and keys a service's variables can reference: team, project and environment variables, and the variables and Unbind-provided addresses of every service in the project, the service itself included. A key of a service is referenced as ${{service:<source_id>.KEY}}, the others as ${{team.KEY}}, ${{project.KEY}} and ${{environment.KEY}}.