Addons /
List addon types
Response body
- {object}
Response object.
data
{object} requiredResult data.
addonTypes
[array] requiredA list of available addon types.
- {object}
type
string requiredThe identifier for the addon type.
name
string requiredThe name of the addon type.
description
string requiredA description of the addon.
versions
[array] requiredA list of available versions of the addon type.
- string
A version string.
major
[array] requiredA list of available major versions of the addon type.
- string
A major version string.
features
{object}Features supported by this addon type.
backupsDump
boolean requiredWhether this addon supports native (dump) backups
customDBName
boolean requiredWhether this addon supports customising the database name.
forkAddon
boolean requiredWhether this addon supports addon forking - creating a new addon from an existing addon backup.
importDump
boolean requiredWhether this addon supports importing from an external backup.
importLive
boolean requiredWhether this addon supports importing from an existing live database.
scaleReplicas
boolean requiredWhether this addon supports replica scaling.
tls
boolean requiredWhether this addon supports connection via TLS.
externalAccess
boolean requiredWhether this addon supports external connection.
resources
{object} requiredDetails about resource options for the addon type.
storage
{object} requiredDetails about storage size options for this addon.
options
[array] requiredAvailable options for storage size for this addon, in MB.
- number
default
number requiredThe default storage value for this addon.
replicas
{object} requiredDetails about replica count options for this addon.
options
[array] requiredAvailable options for replica counts for this addon.
- number
default
number requiredThe default replica count for this addon.
GET /v1/addon-types
Example response
200 OK
JSON
{
"data": {
"addonTypes": [
{
"type": "redis",
"name": "Redis",
"description": "Redis implements a distributed, in-memory key-value database with optional durability.",
"versions": [
"6.0.8"
],
"major": [
"6.0"
],
"features": {
"backupsDump": false,
"customDBName": false,
"forkAddon": false,
"importDump": false,
"importLive": false,
"scaleReplicas": false,
"tls": true,
"externalAccess": true
},
"resources": {
"storage": {
"options": [
1024
],
"default": 1024
},
"replicas": {
"options": [
1
],
"default": 1
}
}
}
]
}
}