ServerPaginatedListResponse

Successful response with a page of Server

errorintegerrequired

Always 0 in a successful response

Constant value: 0

messagestring | nullnullablerequired

Always null in a successful response

data object[]required

Items of the page: an empty list beyond the last page

Array [

server_idintegerrequired

purchase_idinteger | nullnullablerequired

Id of the purchase of the server (GET /api/v3/purchases/{purchase_id})

hostnamestring | nullnullablerequired

server_typestring | nullnullablerequired

Type of the server: PH for a dedicated (physical) server, VM for a virtual machine, HV for a hypervisor or a private cloud

activebooleanrequired

Whether the server is active: false once it has been deleted

consolidatedbooleanrequired

Whether the server is ready, with its provisioning complete

ip_address_idinteger | nullnullablerequired

Id of the primary IP address of the server (GET /api/v3/servers/{server_id}/ip-addresses/{ip_address_id})

ip_addressstring | nullnullablerequired

Primary IP address of the server

service_category_codestring | nullnullablerequired

Code of the service category of the server: DEDICATED (dedicated server), CLOUD (Cloud Server), CLOUD_SERVER_IOPS (Cloud VPS), CLOUD_SERVER_HA (Cloud Server HA), PRIVATE_CLOUD (private cloud) or PRIVATE_CLOUD_VM (virtual machine of a private cloud)

date_createddate-timenullablerequired

]

meta objectrequired

Pagination of the list

totalintegerrequired

Number of items in the whole list

countintegerrequired

Number of items in this page: 0 beyond the last page

pagesintegerrequired

Number of pages of the list

pageintegerrequired

Number of this page, starting from 1

per_pageintegerrequired

Maximum number of items in a page

ServerPaginatedListResponse

{
  "error": 0,
  "message": "string",
  "data": [
    {
      "server_id": 0,
      "purchase_id": 0,
      "hostname": "string",
      "server_type": "string",
      "active": true,
      "consolidated": true,
      "ip_address_id": 0,
      "ip_address": "string",
      "service_category_code": "string",
      "date_created": "2024-07-29T15:51:28.071Z"
    }
  ],
  "meta": {
    "total": 0,
    "count": 0,
    "pages": 0,
    "page": 0,
    "per_page": 0
  }
}