Addons /

Initiate point-in-time restore

Restores an addon to a specific point in time.

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}

targetTimestamp
string required
The timestamp to restore the addon to.

Response body

{object}
Response object.

data
{object} required
Result data.

id
string required
The identifier for the backup.
name
string required
The name of the backup.
status
string required
The current status of the backup.
one of
scheduled, in-progress, completed, aborting, aborted, failed, not-supported
createdAt
string required
The time the backup was initiated.
completedAt
string
The time the backup was completed.
config
{object} required
Data about the backup configuration.

source
{object}
Data about the source of the backup.

type
string
The type of backup.
one of
fileUpload, liveInstance, snapshot, externalDump, sameAddon

size
string required
The size of the backup, in bytes
addonVersion
string
The version of the addon at the time of the backup. If the backup type is `snapshot`, the addon will be restored to this version when the backup is restored.

lastRestore
{object}
Details about the most recent restore of this backup.

restoreTimestamp
string required
The time the backup was initiated.
status
string required
The current status of the restore.
one of
scheduled, in-progress, completed, aborting, aborted, failed, not-supported
completedAt
string
The time the restore was completed.

API

CLI

JS Client

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

Example request

Request body

curl

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"targetTimestamp":"2022-06-01T10:43:16.441Z"}' \
  https://api.northflank.com/v1/projects/{projectId}/addons/{addonId}/pitr

Example response

200 OK

Details about the newly created backup

JSON

{
  "data": {
    "id": "example-backup",
    "name": "Example Backup",
    "status": "completed",
    "createdAt": "2021-01-20T11:19:53.175Z",
    "completedAt": "2021-01-20T11:19:54.494Z",
    "config": {
      "source": {
        "type": "snapshot"
      },
      "size": "1234",
      "addonVersion": "4.4.8"
    },
    "lastRestore": {
      "restoreTimestamp": "2021-01-20T11:19:54.494Z",
      "status": "completed",
      "completedAt": "2021-01-20T11:19:54.494Z"
    }
  }
}