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
INSTANCESANDBOXID 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
INSTANCESANDBOXID 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
INSTANCESANDBOXID 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
INSTANCESANDBOXID 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
INSTANCESANDBOXID 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
INSTANCESANDBOXID 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
INSTANCESANDBOXID 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

Was this page helpful?

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