CommunityWebsiteDocumentationExchangeSupportDeveloper
HomeGuidesAPI Reference
CommunityWebsiteDocumentationExchangeSupportDeveloper
API Reference

Get All Instances

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

This endpoint retrieves a paginated list of instances.

Query Params
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

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 Plan ID for Filtering

int64

The Server ID for Filtering

int64

The Parent Server (Hypervisor) ID for Filtering

string

The Instance Type Code for Filtering

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

boolean

Filter instances by if agent is installed or not on the associated servers.

string

The instance status for filtering.

string

The environment for filtering.

boolean
Defaults to false

If true, includes instances in pending removal status.

boolean

If true, only deleted resources or instances in pending removal status are returned.

string

Filter by expireDate less than or equal to specified date

string

Filter expireDate greater than or equal to the specified date

string

Filter by expireDays less than or equal to the specified value

string

Filter by expireDays greater than or equal to the specified value

string

Filter by shutdownDate less than equal to the specified date

string

Filter by shutdownDate greater than or equal to the specified date

string

Filter by shutdownDays less than or equal to the specified value

string

Filter by shutdownDays greater than or equal to the specified value

string

Filter by label(s), matches records that contain any of the specified labels

string

Filter by label(s), matches records that contain all of the specified labels

string

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

boolean
Defaults to false

Include details=true to return more details about the instance and its container(s) and server(s), ie. instancePrice, apps, powerSchedule, isScalable, instanceThreshold, containerDetails.server.

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