Addons /

List addon types

Gets information about the available addon types

Response body

{object}
Response object.

data
{object} required
Result data.

addonTypes
(multiple options: oneOf) required
A list of available addon types.

[array]

{object}
Northflank-managed addon type

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.
features
{object}
Features supported by this addon type.

backupsDump
boolean required
Whether this addon supports native (dump) backups
customDBName
boolean required
Whether this addon supports customising the database name.
forkAddon
boolean required
Whether this addon supports addon forking - creating a new addon from an existing addon backup.
importDump
boolean required
Whether this addon supports importing from an external backup.
importLive
boolean required
Whether this addon supports importing from an existing live database.
scaleReplicas
boolean required
Whether this addon supports replica scaling.
tls
boolean required
Whether this addon supports connection via TLS.
externalAccess
boolean required
Whether this addon supports external connection.

versions
[array] required
A list of available versions of the addon type.

string
A version string.

major
[array] required
A list of available major versions of the addon type.

string
A major version string.

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.

[array]

{object}
Custom addon type

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.
features
{object}
Features supported by this addon type.

backupsDump
boolean required
Whether this addon supports native (dump) backups
customDBName
boolean required
Whether this addon supports customising the database name.
forkAddon
boolean required
Whether this addon supports addon forking - creating a new addon from an existing addon backup.
importDump
boolean required
Whether this addon supports importing from an external backup.
importLive
boolean required
Whether this addon supports importing from an existing live database.
scaleReplicas
boolean required
Whether this addon supports replica scaling.
tls
boolean required
Whether this addon supports connection via TLS.
externalAccess
boolean required
Whether this addon supports external connection.

config
{object} required

showTemplateValues
boolean
Allow addon user to view values provided to templating engine.
enableTemplateValuesModification
boolean
Allow addon user to edit values provided to templating engine.
enableErrorRecovery
boolean
Allow addon user to view and resolve potential errors occuring with templating engine run.
installCrds
boolean
Install CRDs provided in resource bundle.
useNfLabelsAndAnnotations
boolean
Apply Northflank specific labels and annotations to Kubernetes resources. Required for core features such as viewing containers, logs, metrics.
useNfSecretInjection
boolean
Apply Northflank secret injection instead of using Kubernetes secrets.
useNfImagePullSecret
boolean
Inject Northflank-specific Kubernetes imagePullSecret to Pod resources.

scope
string required
If the addon deploys any k8s resources which are not namespace/project-scoped, it's a cluster scoped addon
one of
project, cluster

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.",
        "features": {
          "backupsDump": false,
          "customDBName": false,
          "forkAddon": false,
          "importDump": false,
          "importLive": false,
          "scaleReplicas": false,
          "tls": true,
          "externalAccess": true
        },
        "versions": [
          "6.0.8"
        ],
        "major": [
          "6.0"
        ],
        "resources": {
          "storage": {
            "options": [
              1024
            ],
            "default": 1024
          },
          "replicas": {
            "options": [
              1
            ],
            "default": 1
          }
        }
      }
    ]
  }
}