RESTful API - Mark-Millard/oktopus GitHub Wiki

REST API Overview

Note that the GUI does not provide complete control over device management (i.e. removing an offline device). For this you will need to use the REST API.

The RESTful API can be found at Oktopus Controller REST API.

REST API Details

Listing Registered Devices

To list the devices registered in the Controller, use the following curl command:

curl -v --location '[http://10.1.10.58:8000/api/device?page_number=0&page_size=20'](http://10.1.10.58:8000/api/device?page_number=0&page_size=20%27) --header 'Content-Type: application/json' --header 'Authorization: <token>'

where

Deleting a Device

Note

This API is not currently implemented in the original Oktopus open source.

curl --location --request DELETE 'http://localhost:8000/api/device?id=oktopus-2-stomp%2Coktopus-4-stomp' \
--header 'Content-Type: application/json' \
--header 'Authorization: <token>'

where

  • oktopus-0-stomp: ID of above STOMP obuspa agent example
  • <token>: See Oktopus JWT Information wiki on how to obtain a token for the Oktopus Controller
⚠️ **GitHub.com Fallback** ⚠️