Swagger\Client\AutoretrieveApi

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

Method	HTTP request	Description
adminAutoretrieveInitPost	POST /admin/autoretrieve/init	Register autoretrieve server
adminAutoretrieveListGet	GET /admin/autoretrieve/list	List autoretrieve servers
autoretrieveHeartbeatPost	POST /autoretrieve/heartbeat	Marks autoretrieve server as up

adminAutoretrieveInitPost

adminAutoretrieveInitPost($addresses, $pub_key)

Register autoretrieve server

This endpoint registers a new autoretrieve server

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\AutoretrieveApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$addresses = "addresses_example"; // string | Autoretrieve's comma-separated list of addresses
$pub_key = "pub_key_example"; // string | Autoretrieve's public key

try {
    $apiInstance->adminAutoretrieveInitPost($addresses, $pub_key);
} catch (Exception $e) {
    echo 'Exception when calling AutoretrieveApi->adminAutoretrieveInitPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
addresses	string	Autoretrieve's comma-separated list of addresses
pub_key	string	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]

adminAutoretrieveListGet

adminAutoretrieveListGet()

List autoretrieve servers

This endpoint lists all registered autoretrieve servers

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\AutoretrieveApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $apiInstance->adminAutoretrieveListGet();
} catch (Exception $e) {
    echo 'Exception when calling AutoretrieveApi->adminAutoretrieveListGet: ', $e->getMessage(), PHP_EOL;
}
?>

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]

autoretrieveHeartbeatPost

autoretrieveHeartbeatPost($token)

Marks autoretrieve server as up

This endpoint updates the lastConnection field for autoretrieve

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearerAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\AutoretrieveApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$token = "token_example"; // string | Autoretrieve's auth token

try {
    $apiInstance->autoretrieveHeartbeatPost($token);
} catch (Exception $e) {
    echo 'Exception when calling AutoretrieveApi->autoretrieveHeartbeatPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
token	string	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]