List snapshots

GET/snapshots

List all server snapshots available.

Request

Authorization: Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

Query Params

page

integer

optional

Which page of paginated results to return.

filter[date]

string

optional

Filter by snapshot's creation date. Format: YYYY-MM-DD

filter[server_id]

integer

optional

Filter snapshots by server's ID.

sort

string

optional

Sorting parameter. Possible values: date (ascending), -date (descending)

Request samples

Responses

List of all snapshots.(200)

List of all snapshots.

HTTP Code: 200

Content Type : JSONapplication/json

data

array[object (Snapshot) {5}]

optional

integer

optional

server_id

integer

optional

The server from which this snapshot was taken from.

name

string

optional

Friendly label.

created_at

string

optional

When the snapshot was taken (ISO8601).

size

integer

optional

The size of the server when the snapshot was taken. If the snapshot has to be restored, it can be restored to a machine with more or equal disk size.

links

object

optional

first

string

optional

last

string

optional

null

optional

null

optional

meta

object

optional

current_page

integer

optional

from

integer

optional

last_page

integer

optional

links

array [object {3}]

optional

path

string

optional

per_page

integer

optional

integer

optional

total

integer

optional

{
  "data": [
    {
      "id": 116,
      "server_id": 2478,
      "name": "example_snapshot",
      "created_at": "2023-06-19T22:34:43+03:00",
      "size": 50
    }
  ],
  "links": {
    "first": "https://api.vpsbg.eu/v1/snapshots?page=1",
    "last": "https://api.vpsbg.eu/v1/snapshots?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "pagination.previous",
        "active": false
      },
      {
        "url": "https://api.vpsbg.eu/v1/snapshots?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "pagination.next",
        "active": false
      }
    ],
    "path": "https://api.vpsbg.eu/v1/snapshots",
    "per_page": 50,
    "to": 1,
    "total": 1
  }
}

Last modified: 3 months ago