Instances Actions

https://api.losant.com/instances

Below are the various requests that can be performed against the Instances resource, as well as the expected parameters and the potential responses.

Get

Returns a collection of instances

Method And Url

GET https://api.losant.com/instances

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.User, all.User.bounded, all.User.read, instances.*, instances.get, only.User, only.User.bounded, or only.User.read.

Request Query Parameters

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

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/instances

Successful Responses

Code	Type	Description
200	Instances	Collection of instances

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Schemas

Error

Schema for errors returned by the API

Error Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
type:{} 1 key
▶
message:{} 1 key
▶
validationErrors:{} 2 keys

Error Example

▶
(root){} 2 keys
type:"NotFound"
message:"Application was not found"

Instances

Schema for a collection of Instances

Instances Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 9 keys
▶
items:{} 2 keys
▶
count:{} 1 key
▶
totalCount:{} 1 key
▶
perPage:{} 1 key
▶
page:{} 1 key
▶
filter:{} 1 key
▶
filterField:{} 1 key
▶
sortField:{} 1 key
▶
sortDirection:{} 2 keys

Instances Example

▶
(root){} 7 keys
count:2
▶
items:[] 1 item
perPage:100
page:0
sortField:"name"
sortDirection:"asc"
totalCount:2