How do I set up a custom connection using OxBlue's API?

Easily connect your OxBlue image history to your program of choice. Using this connection, you’ll be able to access information about your cameras and find images.


OxBlue’s APIs are provided as simple REST APIs, which can be consumed by any library or software that can make HTTP requests. Each of the API endpoints expects JSON as the request body and returns JSON in its response bodies. Because of this, each API request should include the appropriate Content-Type and Accept headers.

Content-Type: application/json
Accept: application/json

Each API endpoint also uses a consistent base URL:



There are two pieces of information that are needed for nearly all calls to the OxBlue API: an application ID, and a session token.

Application ID

OxBlue partners and consumers of the OxBlue API are issued an application identifier that is used to authenticate your application with the API. If you need to change it for any reason, please email us at, and we’ll get it replaced for you!

To access the OxBlue API, add the above key in an HTTP request as a custom X-APP-ID header.


Session Token

Most requests also require an Authorization header be sent, along with a Bearer token.

Authorization: Bearer SESSION_IDENTIFIER

Only two routes do not require an Authorization header; the responses to these two routes
themselves contain a session identifier to be used for authenticated requests.

  • POST /sessions
  • POST /openlink-sessions

Putting it all together

With the above information, we can make a request to the OxBlue API to authenticate a
Public Link using curl:

curl --request POST \
--header 'X-APP-ID: APP_ID' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{"openLink": "apidemo"}'

This will return a session identifier in the response, which can then be used to communicate
with additional API endpoints.


Next Steps

Download the latest version of our API documentation to get more information on cameras.
Open the file as a web page.

Please reach out to with any questions.