PeeringApi
All URIs are relative to https://api.estuary.tech
Method | HTTP request | Description |
---|---|---|
adminPeeringPeersDelete | DELETE /admin/peering/peers | Remove peers on Peering Service |
adminPeeringPeersGet | GET /admin/peering/peers | List all Peering peers |
adminPeeringPeersPost | POST /admin/peering/peers | Add peers on Peering Service |
adminPeeringStartPost | POST /admin/peering/start | Start Peering |
adminPeeringStatusGet | GET /admin/peering/status | Check Peering Status |
adminPeeringStopPost | POST /admin/peering/stop | Stop Peering |
Remove peers on Peering Service
This endpoint can be used to remove a Peer from the Peering Service
Example
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PeeringApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");
PeeringApi apiInstance = new PeeringApi();
List<String> body = Arrays.asList(new List<String>()); // List<String> | Peer ids
try {
apiInstance.adminPeeringPeersDelete(body);
} catch (ApiException e) {
System.err.println("Exception when calling PeeringApi#adminPeeringPeersDelete");
e.printStackTrace();
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
body | List<String> | Peer ids |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
List all Peering peers
This endpoint can be used to list all peers on Peering Service
Example
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PeeringApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");
PeeringApi apiInstance = new PeeringApi();
try {
apiInstance.adminPeeringPeersGet();
} catch (ApiException e) {
System.err.println("Exception when calling PeeringApi#adminPeeringPeersGet");
e.printStackTrace();
}
Parameters
This endpoint does not need any parameter.
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Add peers on Peering Service
This endpoint can be used to add a Peer from the Peering Service
Example
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PeeringApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");
PeeringApi apiInstance = new PeeringApi();
try {
apiInstance.adminPeeringPeersPost();
} catch (ApiException e) {
System.err.println("Exception when calling PeeringApi#adminPeeringPeersPost");
e.printStackTrace();
}
Parameters
This endpoint does not need any parameter.
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Start Peering
This endpoint can be used to start the Peering Service
Example
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PeeringApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");
PeeringApi apiInstance = new PeeringApi();
try {
apiInstance.adminPeeringStartPost();
} catch (ApiException e) {
System.err.println("Exception when calling PeeringApi#adminPeeringStartPost");
e.printStackTrace();
}
Parameters
This endpoint does not need any parameter.
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Check Peering Status
This endpoint can be used to check the Peering status
Example
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PeeringApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");
PeeringApi apiInstance = new PeeringApi();
try {
apiInstance.adminPeeringStatusGet();
} catch (ApiException e) {
System.err.println("Exception when calling PeeringApi#adminPeeringStatusGet");
e.printStackTrace();
}
Parameters
This endpoint does not need any parameter.
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Stop Peering
This endpoint can be used to stop the Peering Service
Example
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.PeeringApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: bearerAuth
ApiKeyAuth bearerAuth = (ApiKeyAuth) defaultClient.getAuthentication("bearerAuth");
bearerAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.setApiKeyPrefix("Token");
PeeringApi apiInstance = new PeeringApi();
try {
apiInstance.adminPeeringStopPost();
} catch (ApiException e) {
System.err.println("Exception when calling PeeringApi#adminPeeringStopPost");
e.printStackTrace();
}
Parameters
This endpoint does not need any parameter.
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json