Snapshots

Download schema

Endpoints for the restic snapshots of the team's backup jobs. Every backup run makes one snapshot for a file backup or one per database for a database backup. Restore them with the agent or restic, or prepare a hosted download.

List the snapshots of a backup job

GET

https://backup.chief.app/api/v1

/jobs/{job}/snapshots

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

List the snapshots the job's backups made, newest first.

List the snapshots of a backup job › path Parameters

job

string · required

List the snapshots of a backup job › query Parameters

per_page

integer · min: 1 · max: 100

Number of results per page.

Default: 50

page

integer · min: 1

Page number to return.

Default: 1

availability

string | null · enum

Only return snapshots with this availability, available for the snapshots that can still be restored.

Enum values:

available

expired

unknown

List the snapshots of a backup job › Responses

Paginated set of Snapshot

Snapshot[] · required

object · required

GET/jobs/{job}/snapshots

curl https://backup.chief.app/api/v1/jobs/:job/snapshots \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": "snapshot_01j8q8zk2f4m6n7p9r1s3t5v7x",
      "snapshot_id": "4f2a9c1d8e7b6a5f4e3d2c1b0a9f8e7d6c5b4a3f2e1d0c9b8a7f6e5d4c3b2a1f",
      "job": {
        "id": "job_01j8q8zk2f4m6n7p9r1s3t5v7x",
        "name": "name"
      },
      "run_id": "run_01j8q8zk2f4m6n7p9r1s3t5v7x",
      "availability": "available",
      "source_bytes": 0,
      "stored_bytes": 0,
      "database": {
        "name": "shop",
        "filename": "shop.sql"
      },
      "kept_forever_at": "kept_forever_at",
      "copies": [
        {
          "repository_id": "repository_01j8q8zk2f4m6n7p9r1s3t5v7x",
          "storage_destination": {
            "id": "id",
            "name": "name"
          },
          "snapshot_id": "snapshot_id",
          "availability": "available"
        }
      ],
      "taken_at": "taken_at",
      "created_at": "created_at"
    }
  ],
  "links": {
    "first": "first",
    "last": "last",
    "prev": "prev",
    "next": "next"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "url",
        "label": "label",
        "active": true
      }
    ],
    "path": "path",
    "per_page": 0,
    "to": 1,
    "total": 0
  }
}

json

application/json

Get a snapshot

GET

https://backup.chief.app/api/v1

/snapshots/{snapshot}

OpenID Connect

Bearer (ctp_*)

Bearer (ctt_*)

Get one snapshot with its copies in extra copy repositories.

Get a snapshot › path Parameters

snapshot

string · required

Get a snapshot › Responses

Snapshot

Snapshot · required

GET/snapshots/{snapshot}

curl https://backup.chief.app/api/v1/snapshots/:snapshot \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": {
    "id": "snapshot_01j8q8zk2f4m6n7p9r1s3t5v7x",
    "snapshot_id": "4f2a9c1d8e7b6a5f4e3d2c1b0a9f8e7d6c5b4a3f2e1d0c9b8a7f6e5d4c3b2a1f",
    "job": {
      "id": "job_01j8q8zk2f4m6n7p9r1s3t5v7x",
      "name": "name"
    },
    "run_id": "run_01j8q8zk2f4m6n7p9r1s3t5v7x",
    "availability": "available",
    "source_bytes": 0,
    "stored_bytes": 0,
    "database": {
      "name": "shop",
      "filename": "shop.sql"
    },
    "kept_forever_at": "kept_forever_at",
    "copies": [
      {
        "repository_id": "repository_01j8q8zk2f4m6n7p9r1s3t5v7x",
        "storage_destination": {
          "id": "id",
          "name": "name"
        },
        "snapshot_id": "snapshot_id",
        "availability": "available"
      }
    ],
    "taken_at": "taken_at",
    "created_at": "created_at"
  }
}

json

application/json

Runs Downloads