Skip to content

Create a backup for an environment

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

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

Request Body

object
description

Optional backup description

string
retentionDays

Optional retention period in days

integer

Responses

202

Backup operation initiated

object
backupId
string
status
string
message
string