Addons /

Create addon

Creates a new addon

URL parameters

project
string required
ID of the project

Request attributes

object

name
string required
The name of the addon.
pattern
^[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*$
min length
3
max length
20
description
string
A description of the addon.
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
max length
200
type
string required
The identifier for the type of addon. Addon types can be found at the Get Addon Types endpoint.
version
string required
The version of the addon type to use.
billing
object required

deploymentPlan
string required
The ID of the deployment plan to use.
pattern
^[A-Za-z0-9-]+$
storage
integer required
The size of the addon storage, in megabytes.
min
1
replicas
integer required
The number of addon replicas to run.
min
1

tlsEnabled
boolean
Enables access to the addon via TLS (if supported by the addon type).
externalAccessEnabled
boolean
Enables external access to the addon via TLS (if supported by the addon type).

Response attributes

object

type
string required
The type of the addon created
nfObjectId
string required
The internal ID of the newly created addon
name
string required
The name of the newly created addon.
description
string
The description of the newly created addon.

API

CLI

POST /v1beta/projects/{project}/addons

Example request

request body

curl

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"name":"Example Addon","description":"An addon description","type":"postgres","version":"12.4.0","billing":{"deploymentPlan":"nf-compute-20","storage":1024,"replicas":1}}' \
  https://api.northflank.com/v1beta/projects/{project}/addons

Example response

200 OK

Details about the newly created addon.

JSON

{
  "type": "normal",
  "nfObjectId": "new-addon",
  "name": "New Addon",
  "description": "This is a new addon."
}