Skip to content

Create a backup for an environment

POST
/api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/backups/{type}
curl --request POST \
--url https://dashboard.quantcdn.io/api/v3/organizations/test-org/applications/test-app/environments/test-env/backups/database \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "description": "example" }'
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

Media typeapplication/json
object
description

Optional backup description

string
Examplegenerated
{
"description": "example"
}

Backup operation initiated

Media typeapplication/json
object
backupId
string
status
string
message
string
Examplegenerated
{
"backupId": "example",
"status": "example",
"message": "example"
}