Skip to main content

AdminApi

All URIs are relative to **

MethodHTTP requestDescription
adminPeeringPeersDeleteDELETE /admin/peering/peersRemove peers on Peering Service
adminPeeringPeersGetGET /admin/peering/peersList all Peering peers
adminPeeringPeersPostPOST /admin/peering/peersAdd peers on Peering Service
adminPeeringStartPostPOST /admin/peering/startStart Peering
adminPeeringStatusGetGET /admin/peering/statusCheck Peering Status
adminPeeringStopPostPOST /admin/peering/stopStop Peering
adminSystemConfigGetGET /admin/system/configGet systems(estuary/shuttle) config
adminUsersGetGET /admin/usersGet all users

adminPeeringPeersDelete

Remove peers on Peering Service

This endpoint can be used to remove a Peer from the Peering Service

Example

 adminPeeringPeersDelete

Parameters

NameTypeDescriptionNotes
bodyarray[string]Peer ids

Return type

(empty response body)

Authorization

bearerAuth

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

bearerAuth

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

bearerAuth

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

bearerAuth

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

bearerAuth

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

bearerAuth

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

bearerAuth

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

bearerAuth

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]