Services /
Get service runtime environment
Required permission
Project > Services > Configuration > View Environment Variables
Path parameters
projectId
string requiredID of the project
serviceId
string requiredID of the service
Query parameters
show
stringWhich secrets to display - if set to
this
only the group's secrets are displayed, if set toinherited
only secrets from linked addons are displayed, if set toall
or not provided, both are displayed.one ofthis, inherited, allreplaceTemplatedValues
stringIf templated secrets should be replaced with their inferred value rather than returned as template strings.
one oftrue
Response body
- {object}
Response object.
data
{object} requiredResult data.
runtimeEnvironment
{object} requiredThe runtime environment variables, formatted as a JSON object. If the
show
parameter is set tothis
, this will only contain secrets saved to this entity. If theshow
parameter is set toinherited
, this will only contain secrets inherited from linked secret groups. Otherwise, this will contain both.runtimeFiles
{object} requiredThe runtime secret files, formatted as a JSON object. If the
show
parameter is set tothis
, this will only contain files saved to this entity. If theshow
parameter is set toinherited
, this will only contain files inherited from linked secret groups. Otherwise, this will contain both.
GET /v1/projects/{projectId}/services/{serviceId}/runtime-environment
Example response
200 OK
JSON
{
"data": {
"runtimeEnvironment": {
"VARIABLE_1": "abcdef",
"VARIABLE_2": "12345"
},
"runtimeFiles": {
"/dir/fileName": {
"data": "VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=",
"encoding": "utf-8"
}
}
}
}