Services /
Get service runtime environment details
Required permission
Project > Services > Configuration > View Environment Variables
Path parameters
projectId
string requiredID of the project
serviceId
string requiredID of the service
Response body
- {object}
Response object.
data
{object} requiredResult data.
runtimeEnvironment
{object} requiredDetails about all the secrets accessible by the service.
MY_VARIABLE_NAME
{object}A stored secret and details about it and its value. This can have the name of any saved secret.
value
requiredThe value of the secret.
inheritedFrom
stringThe ID of the secret group the secret is inherited from, if applicable.
addonId
stringThe ID of the addon the secret is inherited from, if applicable.
priority
integerThe priority of the secret group the secret is inherited from, if applicable.
overriding
[array] requiredAn array containing data about other places the secret has been inherited from, but that are not being used as a secret with the same key exists with a higher priority.
- {object}
Data about an overridden secret.
value
requiredThe value of the secret.
inheritedFrom
string requiredThe ID of the secret group the secret is inherited from.
addonId
stringThe ID of the addon the secret is inherited from, if applicable.
priority
integer requiredThe priority of the secret group the secret is inherited from.
runtimeFiles
{object} requiredDetails about all the secrets accessible by the service.
/dir/fileName
{object}A stored secret and details about it and its value. This can have the name of any saved secret.
value
{object} requiredThe value of the secret.
data
stringbase64 encoded string of the file contents
encoding
stringOriginal encoding of the file
inheritedFrom
stringThe ID of the secret group the secret is inherited from, if applicable.
priority
integerThe priority of the secret group the secret is inherited from, if applicable.
overriding
[array] requiredAn array containing data about other places the file has been inherited from, but that are not being used as a secret with the same file path exists with a higher priority.
- {object}
Data about an overridden secret.
value
requiredThe value of the secret.
inheritedFrom
string requiredThe ID of the secret group the secret is inherited from.
priority
integer requiredThe priority of the secret group the secret is inherited from.
GET /v1/projects/{projectId}/services/{serviceId}/runtime-environment/details
Example response
200 OK
JSON
{
"data": {
"runtimeEnvironment": {
"MY_VARIABLE_NAME": {
"value": "abcdef123456",
"inheritedFrom": "example-secret",
"addonId": "example-addon",
"priority": 10,
"overriding": [
{
"value": "ffffffffffff",
"inheritedFrom": "secret-2",
"addonId": "addon-2",
"priority": 0
}
]
}
},
"runtimeFiles": {
"/dir/fileName": {
"value": {
"data": "VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=",
"encoding": "utf-8"
},
"inheritedFrom": "example-secret",
"priority": 10,
"overriding": [
{
"value": "ffffffffffff",
"inheritedFrom": "secret-2",
"priority": 0
}
]
}
}
}
}