AdminApi
All URIs are relative to **
Method | HTTP request | Description |
---|---|---|
adminPeeringPeersDelete | DELETE /admin/peering/peers | Remove peers on Peering Service |
adminPeeringPeersGet | GET /admin/peering/peers | List all Peering peers |
adminPeeringPeersPost | POST /admin/peering/peers | Add peers on Peering Service |
adminPeeringStartPost | POST /admin/peering/start | Start Peering |
adminPeeringStatusGet | GET /admin/peering/status | Check Peering Status |
adminPeeringStopPost | POST /admin/peering/stop | Stop Peering |
adminSystemConfigGet | GET /admin/system/config | Get systems(estuary/shuttle) config |
adminUsersGet | GET /admin/users | Get all users |
adminPeeringPeersDelete
Remove peers on Peering Service
This endpoint can be used to remove a Peer from the Peering Service
Example
adminPeeringPeersDelete
Parameters
Name | Type | Description | Notes |
---|---|---|---|
body | array[string] | Peer ids |
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
adminPeeringPeersGet
List all Peering peers
This endpoint can be used to list all peers on Peering Service
Example
adminPeeringPeersGet
Parameters
This endpoint does not need any parameter.
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
adminPeeringPeersPost
Add peers on Peering Service
This endpoint can be used to add a Peer from the Peering Service
Example
adminPeeringPeersPost
Parameters
This endpoint does not need any parameter.
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
adminPeeringStartPost
Start Peering
This endpoint can be used to start the Peering Service
Example
adminPeeringStartPost
Parameters
This endpoint does not need any parameter.
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
adminPeeringStatusGet
Check Peering Status
This endpoint can be used to check the Peering status
Example
adminPeeringStatusGet
Parameters
This endpoint does not need any parameter.
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
adminPeeringStopPost
Stop Peering
This endpoint can be used to stop the Peering Service
Example
adminPeeringStopPost
Parameters
This endpoint does not need any parameter.
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
adminSystemConfigGet
Get systems(estuary/shuttle) config
This endpoint is used to get system configs.
Example
adminSystemConfigGet
Parameters
This endpoint does not need any parameter.
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
adminUsersGet
Get all users
This endpoint is used to get all users.
Example
adminUsersGet
Parameters
This endpoint does not need any parameter.
Return type
(empty response body)
Authorization
HTTP request headers
- Content-Type: Not Applicable
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]