AdminApi

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
adminSystemConfigGet	GET /admin/system/config	Get systems(estuary/shuttle) config
adminUsersGet	GET /admin/users	Get all users

# **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.AdminApi;

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");

AdminApi apiInstance = new AdminApi();
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 AdminApi#adminPeeringPeersDelete");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
body	List<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.AdminApi;

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");

AdminApi apiInstance = new AdminApi();
try {
    apiInstance.adminPeeringPeersGet();
} catch (ApiException e) {
    System.err.println("Exception when calling AdminApi#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.AdminApi;

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");

AdminApi apiInstance = new AdminApi();
try {
    apiInstance.adminPeeringPeersPost();
} catch (ApiException e) {
    System.err.println("Exception when calling AdminApi#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.AdminApi;

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");

AdminApi apiInstance = new AdminApi();
try {
    apiInstance.adminPeeringStartPost();
} catch (ApiException e) {
    System.err.println("Exception when calling AdminApi#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.AdminApi;

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");

AdminApi apiInstance = new AdminApi();
try {
    apiInstance.adminPeeringStatusGet();
} catch (ApiException e) {
    System.err.println("Exception when calling AdminApi#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.AdminApi;

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");

AdminApi apiInstance = new AdminApi();
try {
    apiInstance.adminPeeringStopPost();
} catch (ApiException e) {
    System.err.println("Exception when calling AdminApi#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

# **adminSystemConfigGet** > adminSystemConfigGet()

Get systems(estuary/shuttle) config

This endpoint is used to get system configs.

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.AdminApi;

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");

AdminApi apiInstance = new AdminApi();
try {
    apiInstance.adminSystemConfigGet();
} catch (ApiException e) {
    System.err.println("Exception when calling AdminApi#adminSystemConfigGet");
    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

# **adminUsersGet** > adminUsersGet()

Get all users

This endpoint is used to get all users.

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.AdminApi;

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");

AdminApi apiInstance = new AdminApi();
try {
    apiInstance.adminUsersGet();
} catch (ApiException e) {
    System.err.println("Exception when calling AdminApi#adminUsersGet");
    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