Skip to main content

estuary-client.AdminApi

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

MethodHTTP requestDescription
admin_peering_peers_deleteDELETE /admin/peering/peersRemove peers on Peering Service
admin_peering_peers_getGET /admin/peering/peersList all Peering peers
admin_peering_peers_postPOST /admin/peering/peersAdd peers on Peering Service
admin_peering_start_postPOST /admin/peering/startStart Peering
admin_peering_status_getGET /admin/peering/statusCheck Peering Status
admin_peering_stop_postPOST /admin/peering/stopStop Peering
admin_system_config_getGET /admin/system/configGet systems(estuary/shuttle) config
admin_users_getGET /admin/usersGet all users

admin_peering_peers_delete

admin_peering_peers_delete(body)

Remove peers on Peering Service

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

Example

from __future__ import print_function
import time
import estuary-client
from estuary-client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary-client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary-client.AdminApi(estuary-client.ApiClient(configuration))
body = [estuary-client.list[str]()] # list[str] | Peer ids

try:
# Remove peers on Peering Service
api_instance.admin_peering_peers_delete(body)
except ApiException as e:
print("Exception when calling AdminApi->admin_peering_peers_delete: %s\n" % e)

Parameters

NameTypeDescriptionNotes
bodylist[str]Peer ids

Return type

void (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]

admin_peering_peers_get

admin_peering_peers_get()

List all Peering peers

This endpoint can be used to list all peers on Peering Service

Example

from __future__ import print_function
import time
import estuary-client
from estuary-client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary-client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary-client.AdminApi(estuary-client.ApiClient(configuration))

try:
# List all Peering peers
api_instance.admin_peering_peers_get()
except ApiException as e:
print("Exception when calling AdminApi->admin_peering_peers_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (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]

admin_peering_peers_post

admin_peering_peers_post()

Add peers on Peering Service

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

Example

from __future__ import print_function
import time
import estuary-client
from estuary-client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary-client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary-client.AdminApi(estuary-client.ApiClient(configuration))

try:
# Add peers on Peering Service
api_instance.admin_peering_peers_post()
except ApiException as e:
print("Exception when calling AdminApi->admin_peering_peers_post: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (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]

admin_peering_start_post

admin_peering_start_post()

Start Peering

This endpoint can be used to start the Peering Service

Example

from __future__ import print_function
import time
import estuary-client
from estuary-client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary-client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary-client.AdminApi(estuary-client.ApiClient(configuration))

try:
# Start Peering
api_instance.admin_peering_start_post()
except ApiException as e:
print("Exception when calling AdminApi->admin_peering_start_post: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (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]

admin_peering_status_get

admin_peering_status_get()

Check Peering Status

This endpoint can be used to check the Peering status

Example

from __future__ import print_function
import time
import estuary-client
from estuary-client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary-client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary-client.AdminApi(estuary-client.ApiClient(configuration))

try:
# Check Peering Status
api_instance.admin_peering_status_get()
except ApiException as e:
print("Exception when calling AdminApi->admin_peering_status_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (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]

admin_peering_stop_post

admin_peering_stop_post()

Stop Peering

This endpoint can be used to stop the Peering Service

Example

from __future__ import print_function
import time
import estuary-client
from estuary-client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary-client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary-client.AdminApi(estuary-client.ApiClient(configuration))

try:
# Stop Peering
api_instance.admin_peering_stop_post()
except ApiException as e:
print("Exception when calling AdminApi->admin_peering_stop_post: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (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]

admin_system_config_get

admin_system_config_get()

Get systems(estuary/shuttle) config

This endpoint is used to get system configs.

Example

from __future__ import print_function
import time
import estuary-client
from estuary-client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary-client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary-client.AdminApi(estuary-client.ApiClient(configuration))

try:
# Get systems(estuary/shuttle) config
api_instance.admin_system_config_get()
except ApiException as e:
print("Exception when calling AdminApi->admin_system_config_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (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]

admin_users_get

admin_users_get()

Get all users

This endpoint is used to get all users.

Example

from __future__ import print_function
import time
import estuary-client
from estuary-client.rest import ApiException
from pprint import pprint

# Configure API key authorization: bearerAuth
configuration = estuary-client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# create an instance of the API class
api_instance = estuary-client.AdminApi(estuary-client.ApiClient(configuration))

try:
# Get all users
api_instance.admin_users_get()
except ApiException as e:
print("Exception when calling AdminApi->admin_users_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (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]