Getting Started

Connecting to Your Device Through the OakOS API

For this section you will need to download and install Postman onto your local machine.

Once you have Postman installed locally you can import our API into Postman. To do so simply click the top right button of OakOS API documentation that says "Run in Postman". This will import our API into your Postman App.

Now you have a copy of our API and will need to now setup environmental variables in order hook everything up.

📘

In order to use the API you will need to first send your dashboard username and password to the the API. Postman will store a session cookie for that authentication to be used an all other calls in the Dashboard.

Updated 10 months ago


Getting Started


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.