CommunityWebsiteDocumentationExchangeSupportDeveloper
HomeGuidesAPI Reference
CommunityWebsiteDocumentationExchangeSupportDeveloper
API Reference

Get All Hosts

get
https://{serverURL}/api/servers

This endpoint retrieves a paginated list of hosts.

Query Params
string

Filter by name

string

Search phrase for partial matches on name or description

int64

The Cloud ID (Zone ID) for Filtering

int64

The Group ID (Site ID) for Filtering

int64

The Cluster ID(s) for filtering. Accepts multiple values.

int64

The Parent Server (Hypervisor) ID for Filtering

boolean

Filter by managed (true) or unmanaged (false)

string

Filter by server type code

string

Filter by power status

string

Filter by IP address

boolean

Filter to show only Virtual Machines (true)

boolean

Filter to show only VM Hypervisors (true)

boolean

Filter to show only Baremetal Servers

string

Filter by status

boolean

Filter by agent installed (true)

string
enum

Filter by Guest Agent Status.

Allowed:
int64
Defaults to 25

Maximum number of records to return

int64
Defaults to 0

Offset records, the number of records to skip, for paginating requests

date-time

Date filter, restricts query to only load resources updated more recently than the date specified (ISO 8601)

int64

The User ID for Filtering

string

Filter by tags (metadata). This allows filtering by a tag name and value(s)

string

Alias for tags

string

Filter by UUID, accepts multiple values

string

Filter by External ID

string

Filter by Internal ID

string

Filter by External Unique ID

string

This can be used to exclude the stats object in the response by passing false which can increase performance when returning a large number of servers.

Responses

Updated over 2 years ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 2 years ago