v1beta
ApplicationAPI & CLI
Double column
curl
API
CLI

Addons /

Import backup

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

URL parameters

    • project

      string required

      ID of the project

    • addon

      string required

      ID of the addon

Request attributes

  • 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.

      pattern
      ^[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*$
      min length
      3
      max length
      20

    • connectionString

      string

      A database connection string.

OR

  • 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.

      pattern
      ^[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*$
      min length
      3
      max length
      20

    • importUrl

      string

      A url pointing to an existing backup stored as a GNU zip (.gz) file.

API
CLI

POST /v1beta/projects/{project}/addons/{addon}/import

Example request

request body

live

curl

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

OR

url

curl

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/v1beta/projects/{project}/addons/{addon}/import

Example response

200 OK

success

© 2021 Northflank Ltd. All rights reserved.

TermsPrivacy

contact@northflank.com