Project / External Addons /

Create external addon

Creates a new external addon (third-party cloud resource provisioned via OpenTofu)

Required permission

Project > ExternalAddons > General > Create

Path parameters

projectId
string required
ID of the project

Request body

{object}
Request body for creating an external addon

description
string
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
tags
[array]
An array of previously defined tags to help identify and group the resource.

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

environmentId
string
spec
{object}
name
string required
min length
3
max length
100
pattern
^[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*$

Response body

{object}
Response object.

data
{object} required
Result data.

description
string
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
tags
[array]
An array of previously defined tags to help identify and group the resource.

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

environmentId
string
spec
{object}
name
string required
min length
3
max length
100
pattern
^[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*$

API

CLI

JS Client

POST /v1/projects/{projectId}/external-addons

POST /v1/teams/{teamId}/projects/{projectId}/external-addons

Example request

Request body

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"spec":{"provider":{"aws":{"region":"eu-west-1"},"google":{"region":"us-central1","zone":"us-central1-c"}}}}' \
  https://api.northflank.com/v1/projects/{projectId}/external-addons

Example response

200 OK

Details about the created external addon.

JSON

{
  "data": {
    "spec": {
      "provider": {
        "aws": {
          "region": "eu-west-1"
        },
        "google": {
          "region": "us-central1",
          "zone": "us-central1-c"
        }
      }
    }
  }
}