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

Create Full Backup To Local Storage (Current Server)

POST

/backups

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Example

{
    "name": "Test Local Backup Via API2",
    "webApplicationId": 187,
    "databaseId": 123,
    "backupType": "full",
    "storage": "local",
    "format": "tar",
    "frequency": "1 week",
    "retention": "1 month",
    "excludeDevelopmentFiles": true,
    "excludeWordpressCacheFiles": true,
    "successNotification": true,
    "failNotification": true,
    "excludeFile": [
        "wp-config.php",
        "index.php"
    ],
    "excludeTable": [
        "wp-posts"
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://manage.runcloud.io/api/v3/backups' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Test Local Backup Via API2",
    "webApplicationId": 187,
    "databaseId": 123,
    "backupType": "full",
    "storage": "local",
    "format": "tar",
    "frequency": "1 week",
    "retention": "1 month",
    "excludeDevelopmentFiles": true,
    "excludeWordpressCacheFiles": true,
    "successNotification": true,
    "failNotification": true,
    "excludeFile": [
        "wp-config.php",
        "index.php"
    ],
    "excludeTable": [
        "wp-posts"
    ]
}'

Responses

🟢200Success

application/json

Body

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"
    }
}

Modified at 2025-07-01 01:19:04

Create Full Backup To External Storage

List Backup Instances