VpnConnectionApi

All URIs are relative to https://api.eu-west-2.outscale.com/api/v1

Method	HTTP request	Description
createVpnConnection	POST /CreateVpnConnection
createVpnConnectionRoute	POST /CreateVpnConnectionRoute
deleteVpnConnection	POST /DeleteVpnConnection
deleteVpnConnectionRoute	POST /DeleteVpnConnectionRoute
readVpnConnections	POST /ReadVpnConnections
updateVpnConnection	POST /UpdateVpnConnection

createVpnConnection

CreateVpnConnectionResponse createVpnConnection(createVpnConnectionRequest)

Example

// Import classes:
import io.github.outscale.osc_sdk_java.client.ApiClient;
import io.github.outscale.osc_sdk_java.client.ApiException;
import io.github.outscale.osc_sdk_java.client.Configuration;
import io.github.outscale.osc_sdk_java.client.auth.*;
import io.github.outscale.osc_sdk_java.client.models.*;
import io.github.outscale.osc_sdk_java.client.api.VpnConnectionApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.eu-west-2.outscale.com/api/v1");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    VpnConnectionApi apiInstance = new VpnConnectionApi(defaultClient);
    CreateVpnConnectionRequest createVpnConnectionRequest = new CreateVpnConnectionRequest(); // CreateVpnConnectionRequest | 
    try {
      CreateVpnConnectionResponse result = apiInstance.createVpnConnection(createVpnConnectionRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VpnConnectionApi#createVpnConnection");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
createVpnConnectionRequest	CreateVpnConnectionRequest		[optional]

Return type

CreateVpnConnectionResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The HTTP 200 response (OK).	-

createVpnConnectionRoute

CreateVpnConnectionRouteResponse createVpnConnectionRoute(createVpnConnectionRouteRequest)

Example

// Import classes:
import io.github.outscale.osc_sdk_java.client.ApiClient;
import io.github.outscale.osc_sdk_java.client.ApiException;
import io.github.outscale.osc_sdk_java.client.Configuration;
import io.github.outscale.osc_sdk_java.client.auth.*;
import io.github.outscale.osc_sdk_java.client.models.*;
import io.github.outscale.osc_sdk_java.client.api.VpnConnectionApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.eu-west-2.outscale.com/api/v1");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    VpnConnectionApi apiInstance = new VpnConnectionApi(defaultClient);
    CreateVpnConnectionRouteRequest createVpnConnectionRouteRequest = new CreateVpnConnectionRouteRequest(); // CreateVpnConnectionRouteRequest | 
    try {
      CreateVpnConnectionRouteResponse result = apiInstance.createVpnConnectionRoute(createVpnConnectionRouteRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VpnConnectionApi#createVpnConnectionRoute");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
createVpnConnectionRouteRequest	CreateVpnConnectionRouteRequest		[optional]

Return type

CreateVpnConnectionRouteResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The HTTP 200 response (OK).	-

deleteVpnConnection

DeleteVpnConnectionResponse deleteVpnConnection(deleteVpnConnectionRequest)

Example

// Import classes:
import io.github.outscale.osc_sdk_java.client.ApiClient;
import io.github.outscale.osc_sdk_java.client.ApiException;
import io.github.outscale.osc_sdk_java.client.Configuration;
import io.github.outscale.osc_sdk_java.client.auth.*;
import io.github.outscale.osc_sdk_java.client.models.*;
import io.github.outscale.osc_sdk_java.client.api.VpnConnectionApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.eu-west-2.outscale.com/api/v1");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    VpnConnectionApi apiInstance = new VpnConnectionApi(defaultClient);
    DeleteVpnConnectionRequest deleteVpnConnectionRequest = new DeleteVpnConnectionRequest(); // DeleteVpnConnectionRequest | 
    try {
      DeleteVpnConnectionResponse result = apiInstance.deleteVpnConnection(deleteVpnConnectionRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VpnConnectionApi#deleteVpnConnection");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
deleteVpnConnectionRequest	DeleteVpnConnectionRequest		[optional]

Return type

DeleteVpnConnectionResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The HTTP 200 response (OK).	-

deleteVpnConnectionRoute

DeleteVpnConnectionRouteResponse deleteVpnConnectionRoute(deleteVpnConnectionRouteRequest)

Example

// Import classes:
import io.github.outscale.osc_sdk_java.client.ApiClient;
import io.github.outscale.osc_sdk_java.client.ApiException;
import io.github.outscale.osc_sdk_java.client.Configuration;
import io.github.outscale.osc_sdk_java.client.auth.*;
import io.github.outscale.osc_sdk_java.client.models.*;
import io.github.outscale.osc_sdk_java.client.api.VpnConnectionApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.eu-west-2.outscale.com/api/v1");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    VpnConnectionApi apiInstance = new VpnConnectionApi(defaultClient);
    DeleteVpnConnectionRouteRequest deleteVpnConnectionRouteRequest = new DeleteVpnConnectionRouteRequest(); // DeleteVpnConnectionRouteRequest | 
    try {
      DeleteVpnConnectionRouteResponse result = apiInstance.deleteVpnConnectionRoute(deleteVpnConnectionRouteRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VpnConnectionApi#deleteVpnConnectionRoute");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
deleteVpnConnectionRouteRequest	DeleteVpnConnectionRouteRequest		[optional]

Return type

DeleteVpnConnectionRouteResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The HTTP 200 response (OK).	-

readVpnConnections

ReadVpnConnectionsResponse readVpnConnections(readVpnConnectionsRequest)

Example

// Import classes:
import io.github.outscale.osc_sdk_java.client.ApiClient;
import io.github.outscale.osc_sdk_java.client.ApiException;
import io.github.outscale.osc_sdk_java.client.Configuration;
import io.github.outscale.osc_sdk_java.client.auth.*;
import io.github.outscale.osc_sdk_java.client.models.*;
import io.github.outscale.osc_sdk_java.client.api.VpnConnectionApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.eu-west-2.outscale.com/api/v1");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    VpnConnectionApi apiInstance = new VpnConnectionApi(defaultClient);
    ReadVpnConnectionsRequest readVpnConnectionsRequest = new ReadVpnConnectionsRequest(); // ReadVpnConnectionsRequest | 
    try {
      ReadVpnConnectionsResponse result = apiInstance.readVpnConnections(readVpnConnectionsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VpnConnectionApi#readVpnConnections");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
readVpnConnectionsRequest	ReadVpnConnectionsRequest		[optional]

Return type

ReadVpnConnectionsResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The HTTP 200 response (OK).	-

updateVpnConnection

UpdateVpnConnectionResponse updateVpnConnection(updateVpnConnectionRequest)

Example

// Import classes:
import io.github.outscale.osc_sdk_java.client.ApiClient;
import io.github.outscale.osc_sdk_java.client.ApiException;
import io.github.outscale.osc_sdk_java.client.Configuration;
import io.github.outscale.osc_sdk_java.client.auth.*;
import io.github.outscale.osc_sdk_java.client.models.*;
import io.github.outscale.osc_sdk_java.client.api.VpnConnectionApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.eu-west-2.outscale.com/api/v1");
    // Configure AWS Signature V4 authorization
    defaultClient.setAWS4Configuration("YOUR_ACCESS_KEY", "YOUR_SECRET_KEY", "REGION", "SERVICE")
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    VpnConnectionApi apiInstance = new VpnConnectionApi(defaultClient);
    UpdateVpnConnectionRequest updateVpnConnectionRequest = new UpdateVpnConnectionRequest(); // UpdateVpnConnectionRequest | 
    try {
      UpdateVpnConnectionResponse result = apiInstance.updateVpnConnection(updateVpnConnectionRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VpnConnectionApi#updateVpnConnection");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
updateVpnConnectionRequest	UpdateVpnConnectionRequest		[optional]

Return type

UpdateVpnConnectionResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The HTTP 200 response (OK).	-
400	The HTTP 400 response (Bad Request).	-
401	The HTTP 401 response (Unauthorized).	-
500	The HTTP 500 response (Internal Server Error).	-

Files

VpnConnectionApi.md

Latest commit

History

VpnConnectionApi.md

File metadata and controls

VpnConnectionApi

createVpnConnection

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createVpnConnectionRoute

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteVpnConnection

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteVpnConnectionRoute

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

readVpnConnections

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateVpnConnection

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details