This API v3 documentation is currently still on progress. For any issue, please contact support@runcloud.io

Restore Backup Snapshot To a New Webapp and/or Database

POST

/backups/113/snapshots/6/restore

This endpoint is for restoring backup to a new Web Application and Database which will automatically be created during the restoring backup process

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

restoreTarget

string

required

Where to restore snapshot, can use one of 'current', 'new', or 'other'

clearFiles

boolean

required

Clear any existing web application files & database before restoring?

newWebAppName

string

required

New Web Application name for restored backup

newDatabaseName

string

required

New Database name for restored backup

domainName

string

required

Domain name for the web app

serverId

integer

optional

ID of server where backup will restored, default value is same server with the original backup

dnsProvider

string

optional

DNS provider, either "cloudflare" or null, default value is null

cfApiKeyId

integer

optional

ID of Cloudflare API in integration page, required if dnsProvider is "cloudflare"

proxy

boolean

optional

Enable Cloudflare Proxy, default value is false

www

boolean

optional

enable WWW subdomain, default value is false

redirection

string

optional

Type of redirection, can be "www", or "non-www" or "none", default value is "none"

Example

{
  "restoreTarget": "new",
  "clearFiles": false,
  "serverId": 12,
  "newWebAppName": "app-treutela",
  "newDatabaseName": "app_treutela",
  "domainName": "lllllla.test",
  "dnsProvider": "none",
  "cfApiKeyId": null,
  "www": false,
  "redirection": "none"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://manage.runcloud.io/api/v3/backups/113/snapshots/6/restore' \
--header 'Content-Type: application/json' \
--data-raw '{  
  "restoreTarget": "new",
  "clearFiles": false,
  "serverId": 12,
  "newWebAppName": "app-treutela",
  "newDatabaseName": "app_treutela",
  "domainName": "lllllla.test",
  "dnsProvider": "none",
  "cfApiKeyId": null,
  "www": false,
  "redirection": "none"
}'

Responses

🟢200Success

application/json

Body

message

string

required

Example

{
  "message": "Backup restore process will begin shortly"
}

Modified at 2025-02-10 05:47:37

Restore Backup Snapshot To Other Webapp and/or Database

Create an atomic project