Sign in
Backups

List all backups in an S3 source

Changed on
get/backups/s3-sources/{id}/backups

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/backups/s3-sources/{id}/backups
  • Auth: HTTP bearer

Path parameters

idinteger required

Query parameters

include_s3_scanboolean

When true, scan the S3 bucket for backups not tracked in the local database (useful after disaster-recovery from another Temps instance). Defaults to false — the fast DB-only path.

Response

List of all backups in the source

last_updatedstring required

When the index was last updated

Example response

{
  "backups": [
    {
      "backup_id": "550e8400-e29b-41d4-a716-446655440000",
      "backup_type": "full",
      "created_at": "2024-01-15T14:30:00.123Z",
      "engine": "postgres",
      "expires_at": "2024-02-14T14:30:00.123Z",
      "format": "walg",
      "id": 1,
      "location": "s3://bucket/external_services/postgres/svc-name/walg",
      "name": "postgres backup (postgres-n4ea)",
      "origin_service_name": "postgres-n4ea",
      "size_bytes": 1024000,
      "source": "db",
      "state": "completed"
    }
  ],
  "last_updated": "2024-01-15T14:30:00.123Z"
}

Changes

  • 4b228ebed583Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 1dc3e6788214Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status