Variable Main Calls
List variables
Returns a list of variables. The result can be filtered by using the query parameters.
get/variable
Request
- Base URLhttps://api.qovery.com
- Auth
- API key in header Authorization
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
parent_idstring uuid required
it filters the list by returning only the variables accessible by the selected parent_id. This field shall contain the id of a project, environment or service depending on the selected scope. Example, if scope = APPLICATION and parent_id=<application_id>, the result will contain any variable accessible by the application. The result will contain also any variable declared at an higher scope.
scope'APPLICATION' | 'BUILT_IN' | 'ENVIRONMENT' | 'PROJECT' | 'CONTAINER' | 'JOB' | 'HELM' | 'TERRAFORM' required
the type of the parent_id (application, project, environment etc..).
is_secretboolean nullable
it filters the list by returning only the variables of type secret or not
Response
List variables
Example response
{
"results": [
{
"aliased_variable": {
"key": "DATABASE_PSQL_NAME"
}
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.