Application Actions

https://api.losant.com/applications/APPLICATION_ID

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

Apply Template

Add resources to an application via an application template

Method And Url

PATCH https://api.losant.com/applications/APPLICATION_ID/applyTemplate

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, application.*, or application.applyTemplate.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID of the associated application	575ec8687ae143cd83dc4a97

Request Headers

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

Request Body

The body of the request should be serialized JSON that validates against the Application Apply Template Patch Schema schema. For example, the following would be a valid body for this request:

{
  "templateId": "575ec8687ae143cd83dc4a97",
  "email": "email@example.com"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"templateId":"575ec8687ae143cd83dc4a97","email":"email@example.com"}' \
    https://api.losant.com/applications/APPLICATION_ID/applyTemplate

Successful Responses

Code	Type	Description
200	Application	Updated application information
202	Job Enqueued API Result	If a job was enqueued for the resources to be imported into the application

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application is not found

Archive Data

Returns success when a job has been enqueued to archive this application's device data for a given day

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/archiveData

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, application.*, or application.archiveData.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID of the associated application	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
date	Y	The date to archive data (ms since epoch), it must be within the archive time range older than 31 days and newer than the organizations dataTTL		date=1518556791829

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/applications/APPLICATION_ID/archiveData?date=1518556791829

Successful Responses

Code	Type	Description
202	Job Enqueued API Result	Enqueued a job to archive this applications device data

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Backfill Archive Data

Returns success when a job has been enqueued to backfill all current data to its archive

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/backfillArchiveData

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, application.*, or application.backfillArchiveData.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID of the associated application	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 GET \
    https://api.losant.com/applications/APPLICATION_ID/backfillArchiveData

Successful Responses

Code	Type	Description
202	Job Enqueued API Result	Enqueued a job to backfill device data to this application archive location

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Clone

Copy an application into a new application

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/clone

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, application.*, or application.clone.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID of the associated application	575ec8687ae143cd83dc4a97

Request Headers

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

Request Body

The body of the request should be serialized JSON that validates against the Application Clone Post Schema schema. For example, the following would be a valid body for this request:

{
  "includeFiles": true,
  "includeDevices": true,
  "ownerType": "organization",
  "ownerId": "575ec8687ae143cd83dc4a98"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    https://api.losant.com/applications/APPLICATION_ID/clone

Successful Responses

Code	Type	Description
200	Success Dry Run	if dryRun is set and successful, then return success
201	Application Creation By Template Result	If application was successfully cloned
202	Job Enqueued API Result	If application was enqueued to be cloned

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application is not found
422	Validation Error	Error if too many validation errors occurred on other resources

Delete

Deletes an application

Method And Url

DELETE https://api.losant.com/applications/APPLICATION_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.Application, all.Organization, all.User, application.*, or application.delete.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID of the associated application	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/applications/APPLICATION_ID

Successful Responses

Code	Type	Description
200	Success	If application was successfully deleted

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Device Counts

Returns device counts by day for the time range specified for this application

Method And Url

GET https://api.losant.com/applications/APPLICATION_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.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.deviceCounts.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID of the associated application	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/applications/APPLICATION_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 application was not found

Export

Export an application and all of its resources

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/export

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, application.*, or application.export.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID of the associated application	575ec8687ae143cd83dc4a97

Request Headers

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

Request Body

The body of the request should be serialized JSON that validates against the Application Export Post Schema schema. For example, the following would be a valid body for this request:

{
  "includeFiles": true,
  "includeDevices": true,
  "email": "test@example.com"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"includeFiles":true,"includeDevices":true,"email":"test@example.com"}' \
    https://api.losant.com/applications/APPLICATION_ID/export

Successful Responses

Code	Type	Description
200	Application Export Result	a url to download the zip of exported resources
202	Job Enqueued API Result	If application was enqueued to be exported

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application is not found

Full Data Tables Archive

Returns success when a job has been enqueued to archive all selected data tables

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/fullDataTablesArchive

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, application.*, or application.fullDataTablesArchive.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID of the associated application	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 GET \
    https://api.losant.com/applications/APPLICATION_ID/fullDataTablesArchive

Successful Responses

Code	Type	Description
202	Job Enqueued API Result	Enqueued a job to archive all selected data tables of this application archive location

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Full Events Archive

Returns success when a job has been enqueued to archive all current events

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/fullEventsArchive

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, application.*, or application.fullEventsArchive.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID of the associated application	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 GET \
    https://api.losant.com/applications/APPLICATION_ID/fullEventsArchive

Successful Responses

Code	Type	Description
202	Job Enqueued API Result	Enqueued a job to archive all events to this application archive location

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Get

Retrieves information on an application

Method And Url

GET https://api.losant.com/applications/APPLICATION_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.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, application.*, or application.get.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID of the associated application	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
summaryExclude	N	Comma-separated list of summary fields to exclude from application summary		summaryExclude=payloadCount
summaryInclude	N	Comma-separated list of summary fields to include in application 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/applications/APPLICATION_ID

Successful Responses

Code	Type	Description
200	Application	Application information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Globals

Updates an application global at the given key

Method And Url

PATCH https://api.losant.com/applications/APPLICATION_ID/globals

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, application.*, or application.patch.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID of the associated application	575ec8687ae143cd83dc4a97

Request Headers

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

Request Body

The body of the request should be serialized JSON that validates against the Application Global Patch schema. For example, the following would be a valid body for this request:

[
  {
    "key": "keyHere",
    "description": "Description of my application global",
    "json": "\"my json data here\"",
    "cloudOnly": true
  },
  {
    "key": "anotherKey",
    "json": "\"more json\"",
    "cloudOnly": false
  }
]

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '[{"key":"keyHere","description":"Description of my application global","json":"\"my json data here\"","cloudOnly":true},{"key":"anotherKey","json":"\"more json\"","cloudOnly":false}]' \
    https://api.losant.com/applications/APPLICATION_ID/globals

Successful Responses

Code	Type	Description
200	Application	Updated application information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Import

Add multiple resources to an application via a zip file

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/import

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, application.*, or application.import.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID of the associated application	575ec8687ae143cd83dc4a97

Request Headers

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

Request Body

The body of the request should be a multipart form data post containing the following:

Name	Required	Description	Default	Example
importBundle	N	The zip file containing all of the resources to import into the application		``
email	N	Email address to notify the user when the job to import the application resources has completed or errored, defaults to the email address of the user making the request		email=email@example.com
options	N	Additional import options. See Application Import Options for more details.		options={"importUrl":"https://storage.example.com/myZipFile.zip","include":["Flow","Device"]}

Curl Example

curl -H 'Content-Type: multipart/form-data' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    https://api.losant.com/applications/APPLICATION_ID/import

Successful Responses

Code	Type	Description
200	Application	Updated application information
202	Job Enqueued API Result	If a job was enqueued for the resources to be imported into the application

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application is not found

Import Logs

Retrieves information on application import logs

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/importLogs

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.importLogs.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID of the associated application	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
limit	N	Max log entries to return (ordered by time descending)	1	limit=10
since	N	Look for log entries since this time (ms since epoch)		since=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/applications/APPLICATION_ID/importLogs

Successful Responses

Code	Type	Description
200	Application Import Executions	Application log objects

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Mqtt Publish Message

Publishes the given message to the given MQTT topic

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/mqttPublishMessage

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, application.*, or application.mqttPublishMessage.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID of the associated application	575ec8687ae143cd83dc4a97

Request Headers

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

Request Body

The body of the request should be serialized JSON that validates against the MQTT Publish Body schema. For example, the following would be a valid body for this request:

{
  "topic": "an/mqtt/topic",
  "message": "The MQTT message!"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"topic":"an/mqtt/topic","message":"The MQTT message!"}' \
    https://api.losant.com/applications/APPLICATION_ID/mqttPublishMessage

Successful Responses

Code	Type	Description
200	Success	Message successfully published

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Mqtt Subscription Stream

Attach to a real time stream of state messages for the given MQTT topic using Server Sent Events (SSE)

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/mqttSubscriptionStream

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.mqttSubscriptionStream.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID of the associated application	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
keepAliveInterval	N	Number of seconds between keepalive messages	2	keepAliveInterval=2
topic	Y	The MQTT topic to subscribe to		topic=my/topic

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/applications/APPLICATION_ID/mqttSubscriptionStream?topic=my%2Ftopic

SSE Stream for a Successful Response

SSE stream of mqtt messages for the requested topic

SSE Event Name	Type	Description
mqttMessage	MQTT Publish Body	An SSE event representing a single mqtt payload

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Notebook Minute Counts

Returns notebook execution usage by day for the time range specified for this application

Method And Url

GET https://api.losant.com/applications/APPLICATION_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.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.notebookMinuteCounts.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID of the associated application	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/applications/APPLICATION_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 application was not found

Patch

Updates information about an application

Method And Url

PATCH https://api.losant.com/applications/APPLICATION_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.Application, all.Application.cli, all.Organization, all.User, all.User.cli, application.*, or application.patch.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID of the associated application	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
summaryExclude	N	Comma-separated list of summary fields to exclude from application summary		summaryExclude=payloadCount
summaryInclude	N	Comma-separated list of summary fields to include in application summary		summaryInclude=payloadCount

Request Headers

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

Request Body

The body of the request should be serialized JSON that validates against the Application Patch schema. For example, the following would be a valid body for this request:

{
  "name": "My Updated Application",
  "description": "Description of my updated application"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"name":"My Updated Application","description":"Description of my updated application"}' \
    https://api.losant.com/applications/APPLICATION_ID

Successful Responses

Code	Type	Description
200	Application	Updated application information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Payload Counts

Returns payload counts for the time range specified for this application

Method And Url

GET https://api.losant.com/applications/APPLICATION_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.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.payloadCounts.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID of the associated application	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
start	N	Start of range for payload count query (ms since epoch)	-2592000000	start=0
end	N	End of range for payload count query (ms since epoch)	0	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/applications/APPLICATION_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 application was not found

Payload Counts Breakdown

Returns payload counts per resolution in the time range specified for this application

Method And Url

GET https://api.losant.com/applications/APPLICATION_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.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.payloadCountsBreakdown.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID of the associated application	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/applications/APPLICATION_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 application was not found

Readme

Get the current application readme information

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/readme

Authentication

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

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID of the associated application	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 GET \
    https://api.losant.com/applications/APPLICATION_ID/readme

Successful Responses

Code	Type	Description
200	Application Readme	The application readme information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Readme Patch

Update the current application readme information

Method And Url

PATCH https://api.losant.com/applications/APPLICATION_ID/readme

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, application.*, or application.patch.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID of the associated application	575ec8687ae143cd83dc4a97

Request Headers

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

Request Body

The body of the request should be serialized JSON that validates against the Application Readme Patch schema. For example, the following would be a valid body for this request:

{
  "content": "The new readme content"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"content":"The new readme content"}' \
    https://api.losant.com/applications/APPLICATION_ID/readme

Successful Responses

Code	Type	Description
200	Application Readme	Updated readme information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application was not found

Search

Search across an application's resources by target identifier

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/search

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.search.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID of the associated application	575ec8687ae143cd83dc4a97

Request Query Parameters

Name	Required	Description	Default	Example
filter	Y	The partial resource name being searched for		filter=my dev

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/applications/APPLICATION_ID/search?filter=my%20dev

Successful Responses

Code	Type	Description
200	Application Search Result	An array of resource ids, names, descriptions, and types matching the search query

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application is not found

Schemas

Application

Schema for a single Application

Application Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 19 keys
▶
id:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
appliedTemplateIds:{} 3 keys
▶
ownerId:{} 2 keys
▶
ownerType:{} 2 keys
▶
organizationName:{} 3 keys
▶
organizationIconColor:{} 2 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
endpointSlug:{} 4 keys
▶
expUserTokenCutoff:{} 2 keys
▶
endpointDefaultCors:{} 1 key
▶
globals:{} 3 keys
▶
blobUrlTTL:{} 3 keys
▶
summary:{} 2 keys
▶
ftueTracking:{} 3 keys
▶
archiveConfig:{} 3 keys

Application Example

▶
root:{} 10 keys
id:"575ec8687ae143cd83dc4a97"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
ownerId:"575ed70c7ae143cd83dc4aa9"
ownerType:"user"
name:"My Application"
description:"The is the best application description"
▶
summary:{} 6 keys
▶
archiveConfig:{} 3 keys

Application Apply Template Patch Schema

Schema for the body of an application template import request

Application Apply Template Patch Schema Schema

▶
root:{} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
templateId:{} 2 keys
▶
email:{} 3 keys
▶
callbackUrl:{} 3 keys
▶
required:[] 1 item
additionalProperties:false

Application Apply Template Patch Schema Example

▶
root:{} 2 keys
templateId:"575ec8687ae143cd83dc4a97"
email:"email@example.com"

Success Dry Run

Schema for reporting a successful dry run of clone application

Success Dry Run Schema

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

Success Dry Run Example

▶
root:{} 2 keys
success:true
jobRequired:false

Application Clone Post Schema

Schema for the body of an application clone request

Application Clone Post Schema Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 9 keys
▶
dryRun:{} 2 keys
▶
includeFiles:{} 2 keys
▶
includeDataTableRows:{} 2 keys
▶
includeDevices:{} 2 keys
▶
ownerId:{} 1 key
▶
ownerType:{} 2 keys
▶
email:{} 3 keys
▶
callbackUrl:{} 3 keys
▶
forceJob:{} 2 keys
additionalProperties:false

Application Clone Post Schema Example

▶
root:{} 4 keys
includeFiles:true
includeDevices:true
ownerType:"organization"
ownerId:"575ec8687ae143cd83dc4a98"

Application Creation By Template Result

Schema for creating an application by template result

Application Creation By Template Result Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys
▶
application:{} 4 keys
▶
validationErrors:{} 2 keys
additionalProperties:false

Application Creation By Template Result Example

▶
root:{} 1 key
▶
application:{} 10 keys

Application Export Post Schema

Schema for the body of an application export request

Application Export Post Schema Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 9 keys
▶
includeFiles:{} 2 keys
▶
includeDataTableRows:{} 2 keys
▶
includeDevices:{} 2 keys
▶
email:{} 3 keys
▶
callbackUrl:{} 3 keys
▶
forceJob:{} 2 keys
▶
exportType:{} 3 keys
▶
credentialName:{} 2 keys
▶
repo:{} 2 keys
additionalProperties:false

Application Export Post Schema Example

▶
root:{} 3 keys
includeFiles:true
includeDevices:true
email:"test@example.com"

Application Export Result

Schema for an application export result

Application Export Result Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 1 key
▶
url:{} 1 key
additionalProperties:false

Application Export Result Example

▶
root:{} 1 key
url:"https://example.com/applicationExport.zip"

Application Global Patch

Schema for the body of an Application Global modification request

Application Global Patch Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"array"
maxItems:100
▶
items:{} 4 keys

Application Global Patch Example

▶
root:[] 2 items
▶
0:{} 4 keys
▶
1:{} 3 keys

Application Import Executions

Schema for a list Application import executions

Application Import Executions Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"array"
▶
items:{} 2 keys

Application Import Executions Example

▶
root:[] 1 item
▶
0:{} 14 keys

Application Patch

Schema for the body of an Application modification request

Application Patch Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 9 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
endpointSlug:{} 4 keys
▶
expUserTokenCutoff:{} 2 keys
▶
endpointDefaultCors:{} 1 key
▶
globals:{} 3 keys
▶
ftueTracking:{} 3 keys
▶
archiveConfig:{} 3 keys
▶
blobUrlTTL:{} 3 keys
additionalProperties:false

Application Patch Example

▶
root:{} 2 keys
name:"My Updated Application"
description:"Description of my updated application"

Application Readme

Schema for an Application Readme

Application Readme Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 5 keys
▶
applicationId:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
lastUpdatedById:{} 2 keys
▶
lastUpdatedByType:{} 2 keys
▶
content:{} 1 key

Application Readme Example

▶
root:{} 6 keys
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
lastUpdatedById:"575ed70c7ae143cd83dc4aa9"
lastUpdatedByType:"user"
content:"The readme content"

Application Readme Patch

Schema for the body of an Application Readme modification request

Application Readme Patch Schema

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

Application Readme Patch Example

▶
root:{} 1 key
content:"The new readme content"

Application Search Result

Results of a search of an application's resources

Application Search Result Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"array"
▶
items:{} 3 keys

Application Search Result Example

▶
root:[] 1 item
▶
0:{} 4 keys

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"

Application Import Options

Schema for additional application import options

Application Import Options Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 9 keys
▶
fromApplicationId:{} 2 keys
▶
importUrl:{} 3 keys
▶
callbackUrl:{} 3 keys
▶
conflictBehavior:{} 3 keys
▶
dryRun:{} 2 keys
▶
forceJob:{} 2 keys
▶
include:{} 3 keys
▶
credentialName:{} 2 keys
▶
repo:{} 2 keys
additionalProperties:false

Application Import Options Example

▶
root:{} 2 keys
importUrl:"https://storage.example.com/myZipFile.zip"
▶
include:[] 2 items

Job Enqueued API Result

Schema for the result of a job being queued

Job Enqueued API Result Schema

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

Job Enqueued API Result Example

▶
root:{} 3 keys
jobQueued:true
jobId:"clnHvJbyVkOWAZwYAwLP4"
success:true

MQTT Publish Body

Schema for the body an MQTT Publish Message request

MQTT Publish Body Schema

▶
root:{} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys
▶
topic:{} 3 keys
▶
message:{} 2 keys
▶
required:[] 2 items
additionalProperties:false

MQTT Publish Body Example

▶
root:{} 2 keys
topic:"an/mqtt/topic"
message:"The MQTT message!"

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

Validation Error

Schema for validation errors returned by the API

Validation 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

Validation Error Example

▶
root:{} 3 keys
type:"Validation"
message:"Too many validation errors occurred."
▶
validationErrors:[] 1 item