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.

Try it Out
{
    "cancelled": true
}
[

]

Listing by creation date

Try it Out
{
    "created_on": "2013-03-11"
}
[

]

Like other daterange parameters, created_on can also expect an array with
the start date followed by end date.

Try it Out
{
    "created_on": [
        "2012-03-11",
        "2012-03-17"
    ]
}
[

]

Parameters

Name Type Default
created_on date|daterange null

Day the VPS was created

renews_on date|daterange null

Day of renewal

cancelled_on date|daterange null

Day the VPS was cancelled

cancelled bool null

Restrict search to only cancelled VPSs

sort_by enum "id"

Column to sort VPSs by

Values: id, created_on, renews_on, cancelled_on
order enum "default"

Order in ascending or descending order. Default is different depending on the sort_by attribute.

Values: default, asc, desc

Errors

Code Name