Instance Sandbox Actions

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

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

Delete

Deletes a sandbox user account

Method And Url

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

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.User, instanceSandbox.*, or instanceSandbox.delete.

Request Path Components

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

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 DELETE \
    https://api.losant.com/instances/INSTANCE_ID/sandboxes/INSTANCE_SANDBOX_ID

Successful Responses

Code	Type	Description
200	Success	If a sandbox was successfully deleted

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if sandbox or instance was not found

Device Counts

Returns device counts by day for the time range specified for all applications the sandbox user owns

Method And Url

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

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.read, all.User, all.User.read, instanceSandbox.*, or instanceSandbox.deviceCounts.

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
start	N	Start of range for device count query (ms since epoch)		start=0
end	N	End of range for device count query (ms since epoch)		end=1465790400000

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/INSTANCE_SANDBOX_ID/deviceCounts

Successful Responses

Code	Type	Description
200	Device Counts	Device counts by day

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if sandbox or instance was not found

Get

Returns a sandbox user

Method And Url

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

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.read, all.User, all.User.read, instanceSandbox.*, or instanceSandbox.get.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec8687ae143cd83dc4a97
INSTANCE_SANDBOX_ID	ID associated with the sandbox user	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

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/INSTANCE_SANDBOX_ID

Successful Responses

Code	Type	Description
200	Instance Sandbox User	A single sandbox user

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if sandbox or instance was not found

Notebook Minute Counts

Returns notebook execution usage by day for the time range specified for all applications the sandbox user owns

Method And Url

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

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.read, all.User, all.User.read, instanceSandbox.*, or instanceSandbox.notebookMinuteCounts.

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
start	N	Start of range for notebook execution query (ms since epoch)		start=0
end	N	End of range for notebook execution query (ms since epoch)		end=1465790400000

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/INSTANCE_SANDBOX_ID/notebookMinuteCounts

Successful Responses

Code	Type	Description
200	Notebook Minute Counts	Notebook usage information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if sandbox or instance was not found

Payload Counts

Returns payload counts for the time range specified for all applications the sandbox user owns

Method And Url

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

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.read, all.User, all.User.read, instanceSandbox.*, or instanceSandbox.payloadCounts.

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
start	N	Start of range for payload count query (ms since epoch)		start=0
end	N	End of range for payload count query (ms since epoch)		end=1465790400000
asBytes	N	If the resulting stats should be returned as bytes	false	asBytes=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/INSTANCE_SANDBOX_ID/payloadCounts

Successful Responses

Code	Type	Description
200	Payload Stats	Payload counts, by type and source

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if sandbox or instance was not found

Payload Counts Breakdown

Returns payload counts per resolution in the time range specified for all applications the sandbox user owns

Method And Url

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

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.read, all.User, all.User.read, instanceSandbox.*, or instanceSandbox.payloadCountsBreakdown.

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
start	N	Start of range for payload count query (ms since epoch)		start=0
end	N	End of range for payload count query (ms since epoch)		end=1465790400000
resolution	N	Resolution in milliseconds. Accepted values are: 86400000, 3600000	86400000	resolution=86400000
asBytes	N	If the resulting stats should be returned as bytes	false	asBytes=true
includeNonBillable	N	If non-billable payloads should be included in the result	false	includeNonBillable=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/INSTANCE_SANDBOX_ID/payloadCountsBreakdown

Successful Responses

Code	Type	Description
200	Payload Counts Breakdown	Sum of payload counts by date

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if sandbox or instance was not found

Undelete

Restores a sandbox user account

Method And Url

PATCH https://api.losant.com/instances/INSTANCE_ID/sandboxes/INSTANCE_SANDBOX_ID/undelete

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.User, instanceSandbox.*, or instanceSandbox.undelete.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec8687ae143cd83dc4a97
INSTANCE_SANDBOX_ID	ID associated with the sandbox user	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

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 PATCH \
    https://api.losant.com/instances/INSTANCE_ID/sandboxes/INSTANCE_SANDBOX_ID/undelete

Successful Responses

Code	Type	Description
200	Instance Sandbox User	A single restored sandbox user

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if sandbox or instance was not found

Schemas

Device Counts

Schema for the result of a device counts request

Device Counts Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
start:{} 2 keys
▶
end:{} 2 keys
▶
counts:{} 2 keys

Device Counts Example

▶
root:{} 3 keys
start:"1999-05-20T05:00:00.000Z"
end:"1999-06-20T04:59:59.999Z"
▶
counts:[] 1 item

Error

Schema for errors returned by the API

Error Schema

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

Error Example

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

Instance Sandbox User

Schema for information about a sandbox user within an instance domain

Instance Sandbox User Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 32 keys
▶
id:{} 2 keys
▶
instanceSandboxId:{} 2 keys
▶
instanceId:{} 2 keys
▶
creationDate:{} 2 keys
▶
permanentDeletion:{} 2 keys
▶
dataDeletion:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
lastSuccessfulLogin:{} 2 keys
▶
lastFailedLogin:{} 2 keys
▶
failedLoginCount:{} 1 key
▶
passwordLastUpdated:{} 2 keys
▶
email:{} 3 keys
▶
firstName:{} 3 keys
▶
lastName:{} 2 keys
▶
companyName:{} 2 keys
▶
title:{} 2 keys
▶
phoneNumber:{} 2 keys
▶
location:{} 2 keys
▶
url:{} 2 keys
▶
tokenCutoff:{} 2 keys
▶
emailVerified:{} 1 key
▶
needsToVerifyEmail:{} 1 key
▶
twoFactorAuthEnabled:{} 1 key
▶
fullName:{} 1 key
▶
githubName:{} 1 key
▶
avatarUrl:{} 3 keys
▶
limits:{} 3 keys
▶
summary:{} 2 keys
▶
currentPeriodStart:{} 2 keys
▶
currentPeriodEnd:{} 2 keys
▶
ssoLinked:{} 1 key
▶
orgs:{} 2 keys

Instance Sandbox User Example

▶
root:{} 18 keys
id:"575ed70c7ae143cd83dc4aa9"
instanceId:"575ed70c7ae143cd83dc4aa9"
instanceSandboxId:"575ed70c7ae143cd83dc4aa9"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
passwordLastUpdated:"2016-06-13T04:00:00.000Z"
email:"email@example.com"
firstName:"Example"
lastName:"Name"
companyName:"Example, Inc."
url:"https://example.com"
emailVerified:true
needsToVerifyEmail:false
twoFactorAuthEnabled:false
fullName:"Example Name"
▶
summary:{} 8 keys
▶
orgs:[] 1 item
ssoLinked:false

Notebook Minute Counts

Schema for the result of a notebook minute counts request

Notebook Minute Counts Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
start:{} 2 keys
▶
end:{} 2 keys
▶
counts:{} 2 keys

Notebook Minute Counts Example

▶
root:{} 3 keys
start:"1999-05-20T05:00:00.000Z"
end:"1999-06-20T04:59:59.999Z"
▶
counts:[] 1 item

Payload Counts Breakdown

Schema for the result of a payload counts breakdown request

Payload Counts Breakdown Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
start:{} 2 keys
▶
end:{} 2 keys
▶
counts:{} 2 keys

Payload Counts Breakdown Example

▶
root:{} 3 keys
start:"1999-05-20T05:00:00.000Z"
end:"1999-06-20T04:59:59.999Z"
▶
counts:[] 1 item

Payload Stats

Schema for the result of a payload stats request

Payload Stats Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 19 keys
▶
appFile:{} 2 keys
▶
dataTable:{} 2 keys
▶
deviceCreate:{} 2 keys
▶
deviceCommand:{} 2 keys
▶
deviceConnect:{} 2 keys
▶
deviceDisconnect:{} 2 keys
▶
deviceState:{} 2 keys
▶
endpoint:{} 2 keys
▶
event:{} 2 keys
▶
flowError:{} 2 keys
▶
inboundEmail:{} 2 keys
▶
integration:{} 2 keys
▶
mqttIn:{} 2 keys
▶
mqttOut:{} 2 keys
▶
notebook:{} 2 keys
▶
resourceJob:{} 2 keys
▶
timer:{} 2 keys
▶
virtualButton:{} 2 keys
▶
webhook:{} 2 keys

Payload Stats Example

▶
root:{} 6 keys
▶
timer:{} 1 key
▶
deviceState:{} 2 keys
▶
mqttOut:{} 1 key
▶
webhook:{} 1 key
▶
deviceConnect:{} 1 key
▶
deviceDisconnect:{} 1 key

Success

Schema for reporting a successful operation

Success Schema

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

Success Example

▶
root:{} 1 key
success:true