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-05-29T11:00:19+00:00",
                "updated_at": "2018-05-29T11:00:19+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/074845e8-099f-411d-91ca-fd9a72dbad92",
                "snapshot_server_request": "https://api.engineyard.com/requests/fa2a7633-5d01-4668-8b68-5414d0bbbd0d"
              },
              {
                "id": 13,
                "created_at": "2018-05-29T11:00:19+00:00",
                "updated_at": "2018-05-29T11:00:19+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/074845e8-099f-411d-91ca-fd9a72dbad92",
                "snapshot_server_request": "https://api.engineyard.com/requests/fa2a7633-5d01-4668-8b68-5414d0bbbd0d"
              }
            ]
          }
            
          








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-05-29T11:00:06+00:00",
                "updated_at": "2018-05-29T11:00:06+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/a1a72da3-068f-4a0c-bddd-8958a5aa4ad1",
                "snapshot_server_request": "https://api.engineyard.com/requests/d47ca5fd-ccda-408a-82e9-20c40b03e6a6"
              },
              {
                "id": 9,
                "created_at": "2018-05-29T11:00:06+00:00",
                "updated_at": "2018-05-29T11:00:06+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/a1a72da3-068f-4a0c-bddd-8958a5aa4ad1",
                "snapshot_server_request": "https://api.engineyard.com/requests/d47ca5fd-ccda-408a-82e9-20c40b03e6a6"
              }
            ]
          }
            
          








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-05-29T10:59:53+00:00",
                "updated_at": "2018-05-29T10:59:53+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/bd66f799-d8c3-4c7a-ae18-af6e74c7e11f",
                "snapshot_server_request": "https://api.engineyard.com/requests/bee649cd-6187-4238-b74e-4abbcece0e1a"
              },
              {
                "id": 7,
                "created_at": "2018-05-29T10:59:53+00:00",
                "updated_at": "2018-05-29T10:59:53+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/bd66f799-d8c3-4c7a-ae18-af6e74c7e11f",
                "snapshot_server_request": "https://api.engineyard.com/requests/bee649cd-6187-4238-b74e-4abbcece0e1a"
              }
            ]
          }
            
          








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-05-29T10:59:41+00:00",
              "updated_at": "2018-05-29T10:59:41+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/1f0d608c-4cc3-4d0e-a9b4-9f1c514b7bd7",
              "snapshot_server_request": "https://api.engineyard.com/requests/0ef529d6-e5c5-40e5-8fda-20a6f6dae4c7"
            }
          }
            
          








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": "65548505-781f-47d7-a45c-fb2870f3c4eb",
              "created_at": "2018-05-29T10:59:29+00:00",
              "started_at": "2018-05-29T10:59:29+00:00",
              "finished_at": "2018-05-29T10:59:29+00:00",
              "message": null,
              "request_status": "Finished: Snapshot server (65548505-781f-47d7-a45c-fb2870f3c4eb) (less than a minute ago)",
              "successful": true,
              "updated_at": "2018-05-29T10:59:29+00:00",
              "read_channel": null,
              "stage": "snapshots.perform",
              "dependencies": "https://api.engineyard.com/requests/65548505-781f-47d7-a45c-fb2870f3c4eb/dependencies",
              "stages": "https://api.engineyard.com/requests/65548505-781f-47d7-a45c-fb2870f3c4eb/stages",
              "account": "https://api.engineyard.com/accounts/e401d2a7-04f8-402e-bb61-8024ec66e7b7",
              "requester": "https://api.engineyard.com/requests/65548505-781f-47d7-a45c-fb2870f3c4eb/requester",
              "messages": "https://api.engineyard.com/requests/65548505-781f-47d7-a45c-fb2870f3c4eb/messages",
              "callback_url": "https://api.engineyard.com/requests/65548505-781f-47d7-a45c-fb2870f3c4eb/callback",
              "progress": false,
              "resource": "https://api.engineyard.com/servers/124/snapshots/65548505-781f-47d7-a45c-fb2870f3c4eb"
            }
          }