Octopi is a modern, cloud-based Terminal Operating System (TOS).
Note: Review our documentation on security, resilience, and privacy in Octopi.
REST & Hypermedia
The Octopi API is a RESTful API using JSON and the HATEOAS paradigm. In every JSON response from the API, you will find a list of actions returned as a JSON array. These actions are all the methods available on the API resource. We encourage you to build your clients to use these actions dynamically. That way, if the API changes URLs, your client will keep functioning without changing the source code of your client application.
The Octopi API uses HTTP Token Access Authentication.
To authenticate, you need to pass in your API Key (obtained from the Octopi Team) in the HTTP request header using an ‘Authorization’ header with the API key as a token.
For example, the header should have “Token token=yourapikey”.