List backups for an environment

GET

/api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/backups/{type}

const url = 'https://dashboard.quantcdn.io/api/v3/organizations/test-org/applications/test-app/environments/test-env/backups/database?order=asc&limit=50&status=completed';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://dashboard.quantcdn.io/api/v3/organizations/test-org/applications/test-app/environments/test-env/backups/database?order=asc&limit=50&status=completed' \
  --header 'Authorization: Bearer <token>'

Retrieves a list of backups (database or filesystem) for the environment with status, size, and metadata. Supports filtering and ordering via query parameters.

Authorizations

BearerAuth

Parameters

Path Parameters

organisation

required

string

The organisation ID

Example

test-org

application

required

string

The application ID

Example

test-app

environment

required

string

The environment ID

Example

test-env

type

required

string

Allowed values: database filesystem

The backup type

Query Parameters

order

string

default: desc

Allowed values: asc desc

Sort order for backups by creation date (asc = oldest first, desc = newest first)

limit

integer

default: 50 >= 1 <= 100

Maximum number of backups to return (max 100)

createdBefore

string format: date-time

Only return backups created before this ISO 8601 timestamp (e.g., 2025-01-01T00:00:00Z)

createdAfter

string format: date-time

Only return backups created after this ISO 8601 timestamp (e.g., 2024-12-01T00:00:00Z)

status

string

Allowed values: completed failed running

Filter backups by status

nextToken

string

Token for retrieving the next page of results

Responses

200

List of backups

application/json

object

backups

Array<object>

object

backupId

string

status

string

type

string

engine

string

description

string

createdAt

string format: date-time

updatedAt

string format: date-time

taskArn

string

s3Key

string

bucketName

string

size

integer

sizeFormatted

string

fileExists

boolean

count

integer

nextToken

Token for retrieving the next page of results, if more data is available

string

nullable

message

string

Example

{
  "backups": [
    {
      "backupId": "quant-gov-dashboard-staging-2025-09-19T21-50-27-145Z",
      "status": "completed",
      "type": "logical",
      "engine": "mysql",
      "description": "Manual backup",
      "createdAt": "2025-09-19T21:50:27.317Z",
      "updatedAt": "2025-09-19T21:51:09+00:00",
      "taskArn": "arn:aws:ecs:ap-southeast-4:056500205767:task/au-prd-quant-cloud-cluster/305a68f04bf641f887a87b74d67fa57e",
      "s3Key": "database-backups/quant-gov/dashboard/staging/quant-gov-dashboard-staging-2025-09-19T21-50-27-145Z.sql.gz",
      "bucketName": "au-prd-manual-backups",
      "size": 1945663,
      "sizeFormatted": "1.86 MB",
      "fileExists": true
    }
  ],
  "count": 1,
  "message": "Found 1 database backup(s)"
}

422

Invalid backup type

application/json

object

error

string

Example

{
  "error": "The backup type must be either database or filesystem"
}