estuary-client.AutoretrieveApi

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

Method	HTTP request	Description
admin_autoretrieve_init_post	POST /admin/autoretrieve/init	Register autoretrieve server
admin_autoretrieve_list_get	GET /admin/autoretrieve/list	List autoretrieve servers
autoretrieve_heartbeat_post	POST /autoretrieve/heartbeat	Marks autoretrieve server as up

admin_autoretrieve_init_post

admin_autoretrieve_init_post(addresses, pub_key)

Register autoretrieve server

This endpoint registers a new autoretrieve server

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.AutoretrieveApi(estuary-client.ApiClient(configuration))
addresses = 'addresses_example' # str | Autoretrieve's comma-separated list of addresses
pub_key = 'pub_key_example' # str | Autoretrieve's public key

try:
    # Register autoretrieve server
    api_instance.admin_autoretrieve_init_post(addresses, pub_key)
except ApiException as e:
    print("Exception when calling AutoretrieveApi->admin_autoretrieve_init_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
addresses	str	Autoretrieve's comma-separated list of addresses
pub_key	str	Autoretrieve's public key

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_autoretrieve_list_get

admin_autoretrieve_list_get()

List autoretrieve servers

This endpoint lists all registered autoretrieve servers

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.AutoretrieveApi(estuary-client.ApiClient(configuration))

try:
    # List autoretrieve servers
    api_instance.admin_autoretrieve_list_get()
except ApiException as e:
    print("Exception when calling AutoretrieveApi->admin_autoretrieve_list_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]

autoretrieve_heartbeat_post

autoretrieve_heartbeat_post(token)

Marks autoretrieve server as up

This endpoint updates the lastConnection field for autoretrieve

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.AutoretrieveApi(estuary-client.ApiClient(configuration))
token = 'token_example' # str | Autoretrieve's auth token

try:
    # Marks autoretrieve server as up
    api_instance.autoretrieve_heartbeat_post(token)
except ApiException as e:
    print("Exception when calling AutoretrieveApi->autoretrieve_heartbeat_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
token	str	Autoretrieve's auth token

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]