Addons /

List addon types

Gets information about the available addon types

Response body

{object}
Response object.

data
{object} required
Result data.

addonTypes
[array] required
A list of available addon types.

{object}

type
string required
The identifier for the addon type.
name
string required
The name of the addon type.
description
string required
A description of the addon.
versions
[array] required
A list of available versions of the addon type.

string
A version string.

features
{object}
Features supported by this addon type.

tls
boolean required
Whether this addon supports connection via TLS.
externalAccess
boolean required
Whether this addon supports external connection.

resources
{object} required
Details about resource options for the addon type.

storage
{object} required
Details about storage size options for this addon.

options
[array] required
Available options for storage size for this addon, in MB.

number

default
number required
The default storage value for this addon.

replicas
{object} required
Details about replica count options for this addon.

options
[array] required
Available options for replica counts for this addon.

number

default
number required
The default replica count for this addon.

API

CLI

JS Client

GET /v1/addon-types

Example response

200 OK

A list of the available addon types.

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
          }
        }
      }
    ]
  }
}