Losant

Losant is an Enterprise IoT Platform that lets product teams build connected experiences, manage fleets of devices, orchestrate edge and embedded compute, and visualize and act on IoT data. The platform exposes a comprehensive REST API (the Platform API) covering applications, devices, data tables, time-series data, events, workflows (visual workflow engine), edge and embedded deployments, end-user experiences, notebooks, files, integrations, webhooks, dashboards, organizations, audit logs, and self-hosted enterprise instance administration. Devices may also connect via MQTT. Customers include industrial, smart-building, agriculture, and connected-product companies; Losant emphasizes white-labeled end-user experiences ("Experiences") and edge compute on Linux gateways plus microcontrollers via the Embedded Edge Agent (EEA).

9 APIs 0 Features

IoTInternet Of ThingsDevicesEdge ComputeEmbeddedMQTTIndustrial IoTTelemetryWorkflow AutomationVisual Workflow EngineDashboardsTime SeriesConnected ProductsEnterprise

APIs

Losant Authentication And Account API

Authenticate users, devices, and SSO sessions; manage the currently signed-in user, personal access tokens, organizations, and organization invites. Returns JWTs used as Bearer ...

Losant Application API

Manage Losant Applications - the top-level multi-tenant container for IoT solutions - plus all application-scoped resources: dashboards, events, webhooks, integrations, files, a...

Losant Device API

Provision and manage IoT devices and device recipes, query device tags and attributes, read connection state and logs, and publish state or send commands to devices. Devices may...

Losant Data And Data Tables API

Aggregate, query, and export time-series device data, and read/write rows in Data Tables - Losant's schemaful relational store for context data that lives alongside IoT telemetry.

Losant Workflow Engine API

Create, version, deploy, debug, and execute flows in the Losant Visual Workflow Engine. Supports Application, Experience, Edge, Embedded, and Custom Node workflow types with ful...

Losant Edge And Embedded Compute API

Manage Losant Edge Compute deployments to Linux gateways (Gateway Edge Agent) and Embedded Edge Agent (EEA) deployments to microcontrollers. Distribute workflow versions to flee...

Losant Experience API

Build white-labeled end-user web Experiences on top of a Losant Application: experience users, groups, HTTP endpoints, server-rendered views, slugs, custom domains, versions, an...

Losant Notebooks API

Trigger and manage Losant Notebook executions - Jupyter-style batch workloads that operate on historical device data, data table contents, and other application state for analyt...

Losant Enterprise Instance API

Administer dedicated or self-hosted Losant Enterprise Instances: instance members, organizations within the instance, organization members and invites, instance-level custom wor...

Collections

Losant Application API

OPEN

Losant Authentication and Account API

OPEN

Losant Data and Data Tables API

OPEN

Losant Device API

OPEN

Losant Edge and Embedded Compute API

OPEN

Losant Experience API

OPEN

Losant Enterprise Instance API

OPEN

Losant Notebooks API

OPEN

Losant Workflow Engine API

OPEN

Pricing Plans

Losant Plans Pricing

4 plans

PLANS

Rate Limits

Losant Rate Limits

5 limits

RATE LIMITS

FinOps

Losant Finops

FINOPS

Semantic Vocabularies

Losant Context

20 classes · 7 properties

JSON-LD

API Governance Rules

Losant API Rules

5 rules · 2 errors 3 warnings

SPECTRAL

JSON Structure

Losant Application Structure

19 properties

JSON STRUCTURE

Losant Data Structure

0 properties

JSON STRUCTURE

Losant Device Structure

18 properties

JSON STRUCTURE

Losant Flow Structure

27 properties

JSON STRUCTURE

Example Payloads

Losant Application Api Create Application Example

4 fields

EXAMPLE

Losant Application Api Get Application Example

4 fields

EXAMPLE

Losant Auth Api Authenticate Device Example

4 fields

EXAMPLE

Losant Auth Api Authenticate User Example

4 fields

EXAMPLE

Losant Data Api Last Value Query Example

4 fields

EXAMPLE

Losant Data Api Time Series Query Example

4 fields

EXAMPLE

Losant Device Api Send Command Example

4 fields

EXAMPLE

Losant Device Api Send State Example

4 fields

EXAMPLE

Losant Edge Api Release Edge Deployment Example

4 fields

EXAMPLE

Losant Experience Api Create Experience User Example

4 fields

EXAMPLE

Losant Notebook Api Execute Notebook Example

4 fields

EXAMPLE

Losant Workflow Api Create Flow Example

4 fields

EXAMPLE

Resources

Documentation

GettingStarted

Documentation

Documentation

Documentation

Documentation

SpectralRules

Sources

opencollection: 1.0.0
info:
  name: Losant Workflow Engine API
  version: 1.29.4
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Workflow Engine
    type: folder
  items:
  - info:
      name: Get Information About Errors That Occurred During Runs of This Workflow Version
      type: http
    http:
      method: GET
      url: https://api.losant.com/applications/:applicationId/flows/:flowId/versions/:flowVersionId
      params:
      - name: applicationId
        value: 575ec8687ae143cd83dc4a97
        type: path
        description: ID associated with the application
      - name: flowId
        value: 575ed18f7ae143cd83dc4aa6
        type: path
        description: ID associated with the flow
      - name: flowVersionId
        value: 675ed18f7ae143cd83dc4bb7
        type: path
        description: Version ID or version name associated with the flow version
      - name: duration
        value: '86400000'
        type: query
        description: Duration of time range in milliseconds
      - name: end
        value: '0'
        type: query
        description: End of time range in milliseconds since epoch
      - name: limit
        value: '25'
        type: query
        description: Maximum number of errors to return
      - name: sortDirection
        value: desc
        type: query
        description: Direction to sort the results by
      - name: deviceId
        value: 575ed18f7ae143cd83dc4bb6
        type: query
        description: For edge workflows, the Device ID to return workflow errors for. When not included, will be errors for
          all device IDs.
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Get Information About Errors That Occurred During Runs of This Workflow Version
  - info:
      name: Updates Information About a Flow Version
      type: http
    http:
      method: PATCH
      url: https://api.losant.com/applications/:applicationId/flows/:flowId/versions/:flowVersionId
      params:
      - name: applicationId
        value: 575ec8687ae143cd83dc4a97
        type: path
        description: ID associated with the application
      - name: flowId
        value: 575ed18f7ae143cd83dc4aa6
        type: path
        description: ID associated with the flow
      - name: flowVersionId
        value: 675ed18f7ae143cd83dc4bb7
        type: path
        description: Version ID or version name associated with the flow version
      - name: includeCustomNodes
        value: 'true'
        type: query
        description: If the result of the request should also include the details of any custom nodes referenced by the returned
          workflows
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Updates Information About a Flow Version
  - info:
      name: Deletes a Flow Version
      type: http
    http:
      method: DELETE
      url: https://api.losant.com/applications/:applicationId/flows/:flowId/versions/:flowVersionId
      params:
      - name: applicationId
        value: 575ec8687ae143cd83dc4a97
        type: path
        description: ID associated with the application
      - name: flowId
        value: 575ed18f7ae143cd83dc4aa6
        type: path
        description: ID associated with the flow
      - name: flowVersionId
        value: 675ed18f7ae143cd83dc4bb7
        type: path
        description: Version ID or version name associated with the flow version
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Deletes a Flow Version
  - info:
      name: Returns the Flow Versions for a Flow
      type: http
    http:
      method: GET
      url: https://api.losant.com/applications/:applicationId/flows/:flowId/versions
      params:
      - name: applicationId
        value: 575ec8687ae143cd83dc4a97
        type: path
        description: ID associated with the application
      - name: flowId
        value: 575ed18f7ae143cd83dc4aa6
        type: path
        description: ID associated with the flow
      - name: sortField
        value: version
        type: query
        description: Field to sort the results by
      - name: sortDirection
        value: asc
        type: query
        description: Direction to sort the results by
      - name: page
        value: '0'
        type: query
        description: Which page of results to return
      - name: perPage
        value: '10'
        type: query
        description: How many items to return per page
      - name: filterField
        value: version
        type: query
        description: Field to filter the results by. Blank or not provided means no filtering.
      - name: filter
        value: my*version
        type: query
        description: Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
      - name: includeCustomNodes
        value: 'true'
        type: query
        description: If the result of the request should also include the details of any custom nodes referenced by the returned
          workflows
      - name: query
        value: ''
        type: query
        description: Workflow filter JSON object which overrides the filterField and filter parameters.
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Returns the Flow Versions for a Flow
  - info:
      name: Delete Flow Versions
      type: http
    http:
      method: POST
      url: https://api.losant.com/applications/:applicationId/flows/:flowId/versions
      params:
      - name: applicationId
        value: 575ec8687ae143cd83dc4a97
        type: path
        description: ID associated with the application
      - name: flowId
        value: 575ed18f7ae143cd83dc4aa6
        type: path
        description: ID associated with the flow
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Delete Flow Versions
  - info:
      name: Get Information About Errors That Occurred During Runs of This Workflow
      type: http
    http:
      method: GET
      url: https://api.losant.com/applications/:applicationId/flows/:flowId
      params:
      - name: applicationId
        value: 575ec8687ae143cd83dc4a97
        type: path
        description: ID associated with the application
      - name: flowId
        value: 575ed18f7ae143cd83dc4aa6
        type: path
        description: ID associated with the flow
      - name: duration
        value: '86400000'
        type: query
        description: Duration of time range in milliseconds
      - name: end
        value: '0'
        type: query
        description: End of time range in milliseconds since epoch
      - name: limit
        value: '25'
        type: query
        description: Maximum number of errors to return
      - name: sortDirection
        value: desc
        type: query
        description: Direction to sort the results by
      - name: flowVersion
        value: develop
        type: query
        description: Flow version name or ID. When not included, will be errors for all versions. Pass develop for just the
          develop version.
      - name: deviceId
        value: 575ed18f7ae143cd83dc4bb6
        type: query
        description: For edge or embedded workflows, the Device ID for which to return workflow errors. When not included,
          will be errors for all device IDs.
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Get Information About Errors That Occurred During Runs of This Workflow
  - info:
      name: Presses the Specified Virtual Button on the Flow
      type: http
    http:
      method: POST
      url: https://api.losant.com/applications/:applicationId/flows/:flowId
      params:
      - name: applicationId
        value: 575ec8687ae143cd83dc4a97
        type: path
        description: ID associated with the application
      - name: flowId
        value: 575ed18f7ae143cd83dc4aa6
        type: path
        description: ID associated with the flow
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Presses the Specified Virtual Button on the Flow
  - info:
      name: Sets a Storage Value
      type: http
    http:
      method: PATCH
      url: https://api.losant.com/applications/:applicationId/flows/:flowId
      params:
      - name: applicationId
        value: 575ec8687ae143cd83dc4a97
        type: path
        description: ID associated with the application
      - name: flowId
        value: 575ed18f7ae143cd83dc4aa6
        type: path
        description: ID associated with the flow
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Sets a Storage Value
  - info:
      name: Clear All Storage Entries
      type: http
    http:
      method: DELETE
      url: https://api.losant.com/applications/:applicationId/flows/:flowId
      params:
      - name: applicationId
        value: 575ec8687ae143cd83dc4a97
        type: path
        description: ID associated with the application
      - name: flowId
        value: 575ed18f7ae143cd83dc4aa6
        type: path
        description: ID associated with the flow
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Clear All Storage Entries
  - info:
      name: Gets Additional Nodes That Should Be Available in the Palette
      type: http
    http:
      method: GET
      url: https://api.losant.com/applications/:applicationId/flows
      params:
      - name: applicationId
        value: 575ec8687ae143cd83dc4a97
        type: path
        description: ID associated with the application
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Gets Additional Nodes That Should Be Available in the Palette
  - info:
      name: Import a Set of Flows and Flow Versions
      type: http
    http:
      method: POST
      url: https://api.losant.com/applications/:applicationId/flows
      params:
      - name: applicationId
        value: 575ec8687ae143cd83dc4a97
        type: path
        description: ID associated with the application
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Import a Set of Flows and Flow Versions
bundled: true