Project / Addons /

Import addon backup

Imports a database from an external archive or existing live database.

Required permission

Project > Addons > General > Update

Path parameters

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

Request body

{object}
Import using a connection string. The database will be imported from the live database located at the connection string's location.

name
string
The name of the backup. If not provided, a default name will be generated containing the current date.
min length
3
max length
39
pattern
^[a-zA-Z0-9]+((-|\s|\/|:)[a-zA-Z0-9]+)*$
connectionString
string required
A database connection string.
importAllDatabases
boolean
Detect and import all databases. If false, attempts to import only the database specified in the connection string
compressionType
string
The compression algorithm for storing the imported file. Defaults to `gz`.
one of
gz, zstd
customDestinationId
string
Custom destination to store the imported backup in. If not specified, backup is stored in Northflank-managed destination.
min length
3
max length
100
pattern
^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$

{object}
Import using an external archive. The database will be imported from an existing backup.

name
string
The name of the backup. If not provided, a default name will be generated containing the current date.
min length
3
max length
39
pattern
^[a-zA-Z0-9]+((-|\s|\/|:)[a-zA-Z0-9]+)*$
importUrl
string required
A url pointing to an existing backup stored as a GNU zip (.gz) file.
customDestinationId
string
Custom destination to store the imported backup in. If not specified, backup is stored in Northflank-managed destination.
min length
3
max length
100
pattern
^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$

API

CLI

JS Client

POST /v1/projects/{projectId}/addons/{addonId}/import

Example request

Request body

Import using a connection string. The database will be imported from the live database located at the connection string's location.

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"name":"Example Backup","connectionString":"mongodb://mongodb0.example.com:27017","compressionType":"gz"}' \
  https://api.northflank.com/v1/projects/{projectId}/addons/{addonId}/import

Import using an external archive. The database will be imported from an existing backup.

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"name":"Example Backup","importUrl":"https://example.com/backup.db.gz"}' \
  https://api.northflank.com/v1/projects/{projectId}/addons/{addonId}/import

Example response

200 OK

success