vps.list
This method is flexible in its use. With it you can piece together criteria
and receive a list of servers that match that criteria.
Examples
Listing all VPSs
The default behavior is to return an array of active VPS objects.
You can specify to include cancelled VPSs by setting cancelled
to true
.
Listing by creation date
Like other daterange parameters, created_on
can also expect an array with
the start date followed by end date.
Parameters
Name | Type | Default |
---|---|---|
created_on |
date|daterange
|
null |
renews_on |
date|daterange
|
null |
cancelled_on |
date|daterange
|
null |
cancelled |
bool
|
null |
sort_by |
enum
|
"id" |
Values: id, created_on, renews_on, cancelled_on | ||
order |
enum
|
"default" |
Values: default, asc, desc |
Errors
Code | Name |
---|