DigitalOcean
SnapShooter

Restore Jobs

List #

URL Parameters

string status (optional)

Filter by status. Options: pending, running, failed, completed. 

                            GET
                            /v1/restore-jobs
                        
                           
curl https://api.snapshooter.com/v1/restore-jobs \
    -X GET \
    --header 'Authorization: Bearer API_TOKEN_HERE' \
                       
HTTP/2 200
{
  "data": [
    {
      "id": "ed6ca4f1-6047-4deb-a69d-8c42ba7e745f",
      "job_id": "5d32e6da-7d64-40c7-9e7f-6f16080a13c4",
      "backup_id": "70bf81d5-bf19-4a09-b0e0-c10b140d712e",
      "compute": {
        "id": 3,
        "type": "server",
        "server": {
          "id": 3,
          "host": "...",
          "user": "root",
          "port": 22,
          "name": "WordPress Blog",
          "created_at": "2023-04-25T14:16:59.000000Z",
          "last_used": "2023-07-06T21:02:49.000000Z",
          "status": "success"
        }
      },
      "status": "completed",
      "created_at": "2023-07-21T15:36:39.000000Z",
      "started_at": "2023-07-21T15:36:46.000000Z",
      "completed_at": "2023-07-21T15:37:07.000000Z"
    },
    {
      "id": "4e6ffbf7-1069-4618-bf1c-038ad6f8ee8b",
      "job_id": "5d32e6da-7d64-40c7-9e7f-6f16080a13c4",
      "backup_id": "70bf81d5-bf19-4a09-b0e0-c10b140d712e",
      "compute": {
        "id": 3,
        "type": "server",
        "server": {
          "id": 3,
          "host": "...",
          "user": "root",
          "port": 22,
          "name": "My Ecommerce",
          "created_at": "2023-04-25T14:16:59.000000Z",
          "last_used": "2023-07-06T21:02:49.000000Z",
          "status": "success"
        }
      },
      "status": "pending",
      "created_at": "2023-07-21T15:36:07.000000Z",
      "started_at": null,
      "completed_at": null
    }
  ],
  "links": {},
  "meta": {}
}

Show #

URL Parameters

This endpoint does not accept any parameters 
                            GET
                            /v1/restore-jobs/{restore_job_id}
                        
                           
curl https://api.snapshooter.com/v1/restore-jobs/{restore_job_id} \
    -X GET \
    --header 'Authorization: Bearer API_TOKEN_HERE'
                       
HTTP/2 200
{
  "data": {
    "id": "ed6ca4f1-6047-4deb-a69d-8c42ba7e745f",
    "job_id": "5d32e6da-7d64-40c7-9e7f-6f16080a13c4",
    "backup_id": "70bf81d5-bf19-4a09-b0e0-c10b140d712e",
    "compute": {
      "id": 3,
      "type": "server",
      "server": {
        "id": 3,
        "host": "...",
        "user": "root",
        "port": 22,
        "name": "WordPress Blog",
        "created_at": "2023-04-25T14:16:59.000000Z",
        "last_used": "2023-07-06T21:02:49.000000Z",
        "status": "success"
      }
    },
    "status": "running",
    "created_at": "2023-07-21T15:36:39.000000Z",
    "started_at": null,
    "completed_at": null,
    "files": [
      {
        "id": "045c31f2-234c-4c12-ae69-b6188b37412d",
        "name": "snapshooter\/5d32e6da-docker-mysql-ssh\/2023\/07\/06\/21-01\/test.sql.gz",
        "size": "744 bytes",
        "url": "..."
      }
    ]
  }
}

Related

Backup Solutions (Recipes)
Backups
Jobs
Servers
Was this page helpful?

Thank you for helping us improve!