REST API: Difference between revisions
No edit summary |
No edit summary |
||
| Line 11: | Line 11: | ||
[http://www.json.org JSON] is used for all endpoints. This includes response data and PUT/POST data. | [http://www.json.org JSON] is used for all endpoints. This includes response data and PUT/POST data. | ||
The returned Content-Type will always be "application/json". | The returned Content-Type will always be "application/json" using the UTF-8 encoding. | ||
All PUTs and POSTs must include Content-Type header set to "application/json". | All PUTs and POSTs must include Content-Type header set to "application/json". UTF-8 should be used to encode all data for compatibility reasons. | ||
==Authentication & Authorization== | ==Authentication & Authorization== | ||
Revision as of 22:49, 5 January 2013
Obsidian provides a REST API to ease integration into other applications and software environments, regardless of the technology used. A complete range of job, scheduling and host management features are exposed via the API.
The REST API is exposed by both the standalone and bundled versions of the admin web application.
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" using the UTF-8 encoding.
All PUTs and POSTs must include Content-Type header set to "application/json". UTF-8 should be used to encode all data for compatibility reasons.
Authentication & Authorization
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. Valid API users are authorized to access any REST endpoint.
