10 API

Qstick edited this page 2020-06-28 18:28:00 -04:00

Table of Contents

• API IS STILL WIP AND VERSION BUMPS WILL NOT OCCUR UNTIL POST 1.0 RELEASE.
• URL
• Authentication
• API Key
• Dates & Times
• Content Type
• Endpoints

API IS STILL WIP AND VERSION BUMPS WILL NOT OCCUR UNTIL POST 1.0 RELEASE.

URL

All API endpoints are based off of /api/v1. As in, if you access Lidarr via http://localhost:8686, the API root would be http://localhost:8686/api/v1. You can also take the example http://192.168.1.20:8686/lidarr/api/v1.

All other items build after this.

Authentication

All requests made to the API endpoint require the API Key authentication using the X-Api-Key header or using the ?apikey= query string:

http://localhost:8686/api/v1/system/status?apikey=${YOUR_API_KEY}

Where:

1. http://localhost:8686/api/v1 is the main API Endpoint
2. /system/status would be the specific GET request, which can be submitted by the other commands.
3. ?apikey=${YOUR_API_KEY} is required for requests against your Lidarr instance, and gets stuck here at the end.
4. There are other commands that request/require additional information, of which will be explained on those pages.

API Key

• Can be accessed and reset via Settings -> General through the GUI
• Also can be accessed via the Config.xml file, in the AppData Directory
• alpha-numeric (lower case)

Dates & Times

• All dates/timestamps are ISO-8601 formatted in UTC 2014-01-27T01:30:00Z
• Date parameters should be ISO-8601 UTC dates to ensure proper handling by Lidarr

Content Type

• All POST/PUT requests require all parameters to be JSON encoded in the body, unless otherwise noted.
• All GET requests will return a JSON encoded response

Endpoints

Full API Docs can be found at https://lidarr.audio/docs/api/