Snapshots API


Get a environment's snapshots

GET /environments/:environment/snapshots

Request

          Accept: application/json
          Content-Type: application/json
          
            
          {
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "snapshots": [
              {
                "id": 12,
                "created_at": "2018-04-12T18:01:58+00:00",
                "updated_at": "2018-04-12T18:01:58+00:00",
                "deleted_at": null,
                "state": "starting",
                "progress": 0,
                "size": 15,
                "region": {
                  "id": "us-east-1",
                  "name": "US East (N. Virginia)"
                },
                "snaplocked": false,
                "mount": null,
                "grade": "unknown",
                "arch": 64,
                "environment": "https://api.engineyard.com/environments/87",
                "server": "https://api.engineyard.com/servers/128",
                "volume": "https://api.engineyard.com/volumes/149",
                "provider": "https://api.engineyard.com/providers/201",
                "account": "https://api.engineyard.com/accounts/3da9506f-f6f5-4a23-b1fd-1ef26dfc03eb",
                "snapshot_server_request": "https://api.engineyard.com/requests/6c3a5d68-c045-458b-be66-f93812976264"
              },
              {
                "id": 13,
                "created_at": "2018-04-12T18:01:58+00:00",
                "updated_at": "2018-04-12T18:01:58+00:00",
                "deleted_at": null,
                "state": "starting",
                "progress": 0,
                "size": 15,
                "region": {
                  "id": "us-east-1",
                  "name": "US East (N. Virginia)"
                },
                "snaplocked": false,
                "mount": null,
                "grade": "unknown",
                "arch": 64,
                "environment": "https://api.engineyard.com/environments/87",
                "server": "https://api.engineyard.com/servers/128",
                "volume": "https://api.engineyard.com/volumes/150",
                "provider": "https://api.engineyard.com/providers/201",
                "account": "https://api.engineyard.com/accounts/3da9506f-f6f5-4a23-b1fd-1ef26dfc03eb",
                "snapshot_server_request": "https://api.engineyard.com/requests/6c3a5d68-c045-458b-be66-f93812976264"
              }
            ]
          }
            
          








Get a server's snapshot request's snapshots

GET /servers/:server/snapshots/:request

Request

          Accept: application/json
          Content-Type: application/json
          
            
          {
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "snapshots": [
              {
                "id": 8,
                "created_at": "2018-04-12T18:01:43+00:00",
                "updated_at": "2018-04-12T18:01:43+00:00",
                "deleted_at": null,
                "state": "starting",
                "progress": 0,
                "size": 15,
                "region": {
                  "id": "us-east-1",
                  "name": "US East (N. Virginia)"
                },
                "snaplocked": false,
                "mount": null,
                "grade": "unknown",
                "arch": 64,
                "environment": "https://api.engineyard.com/environments/86",
                "server": "https://api.engineyard.com/servers/127",
                "volume": "https://api.engineyard.com/volumes/147",
                "provider": "https://api.engineyard.com/providers/199",
                "account": "https://api.engineyard.com/accounts/c38c3476-dcce-47c2-a3e1-2438c65618e5",
                "snapshot_server_request": "https://api.engineyard.com/requests/c3a23738-9cbb-4ddf-bff5-33c0b0e3bc6e"
              },
              {
                "id": 9,
                "created_at": "2018-04-12T18:01:43+00:00",
                "updated_at": "2018-04-12T18:01:43+00:00",
                "deleted_at": null,
                "state": "starting",
                "progress": 0,
                "size": 15,
                "region": {
                  "id": "us-east-1",
                  "name": "US East (N. Virginia)"
                },
                "snaplocked": false,
                "mount": null,
                "grade": "unknown",
                "arch": 64,
                "environment": "https://api.engineyard.com/environments/86",
                "server": "https://api.engineyard.com/servers/127",
                "volume": "https://api.engineyard.com/volumes/148",
                "provider": "https://api.engineyard.com/providers/199",
                "account": "https://api.engineyard.com/accounts/c38c3476-dcce-47c2-a3e1-2438c65618e5",
                "snapshot_server_request": "https://api.engineyard.com/requests/c3a23738-9cbb-4ddf-bff5-33c0b0e3bc6e"
              }
            ]
          }
            
          








Get a server's snapshots

GET /servers/:server/snapshots

Request

          Accept: application/json
          Content-Type: application/json
          
            
          {
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "snapshots": [
              {
                "id": 6,
                "created_at": "2018-04-12T18:01:30+00:00",
                "updated_at": "2018-04-12T18:01:30+00:00",
                "deleted_at": null,
                "state": "starting",
                "progress": 0,
                "size": 15,
                "region": {
                  "id": "us-east-1",
                  "name": "US East (N. Virginia)"
                },
                "snaplocked": false,
                "mount": null,
                "grade": "unknown",
                "arch": 64,
                "environment": "https://api.engineyard.com/environments/85",
                "server": "https://api.engineyard.com/servers/126",
                "volume": "https://api.engineyard.com/volumes/145",
                "provider": "https://api.engineyard.com/providers/197",
                "account": "https://api.engineyard.com/accounts/a9326c2c-6175-48ef-9341-d95e36fd7f14",
                "snapshot_server_request": "https://api.engineyard.com/requests/d3425827-85c5-4326-a1ef-e06fc1b94b96"
              },
              {
                "id": 7,
                "created_at": "2018-04-12T18:01:30+00:00",
                "updated_at": "2018-04-12T18:01:30+00:00",
                "deleted_at": null,
                "state": "starting",
                "progress": 0,
                "size": 15,
                "region": {
                  "id": "us-east-1",
                  "name": "US East (N. Virginia)"
                },
                "snaplocked": false,
                "mount": null,
                "grade": "unknown",
                "arch": 64,
                "environment": "https://api.engineyard.com/environments/85",
                "server": "https://api.engineyard.com/servers/126",
                "volume": "https://api.engineyard.com/volumes/146",
                "provider": "https://api.engineyard.com/providers/197",
                "account": "https://api.engineyard.com/accounts/a9326c2c-6175-48ef-9341-d95e36fd7f14",
                "snapshot_server_request": "https://api.engineyard.com/requests/d3425827-85c5-4326-a1ef-e06fc1b94b96"
              }
            ]
          }
            
          








Get a snapshot

GET /snapshots/:snapshot

Request

          Accept: application/json
          Content-Type: application/json
          
            
          {
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "snapshot": {
              "id": 4,
              "created_at": "2018-04-12T18:01:16+00:00",
              "updated_at": "2018-04-12T18:01:16+00:00",
              "deleted_at": null,
              "state": "starting",
              "progress": 0,
              "size": 15,
              "region": {
                "id": "us-east-1",
                "name": "US East (N. Virginia)"
              },
              "snaplocked": false,
              "mount": null,
              "grade": "unknown",
              "arch": 64,
              "environment": "https://api.engineyard.com/environments/84",
              "server": "https://api.engineyard.com/servers/125",
              "volume": "https://api.engineyard.com/volumes/143",
              "provider": "https://api.engineyard.com/providers/195",
              "account": "https://api.engineyard.com/accounts/c0a30392-a4cf-4f76-a15e-59f18d7224d9",
              "snapshot_server_request": "https://api.engineyard.com/requests/94f1594e-5683-4588-b6de-617a4a1c5798"
            }
          }
            
          








Snapshot a server

POST /servers/:server/snapshot

Request

          Accept: application/json
          Content-Type: application/json
          
            
          {
          }
            
          

Response

          Status: 200 OK
          Content-Type: application/json; charset=utf-8
          
            
          {
            "request": {
              "type": "snapshot_server",
              "id": "30e8830a-149f-4a4e-beee-7eabb13730cb",
              "created_at": "2018-04-12T18:01:03+00:00",
              "started_at": "2018-04-12T18:01:03+00:00",
              "finished_at": "2018-04-12T18:01:03+00:00",
              "message": null,
              "request_status": "Finished: Snapshot server (30e8830a-149f-4a4e-beee-7eabb13730cb) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-04-12T18:01:03+00:00",
              "read_channel": null,
              "stage": "snapshots.perform",
              "dependencies": "https://api.engineyard.com/requests/30e8830a-149f-4a4e-beee-7eabb13730cb/dependencies",
              "stages": "https://api.engineyard.com/requests/30e8830a-149f-4a4e-beee-7eabb13730cb/stages",
              "account": "https://api.engineyard.com/accounts/2c6dd6ac-3ca0-498e-b9c2-f90ce040bf4d",
              "requester": "https://api.engineyard.com/requests/30e8830a-149f-4a4e-beee-7eabb13730cb/requester",
              "messages": "https://api.engineyard.com/requests/30e8830a-149f-4a4e-beee-7eabb13730cb/messages",
              "callback_url": "https://api.engineyard.com/requests/30e8830a-149f-4a4e-beee-7eabb13730cb/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/servers/124/snapshots/30e8830a-149f-4a4e-beee-7eabb13730cb"
            }
          }