diff --git a/docs/1.client/rpc.md b/docs/1.client/rpc.md index efbb8d1..aa69525 100644 --- a/docs/1.client/rpc.md +++ b/docs/1.client/rpc.md @@ -15,7 +15,7 @@ We've observed that using `127.0.0.1` when IPv4 is disabled tends to break and n Unless explicitly disabled within Cider, all API requests require a valid API token. You can generate this token, or turn off authentication, from the menu at **Settings -> Connectivity -> Manage External Application Access to Cider** within Cider. -The generated token should be passed in the `apitoken` header of all requests. Do not prefix the token with `Bearer` or any other string; just pass the token by itself in the header. +The generated token should be passed in the `apptoken` header of all requests. Do not prefix the token with `Bearer` or any other string; just pass the token by itself in the header. This token is not required if disabled within the settings menu. @@ -28,8 +28,12 @@ The API endpoints documented below are all nested under `/api/v1/playback`. Responds with an empty body and status code `204: No Content`. This endpoint can be used to quickly check that the RPC server is still active.
-204: No Content -// No response body... +200: OK + +
{
+  "status": "ok"
+}
+
#### **GET** `/is-playing` @@ -201,6 +205,7 @@ Accepts a `type` of item to play and an `id` for the item. `type` should be one "status": "ok" } + #### **POST** `/play-next` @@ -307,6 +312,7 @@ If no item is currently playing but there is one in the playback history, it wil "status": "ok" } + #### **GET** `/queue` @@ -588,6 +594,7 @@ Note that the index is 1-indexed (starts at 1, not 0). Also note that the queue "returnQueue": false } +
200: OK @@ -639,12 +646,15 @@ Accepts a `position` in seconds to seek to. Note that `/now-playing` returns a t "position": 30 } +
-204: No Content -```json -// No Response Body... -``` +200: OK + +
{
+  "status": "ok"
+}
+
#### **GET** `/volume`