Create Full Backup To RunCloud Storage

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

name

string

required

Backup name

webApplicationId

integer

optional

ID of Web Application that will be backup, each backup should have at least webApplicationId or databaseId

databaseId

integer

optional

ID of Database that will be backup, each backup should have at least webApplicationId or databaseId

backupType

string

required

Type of the backup, either 'incremental' or 'full'. Incremental backup only for 'runcloud' storage tough

storage

string

required

Backup storage, can be 'runcloud', 'local' or 'external'

integrationId

integer

optional

ID of 3rd Party API for external storage, only required if storage is external

format

string

required

Backup format, either 'tar' or 'tar.gz'

frequency

string

required

Frequency of backup, can be one of '12 hours', '1 day', '2 days', '3 days', or '1 week'

retention

string

required

Retention how long backup stored, can be one of Valid frequency is one of '3 days', '1 week', '2 weeks', '1 month', '2 months', '3 months', '6 months', or '1 year'

excludeDevelopmentFiles

boolean

optional

Automatically exclude .git, node_modules, vendors, and storage/logs directories, default is true

excludeWordpressCacheFiles

boolean

optional

For WordPress web app, automatically exclude related backup & cache files/directories, defaut value is true

successNotification

boolean

optional

Send notification when backup success, default value is false

failNotification

boolean

optional

Send notification when backup failed, default value is true

Example

{
  "name": "Test external Backup Via API2",
  "webApplicationId": 187,
  "databaseId": 123,
  "backupType": "full",
  "storage": "runcloud",
  "format": "tar",
  "frequency": "1 week",
  "retention": "1 month",
  "excludeDevelopmentFiles": true,
  "excludeWordpressCacheFiles": true,
  "successNotification": true,
  "failNotification": true
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://manage.runcloud.io/api/v3/backups' \
--header 'Content-Type: application/json' \
--data-raw '{ 
    "name": "Test external Backup Via API2",
    "webApplicationId": 187,
    "databaseId": 123,
    "backupType": "full",
    "storage": "runcloud",
    "format": "tar",
    "frequency": "1 week",
    "retention": "1 month",
    "excludeDevelopmentFiles": true,
    "excludeWordpressCacheFiles": true,
    "successNotification": true,
    "failNotification": true  
}'

Responses

🟢200Success

application/json

Body

message

string

required

backup

object

required

id

integer

required

Backup ID

label

string

required

Backup instance label

items

object

required

storage

string

required

Type of storage

type

string

required

Type of backup

frequency

string

required

Backup frequency

size

string

required

Size of backup instance

status

string

required

Backup status

Example

{
  "message": "Backup instance has been successfully created.",
  "backup": {
    "id": 286,
    "label": "Test Local Backup Via API",
    "items": {
      "webApplicationId": 645,
      "databaseId": 479
    },
    "storage": "local",
    "type": "full backup",
    "frequency": "1 day",
    "size": "0B",
    "status": "active"
  }
}