AdminApi
All URIs are relative to //api.estuary.tech/
| 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
string AdminPeeringPeersDelete(ctx, body) Remove peers on Peering Service
This endpoint can be used to remove a Peer from the Peering Service
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | []bool | Peer ids |
Return type
string
Authorization
HTTP request headers
- Content-Type: /
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AdminPeeringPeersGet
string AdminPeeringPeersGet(ctx, ) List all Peering peers
This endpoint can be used to list all peers on Peering Service
Required Parameters
This endpoint does not need any parameter.
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AdminPeeringPeersPost
string AdminPeeringPeersPost(ctx, ) Add peers on Peering Service
This endpoint can be used to add a Peer from the Peering Service
Required Parameters
This endpoint does not need any parameter.
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AdminPeeringStartPost
string AdminPeeringStartPost(ctx, ) Start Peering
This endpoint can be used to start the Peering Service
Required Parameters
This endpoint does not need any parameter.
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AdminPeeringStatusGet
string AdminPeeringStatusGet(ctx, ) Check Peering Status
This endpoint can be used to check the Peering status
Required Parameters
This endpoint does not need any parameter.
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AdminPeeringStopPost
string AdminPeeringStopPost(ctx, ) Stop Peering
This endpoint can be used to stop the Peering Service
Required Parameters
This endpoint does not need any parameter.
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AdminSystemConfigGet
string AdminSystemConfigGet(ctx, ) Get systems(estuary/shuttle) config
This endpoint is used to get system configs.
Required Parameters
This endpoint does not need any parameter.
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AdminUsersGet
string AdminUsersGet(ctx, ) Get all users
This endpoint is used to get all users.
Required Parameters
This endpoint does not need any parameter.
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]