Secrets /
Get secret addon link details
Path parameters
projectId
string requiredID of the project
secretId
string requiredID of the secret
addonId
string requiredID of the addon
Response body
- {object}
Response object.
data
{object} requiredResult data.
secretName
string requiredThe name of the secret group
secretId
string requiredIdentifier for the secret group
addonName
string requiredThe name of the linked addon
addonId
string requiredThe ID of the linked addon
addonType
string requiredThe addon type of the linked addon
linked
boolean requiredIs this addon currently linked to this secret group?
linkedKeys
[array]An array of objects containing details about the keys linked to this secret group.
- {object}
Details about a key linked to this secret group.
keyName
string requiredThe name of the key to link.
pattern[a-zA-Z]+aliases
[array]An array of aliases for the key.
- string
The name of the alias. Keys may only contain letters, numbers, hyphens, forward slashes and dots.
pattern^[a-zA-Z0-9_./-]*$ defaultKey
string requiredavailableKeys
[array] requiredA list of available keys for the given addon.
- string
GET /v1/projects/{projectId}/secrets/{secretId}/addons/{addonId}
Example response
200 OK
JSON
{
"data": {
"secretName": "Example secret group",
"secretId": "example-secret-group",
"addonName": "Example Addon",
"addonId": "example-addon",
"addonType": "mongodb",
"linked": true,
"linkedKeys": [
{
"keyName": "USERNAME",
"aliases": [
"MONGO_USERNAME"
],
"defaultKey": "NF_EXAMPLE-ADDON_USERNAME"
}
],
"availableKeys": [
"username"
]
}
}