Instances Actions

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


Returns a collection of instances

Method And Url



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

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 \

Successful Responses

Code Type Description
200 Instances Collection of instances

Error Responses

Code Type Description
400 Error Error if malformed request

Was this page helpful?

Still looking for help? You can also search the Losant Forums or submit your question there.