REST API

Obsidian provides a REST API to ease integration into other applications and software environments. A complete range of job and scheduling features are exposed via the API.

Guidelines

The REST API is exposed by both the standalone and bundled versions of the admin web application.

JSON is used for both requests and responses.

Endpoints

The API is exposed under the path "/rest".

For example, if your web application is deployed at localhost, the jobs endpoint is accessible at "http://localhost/rest/jobs".

Data Format

JSON is used for all endpoints. This includes response data and PUT/POST data.

The returned Content-Type will always be "application/json".

All PUTs and POSTs must include Content-Type header set to "application/json".

Authentication/Authorizaton

The REST API is secured by limiting access to users configured in User Management with the API Access role.

Valid basic access authentication must be supplied with every request.