Overview

Gallabox provides an HTTP-based API that follows the principles of REST. The HTTP rules followed allow simple HTTP clients like cURL to be used as well. The URLs are resource-oriented, the request format is form-encoded, and the responses are in JSON.

Depending on the type of operation, the endpoints use one of two HTTP methods:

• GET: Used for all read-only operations such as retrieving a resource or listing a group of resources.

• POST: Used for all write operations. Such operations modify the state of a resource.

A history of changes to the API is provided in the API Changelog.

Resources

Gallabox follows the REST model of exposing resources as urls. For example, Users are exposed as

https://server.gallabox.com/devapi/accounts/{{accountId}}/users

Request

The HTTP method (like GET,POST) determines the operation type on the resource. Query parameters allow you to provide additional options to the GET requests. POST parameters provide the data to write operations like creation, modification of resource(s).

Response

The response is in JSON format. Currently Gallabox does not support any other response format.