Addons /

Get addon

Gets information about the given addon

Required permission

Project > Addons > General > Read

Path parameters

projectId
string required
ID of the project
addonId
string required
ID of the addon

Response body

{object}
Response object.

data
{object} required
Result data.

id
string required
Identifier for the addon.
name
string required
Addon name.
appId
string required
Full identifier for the addon.
tags
[array] required
An array of previously defined tags to help identify and group the resource.

string
min length
1
max length
100
pattern
^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$

description
string
A short description of the addon.
createdAt
string required
The time the addon was created.
status
string required
The current state of the addon.
one of
preDeployment, triggerAllocation, allocating, postDeployment, running, paused, scaling, upgrading, resetting, backup, restore, failed, error, errorAllocating, deleting, deleted
spec
{object} required
Details about the addon's specifications.
cluster
{object} required
Cluster information

id
string required
The id of the cluster associated with this project.
name
string required
The name of the cluster associated with this project.
namespace
string
Namespace this resource is located within on the cluster.
loadBalancers
[array]
Load balancer DNS for the cluster.

string

API

CLI

JS Client

GET /v1/projects/{projectId}/addons/{addonId}

Example response

200 OK

Details about the addon.

JSON

{
  "data": {
    "id": "example-addon",
    "name": "Example Addon",
    "appId": "/example-user/default-project/example-addon",
    "tags": [
      "my-tag"
    ],
    "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"
            }
          ]
        }
      }
    },
    "cluster": {
      "id": "nf-europe-west",
      "name": "nf-europe-west",
      "namespace": "ns-8zy2mcjh9zn2",
      "loadBalancers": [
        "lb.659200800000000000000000.northflank.com"
      ]
    }
  }
}