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

RunCloud

Edit Backup Instance

PATCH

/backups/{{backupId}}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

string

required

Example:

application/json

content-type

string

required

Example:

application/json

Body Params application/json

name

string

optional

Backup name

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

format

string

optional

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

frequency

string

optional

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

retention

string

optional

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'

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": "Edit Backup",
  "excludeDevelopmentFiles": false,
  "excludeWordpressCacheFiles": false,
  "format": "tar.gz",
  "frequency": "3 days",
  "retention": "3 weeks",
  "successNotification": false,
  "failNotification": false
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request PATCH 'https://manage.runcloud.io/api/v3/backups/{{backupId}}' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data-raw '{
    "name": "Edit Backup",    
    "excludeDevelopmentFiles": false,
    "excludeWordpressCacheFiles": false,            
    "format": "tar.gz",
    "frequency": "3 days",
    "retention": "3 weeks",
    "successNotification": false,
    "failNotification": false    
}'

Responses

🟢200Success

application/json

Body

message

string

required

backup

object

required

integer

required

Backup ID

label

string

required

Backup instance label

items

object

required

webApplicationId

integer

optional

Web Application ID assigned to the backup

databaseId

integer

optional

Database ID assigned to the backup

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 settings have been successfully updated.",
  "backup": {
    "id": 283,
    "label": "Test Full Backup Via API",
    "items": {
      "webApplicationId": 645,
      "databaseId": 479
    },
    "storage": "runcloud",
    "type": "full backup",
    "frequency": "1 day",
    "size": "70.3MB",
    "status": "active"
  }
}

Modified at 2024-10-16 09:02:36

Backup Instance Object

Run On Demand Backup