BlockStorage/repertory
1
0
Fork 0
Code Issues 3 Pull Requests Releases 9 Wiki Activity

Update HTTP REST API

sgraves76
2025-08-13 20:56:37 -05:00
parent f69616b3a6
commit 5905f96593
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
HTTP-REST-API.md

@@ -20,11 +20,11 @@ Example hash for the password `repertory`:
55427d3dfdce97ef391db56aaf63a3726266777b46df1fa6dbc492093491e7605bd39cf6a88d6ccf4499b9d0de7f78c6 55427d3dfdce97ef391db56aaf63a3726266777b46df1fa6dbc492093491e7605bd39cf6a88d6ccf4499b9d0de7f78c6
``` ```
This document reflects the API **exactly as implemented** in the server code shown (`server` and `full_server`). This document reflects the API **exactly as implemented** in the server code.
- **Bind Address:** `127.0.0.1` - **Bind Address:** `127.0.0.1`
- **Base Path:** `/api/v1/` - **Base Path:** `/api/v1/`
- **Auth:** HTTP Basic Auth on every request (checked by `rpc::check_authorization` before routing) - **Auth:** HTTP Basic Auth on every request
- **Content-Type:** JSON for successful responses that include bodies; some endpoints return **no body** on success. - **Content-Type:** JSON for successful responses that include bodies; some endpoints return **no body** on success.
- **Status Codes:** - **Status Codes:**
- `200 OK` on success - `200 OK` on success
@@ -32,7 +32,7 @@ This document reflects the API **exactly as implemented** in the server code sho
- `404 Not Found` for some resource misses (e.g., pin/unpin when path not found) - `404 Not Found` for some resource misses (e.g., pin/unpin when path not found)
- `500 Internal Server Error` on unhandled exceptions (JSON body with `path` and `error` provided by exception handler) - `500 Internal Server Error` on unhandled exceptions (JSON body with `path` and `error` provided by exception handler)
> The server listens on `127.0.0.1:<API_PORT>`, where `<API_PORT>` comes from your runtime configuration (`config_.get_api_port()`). > The server listens on `127.0.0.1:<API_PORT>`, where `<API_PORT>` comes from your runtime configuration (`config.json`).
--- ---