Docs
Sign in

List server images

Returns the images VPSBG publishes, each with its group and the id to pass when ordering or reinstalling a server. Images announced as coming soon are omitted.

GET
/server-images

Authorization

BearerToken
AuthorizationBearer <token>

In: header

Query Parameters

per_page?|
Range1 <= value <= 50
page?integer|null
filter[type]?string

Exact match on the group type; os is the only published type.

filter[group]?string

Partial match on the group name.

filter[virtualization]?string

Exact match on the virtualization type (kvm or vzo). Defaults to kvm.

filter[adapter]?string

Restricts to images published for host platform 1 or 2, defaulting to 2. Any other value is ignored and the filter is skipped.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/server-images?filter%5Btype%5D=os&filter%5Bgroup%5D=Ubuntu&filter%5Bvirtualization%5D=kvm&filter%5Badapter%5D=2"
{  "data": [    {      "id": 0,      "name": "string",      "minimum_ram": 0,      "eol": true,      "ssh_keys_support": true,      "amd_sev_supported": true,      "group": {        "name": "string",        "type": "string",        "key": "string",        "icon": "string",        "order": 0,        "coming_soon": true,        "content": "string"      },      "order": 0    }  ],  "links": {    "first": "string",    "last": "string",    "prev": "string",    "next": "string"  },  "meta": {    "current_page": 1,    "from": 1,    "last_page": 1,    "links": [      {        "url": "string",        "label": "string",        "active": true      }    ],    "path": "string",    "per_page": 0,    "to": 1,    "total": 0  }}