diff --git a/API.md b/API.md index 5a4f17e..81348e0 100644 --- a/API.md +++ b/API.md @@ -1,6 +1,6 @@ ## URL ## -All API endpoints are based off of `/api`. As in, if you access Lidarr via `http://localhost:8686`, the API root would be `http://localhost:8686/api`. You can also take the example `http://192.168.1.20:8686/lidarr/api`. +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. @@ -9,12 +9,12 @@ All other items build after this. 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/system/status?apikey=${YOUR_API_KEY} +http://localhost:8686/api/v1/system/status?apikey=${YOUR_API_KEY} ``` Where: -1. `http://localhost:8686/api` is the main API Endpoint +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.