REST API

API to perform any operation with the flespi platform. Open API Box to delve into the API docs now. Also check our MQTT API.

Flespi is a backend platform that is destined to sit under the hood of your beautiful solution. Therefore, most of the time, flespi is in itself the API.

ALL operations with the flespi platform can be performed via the API.

API Box is the latest version of the flespi REST API documentation perfect for finding the proper request methods, interactive testing, learning about deprecated methods, and a lot more (check the detailed API Box guide here).

flespi api box tool

Interesting fact

All the user-friendly tools you use to manage your flespi account — flespi panel, Toolbox, TrackIt, HelpBox, etc. — are just neatly developed customer-facing interfaces wrapped around the API. Basically, these are the living examples of applications developed on top of the flespi API;)

Request structure

curl -X [GET|POST|PUT|DELETE] --header ’Authorization: FlespiToken XXXXXX’ -d ‘["name":"new-name","parameter":"value"}]’ ‘https://[ru.]flespi.io/resource-location-URL’

Note: The URL depends on the region in which the given flespi account was registered.

Example 1: get the list of all registered devices

curl -X get --header 'Accept: application/json' --header 'Authorization: XXXXXX 'https://flespi.io/gw/devices/all'

Example 2: create new ‘teltonika’ channel

curl -X post --header 'Accept: application/json' --header 'Authorization: FlespiToken XXXXXX' -d '[{"name":"new-channel-name","protocol_name":"teltonika"}]' 'https://flespi.io/gw/channels'

Example 3: delete a flespi device with specific id

curl -X delete --header 'Accept: application/json' --header 'Authorization: FlespiToken XXXXXX' 'https://flespi.io/gw/devices/123456

Available APIs

Permissions

You can use ACL tokens to grant access to the specific parts of the platform:

flespi acl token configuration

Request limits

Limits on the number of REST API calls in Free and Commercial accounts are outlined here.

Want to know more about API Box functionality?