Instance Sandboxes Actions

https://api.losant.com/instances/INSTANCE_ID/sandboxes

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

Get

Returns a collection of instance sandboxes

Method And Url

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

Authentication

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

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
summaryExclude	N	Comma-separated list of summary fields to exclude from user summary		summaryExclude=payloadCount
summaryInclude	N	Comma-separated list of summary fields to include in user summary		summaryInclude=payloadCount
sortField	N	Field to sort the results by. Accepted values are: firstName, lastName, email, id, creationDate, lastSuccessfulLogin, lastFailedLogin, failedLoginCount, lastUpdated	email	sortField=firstName
sortDirection	N	Direction to sort the results by. Accepted values are: asc, desc	asc	sortDirection=asc
startingAfterId	N	Exclusive ID from which to begin querying		startingAfterId=575ec8687ae143cd83dc4a97
endingBeforeId	N	Exclusive ID at which to end querying		endingBeforeId=575ec8687ae143cd83dc4a97
limit	N	How many items to return	100	limit=10
filterField	N	Field to filter the results by. Blank or not provided means no filtering. Accepted values are: firstName, lastName, email		filterField=firstName
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		filter=my * instance
includeDeleted	N	If the result of the request should also include deleted sandboxes.		includeDeleted=true

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/INSTANCE_ID/sandboxes

Successful Responses

Code	Type	Description
200	Instance Sandboxes	Collection of instance sandboxes

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"

Instance Sandboxes

Schema for a collection of instance associated sandboxes

Instance Sandboxes Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 11 keys
▶
instanceId:{} 2 keys
▶
items:{} 2 keys
▶
count:{} 1 key
▶
limit:{} 1 key
▶
startingAfterId:{} 2 keys
▶
endingBeforeId:{} 2 keys
▶
filter:{} 1 key
▶
filterField:{} 1 key
▶
sortField:{} 1 key
▶
sortDirection:{} 2 keys
▶
hasMore:{} 1 key

Instance Sandboxes Example

▶
(root){} 7 keys
count:2
▶
items:[] 2 items
limit:100
startingAfterId:"575ed70c7ae143cd83dc4aa9"
sortField:"firstName"
sortDirection:"asc"
hasMore:false