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

List Backup Instances

GET

/backups

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

Body Params multipart/form-data

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://manage.runcloud.io/api/v3/backups?storage&search&server_id&status&sort_column&sort_direction'

Responses

🟢200Success

application/json

Body

Example

{
    "data": [
        {
            "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"
        },
        {
            "id": 286,
            "label": "Test Local Backup Via API",
            "items": {
                "webApplicationId": 645,
                "databaseId": 479
            },
            "storage": "local",
            "type": "full backup",
            "frequency": "1 day",
            "size": "70.3MB",
            "status": "active"
        }
    ],
    "meta": {
        "pagination": {
            "total": 2,
            "count": 2,
            "per_page": 20,
            "current_page": 1,
            "total_pages": 1,
            "links": {}
        }
    }
}

Modified at 2025-05-13 02:23:19

Create Full Backup To Local Storage (Current Server)

Backup Instance Object