Skip to main content

PeeringApi

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
# **adminPeeringPeersDelete** > adminPeeringPeersDelete(body)

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

NameTypeDescriptionNotes
bodyList<String>Peer ids

Return type

null (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json
# **adminPeeringPeersGet** > adminPeeringPeersGet()

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

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json
# **adminPeeringPeersPost** > adminPeeringPeersPost()

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

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json
# **adminPeeringStartPost** > adminPeeringStartPost()

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

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json
# **adminPeeringStatusGet** > adminPeeringStatusGet()

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

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json
# **adminPeeringStopPost** > adminPeeringStopPost()

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

bearerAuth

HTTP request headers

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