Skip to main content

\AdminApi

All URIs are relative to https://api.estuary.tech

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

AdminPeeringPeersDelete(ctx, body) Remove peers on Peering Service

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

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
body[]stringPeer ids

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

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

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

AdminPeeringPeersGet

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

(empty response body)

Authorization

bearerAuth

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

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

(empty response body)

Authorization

bearerAuth

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

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

(empty response body)

Authorization

bearerAuth

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

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

(empty response body)

Authorization

bearerAuth

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

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

(empty response body)

Authorization

bearerAuth

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

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

(empty response body)

Authorization

bearerAuth

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

AdminUsersGet(ctx, ) Get all users

This endpoint is used to get all users.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

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

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