Skip to content
QuantCDN

List backups for an environment

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

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

Authorizations

Parameters

Path Parameters

organisation
required
string

The organisation ID

application
required
string

The application ID

environment
required
string

The environment ID

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

object
backups
Array<object>
object
backupId
string
quant-gov-dashboard-staging-2025-09-19T21-50-27-145Z
status
string
completed
type
string
logical
engine
string
mysql
description
string
Manual backup
createdAt
string format: date-time 
2025-09-19T21:50:27.317Z
updatedAt
string format: date-time 
2025-09-19T21:51:09+00:00
taskArn
string
arn:aws:ecs:ap-southeast-4:056500205767:task/au-prd-quant-cloud-cluster/305a68f04bf641f887a87b74d67fa57e
s3Key
string
database-backups/quant-gov/dashboard/staging/quant-gov-dashboard-staging-2025-09-19T21-50-27-145Z.sql.gz
bucketName
string
au-prd-manual-backups
size
integer
1945663
sizeFormatted
string
1.86 MB
fileExists
boolean
true
count
integer
1
nextToken

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

string
nullable
message
string
Found 1 database backup(s)

422

Invalid backup type

object
error
string
The backup type must be either database or filesystem