Skip to content

Add API usage documentation and restructure existing content #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 15, 2025
+12,838 −27
Merged

Add API usage documentation and restructure existing content #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
59a1bc4
Add API usage documentation and restructure existing content
caffeinated92 Jan 9, 2025
42b75bb
Fix typo in API credential key from `api-credential` to `api-credenti…
caffeinated92 Sep 15, 2025
ec30746
Merge remote-tracking branch 'origin/master' into v3
caffeinated92 Sep 15, 2025
469aa51
Update API documentation section in latest and previous versions
caffeinated92 Sep 15, 2025
d38bb79
Update API documentation to include online browsing link and installa…
caffeinated92 Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 2 additions & 25 deletions 03.usage/03.api/docs.md → 03.usage/03.api/00.overview/docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Credentials can be customized by setting your own user and password in configura

```
api-port ="10005"
api-credential = "admin:repman"
api-credentials = "admin:repman"
```

At startup of the monitor, X509 certificates are loaded from the replication-manager share directory or from keys defined from config files to ensure TLS https secure communication.
Expand Down Expand Up @@ -58,29 +58,6 @@ TOKEN=$(wget -qO- --no-check-certificate --post-data '{"username":"admin","pass

wget -qO- --no-check-certificate --header 'Accept: application/json' --header "Authorization: Bearer ${TOKEN}" https://127.0.0.1:10005/api/clusters

### Monitor Unprotected Endpoints

/api/login

INPUT: POST
```
{"username":"admin", "password":"mariadb"}
```
OUTPUT:
```
{"token":"hash"}
```

/api/status

OUPUT:
```
{"alive": true}
./replication-manager api --url="https://127.0.0.1:10005/api/status"
```

/api/clusters/{clusterName}/status

## API documentation
[Can be browsed online] https://dbaas-fr-2.signal18.io/api-docs/index.html)
Or by installing the product and point to http://127.0.0.1:10001/api-docs
Or by installing the product and point to http://127.0.0.1:10001/api-docs
Loading