Skip to main content
POST
Create Application Snapshot
string
required
The ID of the application or database to snapshot.
string
required
The resource type. Possible values: applications, databases.
Two limits apply to manual snapshots, on top of the route’s 5 requests per minute. The same resource can be snapshotted once every 5 minutes, and an account can create at most 10 snapshots per hour across all its resources. Over either limit the API answers 429 SNAPSHOT_RATE_LIMITED with details.scope (resource or account) and details.retry_after in seconds. Snapshots the platform takes on its own (before a delete or a reset) do not count. See Rate Limiting.

Response

object
The snapshot that was created.

Error Responses

string
The error code indicating the reason for failure. Possible values:
  • UNAUTHORIZED: The user is not authenticated.
  • USER_NOT_FOUND: The authenticated user was not found.
  • APP_NOT_FOUND: The specified application does not exist.
  • DATABASE_NOT_FOUND: The specified database does not exist.
  • ACCESS_DENIED: The user does not own the resource.
  • PLAN_NOT_ALLOWED: The account’s plan does not include manual snapshots (403).
  • DATABASE_NOT_RUNNING: The database must be running to take a snapshot (409). Redis has no such requirement.
  • SNAPSHOT_RATE_LIMITED: The resource was snapshotted less than 5 minutes ago, or the account already created 10 snapshots this hour (429). Comes with details.scope and details.retry_after.
  • OPERATION_IN_PROGRESS: Another lifecycle operation on the same resource is already running (409). Nothing was snapshotted — wait a few seconds and retry.
  • INTERNAL_SERVER_ERROR: The snapshot could not be stored. Retry later.
  • UNKNOWN_ERROR: An unexpected platform error occurred.
  • INTERNAL_SERVER_ERROR: An unexpected server error occurred.