mirror of
https://github.com/donaldzou/WGDashboard.git
synced 2024-11-22 07:10:09 +01:00
Update api-documents.md
This commit is contained in:
parent
5d4a8136c5
commit
ea0bbab680
@ -60,6 +60,8 @@ This endpoint is designed for a simple handshake when using API key to connect.
|
||||
```
|
||||
> Notice: this `401` response will return at all endpoint if your API Key or session is invalid.
|
||||
|
||||
<hr>
|
||||
|
||||
### Validate Authentication
|
||||
|
||||
This endpoint if needed for non-cross-server access. This will check if the cookie on the client side is still valid on the server side.
|
||||
@ -91,6 +93,7 @@ Session is invalid
|
||||
"status": false
|
||||
}
|
||||
```
|
||||
<hr>
|
||||
|
||||
### Authenticate
|
||||
|
||||
@ -141,6 +144,8 @@ If username, password or TOTP is not match
|
||||
}
|
||||
```
|
||||
|
||||
<hr>
|
||||
|
||||
### Sign Out
|
||||
|
||||
To remove the current session on server side
|
||||
@ -200,6 +205,7 @@ To get all WireGuard configurations in `/etc/wireguard`
|
||||
"status": true
|
||||
}
|
||||
```
|
||||
<hr>
|
||||
|
||||
### Add WireGuard Configuration
|
||||
|
||||
@ -282,6 +288,7 @@ If the new configuration's `Address` is used by another configuration
|
||||
"status": false
|
||||
}
|
||||
```
|
||||
<hr>
|
||||
|
||||
### Toggle WireGuard Configuration
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user