Overview

Overview of the AXIBO REST API

Requests

AXIBO sends requests to the AXIBO UI. When the AXIBO sends a request the data is formatted using JSON.

{axibo-ip}

In the endpoint of each REST API remove {axibo-ip} and replace this with your AXIBOs IP address.

Headers

The headers for the AXIBO REST API consists only of Contents-Type and can be used for all POST, PUT, and DEL requests.

Property
Type
Required
Description

Content-Type

string

Yes

Designated the content to be in the JSON format

Responses

The following is a list of general responses that all GET, POST, PUT, and DEL requests will send back.

Response
Description

200

Request Success

400

Bad Request

404

Request Not Found

429

Too Many Requests

500

Internal Server Error

This does not encompass all responses (e.g., GET requests will send JSON packages back)

Change Log

2022-08-18: Added Overview, Motion Routes, System, Image, Video Recorder Documentation

Last updated