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.
features
{object}Features supported by this addon type.
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"
],
"features": {
"tls": false,
"externalAccess": false
},
"resources": {
"storage": {
"options": [
1024
],
"default": 1024
},
"replicas": {
"options": [
1
],
"default": 1
}
}
}
]
}
}