Addons /
Get addon
Required permission
Project > Addons > General > Read
Path parameters
projectId
string requiredID of the project
addonId
string requiredID of the addon
Response body
- {object}
Response object.
data
{object} requiredResult data.
id
string requiredIdentifier for the addon.
name
string requiredAddon name.
appId
string requiredFull identifier for the addon.
description
stringA short description of the addon.
createdAt
date requiredThe time the addon was created.
status
string requiredThe current state of the addon.
one ofpreDeployment, triggerAllocation, allocating, postDeployment, running, paused, scaling, upgrading, backup, restore, failed, deleting, deletedspec
{object} requiredDetails about the addon's specifications.
type
string requiredThe type of the addon
config
{object} requiredDetails about the addon configuration.
versionTag
string requiredThe version of the addon running.
lifecycleStatus
string requiredThe support status of the current addon version.
one ofactive, deprecated, discontinueddeployment
{object} requiredDetails about the addon deployment.
replicas
integer requiredThe number of replicas running for this addon.
storageClass
string requiredThe type of storage used by the addon.
storageSize
number requiredThe size of the addon storage, in MB.
planId
string requiredThe deployment plan used by the addon.
region
string requiredThe region where the addon is deployed.
networking
{object} requiredDetails about the addon networking settings.
tlsEnabled
boolean requiredWhether this addon is provisioned with a TLS certificate.
externalAccessEnabled
boolean requiredWhether this addon is publicly accessible via the internet.
ipPolicies
[array]An array of IP policy rules.
- {object}
Data about an IP policy rule.
address
string requiredAn IP address used by this rule.
action
string requiredThe action for this rule.
one ofDENY, ALLOW
GET /v1/projects/{projectId}/addons/{addonId}
Example response
200 OK
JSON
{
"data": {
"id": "example-addon",
"name": "Example Addon",
"appId": "/example-user/default-project/example-addon",
"description": "This is the addon description",
"createdAt": "2021-01-20T11:19:53.175Z",
"status": "running",
"spec": {
"type": "mongodb",
"config": {
"versionTag": "4.2.14",
"lifecycleStatus": "active",
"deployment": {
"replicas": 1,
"storageClass": "ssd",
"storageSize": 4096,
"planId": "nf-compute-20",
"region": "europe-west"
},
"networking": {
"tlsEnabled": true,
"externalAccessEnabled": true,
"ipPolicies": [
{
"address": "127.0.0.1",
"action": "ALLOW"
}
]
}
}
}
}
}