List Backup Instances

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

storage

string

optional

id of storage integration, or 'runcloud' for runcloud storage, or 'local' for local storage

search

string

optional

search by name

server_id

string

optional

id of server

status

string

optional

status of backup, the options 'archived', 'disabled', 'paused', 'active', 'failed'

sort_column

string

optional

sort list by 'name', or 'size' or 'created_at'

sort_direction

string

optional

sort order, 'asc', or 'desc'

Body Params multipart/form-data

object {0}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

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

data

array [object {8}]

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

meta

object

required

pagination

object

required

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