> For the complete documentation index, see [llms.txt](https://developers.gallabox.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.gallabox.com/getting-started/overview.md).

# Overview

Gallabox provides an HTTP-based API that follows the principles of [REST](http://en.wikipedia.org/wiki/Representational_state_transfer#RESTful_web_services). 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](broken://pages/mXziwZHLk7PQ1AmZthuv).

### Resources <a href="#resources" id="resources"></a>

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](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html) (like GET,POST) determines the operation type on the resource. [Query parameters](http://en.wikipedia.org/wiki/Query_string) allow you to provide additional options to the GET requests. [POST parameters](https://en.wikipedia.org/wiki/POST_\(HTTP\)) provide the data to write operations like creation, modification of resource(s).

#### **Response**

The response is in [JSON](http://en.wikipedia.org/wiki/JSON) format. Currently Gallabox does not support any other response format.