Skip to navigation
API Referencedatabase-backups

Trigger an on-demand backup

Authentication

X-API-Client-IDstring
API Client ID
X-API-Client-Secretstring
API Client Secret

Path parameters

clusterIdstringRequired
Database cluster ID

Request

This endpoint expects an object.
backupMethodenumRequired
Backup method to use for this run.
Allowed values:
backupPolicyNamestringRequired
Backup policy that governs this run.
backupNamestringRequired
Name to assign to the resulting backup artifact.
retentionPeriodstringRequired

How long to keep the backup. Number followed by d (days), h (hours), or m (minutes).

deletionPolicyenumRequired
Action to take on the backup artifact when the policy is removed.
Allowed values:

Response

Backup trigger accepted

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error