instances.md

Instances Actions

Details on the various actions that can be performed on the Instances resource, including the expected parameters and the potential responses.

Contents

• Get

Get

Returns a collection of instances

var params = {}; // all params are optional

// with callbacks
client.instances.get(params, function (err, result) {
  if (err) { return console.error(err); }
  console.log(result);
});

// with promises
client.instances.get(params)
  .then(console.log)
  .catch(console.error);

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.User, all.User.read, instances.*, or instances.get.

Available Parameters

Name	Type	Required	Description	Default	Example
sortField	string	N	Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated	name	name
sortDirection	string	N	Direction to sort the results by. Accepted values are: asc, desc	asc	asc
page	string	N	Which page of results to return	0	0
perPage	string	N	How many items to return per page	100	10
filterField	string	N	Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name		name
filter	string	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		my * instance
losantdomain	string	N	Domain scope of request (rarely needed)		example.com

Successful Responses

Code	Type	Description
200	Instances	Collection of instances

Error Responses

Code	Type	Description
400	Error	Error if malformed request