sonarr-api
Small module which helps you query the Sonarr HTTP API.
Please refer to the Sonarr API documentation for futher explainations and endpoints, most if not all are cover below.
Usage
SonarrAPI(options)
Instantiate a SonarrAPI client.
Options:
- hostname: hostname where Sonarr runs (required)
- apiKey: Your API to access Sonarr (required)
- port: port number Sonarr is listening on (optional, default: 8989)
- urlBase: URL Base of Sonarr (optional, default: null)
- ssl: Set to true if you are connecting via SSL (default: false)
- username: HTTP Auth username (default: null)
- password: HTTP Auth password (default: null)
Methods
get - send a GET request to the Sonarr API - if available returns jsonpost - send a POST request to the Sonarr API - if available returns jsonput - send a PUT request to the Sonarr API - if available returns json
Examples
var SonarrAPI = ; var sonarr = hostname: 'localhost' apiKey: '(insert your API key here)' port: 9000 urlBase: '/sonarr'; // get Sonarr Statussonarr;
More examples
/* * Calendar example */ var today = ;var yesterday = today today today - 1;var tomorrow = today today today + 1; sonarr; /* * Command example - * note use of POST method * */sonarr; /* * Diskspace example */sonarr; /* * Episode example */sonarr; sonarr; /* * EpisodeFile example */sonarr; sonarr; /* * History example */sonarr; /* * Wanted example */sonarr; /* * Queue example */sonarr; /* * Profile example */sonarr; /* * Release example */sonarr; /* * Root folder example */sonarr; /* * Series example */sonarr; sonarr; sonarr;
Changelog
v0.2.0
- Rewrote module to utilize ES6 classes / promises
v0.1.1
- Minor code clean up
v0.1.0
- Initial release
License
(The MIT License)
Copyright (c) 2015 Devin Buhl mailto:devin.kray@gmail.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.