Skip to content

Latest commit

 

History

History
228 lines (176 loc) · 8.13 KB

KeypairApi.md

File metadata and controls

228 lines (176 loc) · 8.13 KB
Raw

KeypairApi

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

Method HTTP request Description
createKeypair POST /CreateKeypair
deleteKeypair POST /DeleteKeypair
readKeypairs POST /ReadKeypairs

createKeypair

CreateKeypairResponse createKeypair(createKeypairRequest)

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

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

    KeypairApi apiInstance = new KeypairApi(defaultClient);
    CreateKeypairRequest createKeypairRequest = new CreateKeypairRequest(); // CreateKeypairRequest | 
    try {
      CreateKeypairResponse result = apiInstance.createKeypair(createKeypairRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling KeypairApi#createKeypair");
      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
createKeypairRequest CreateKeypairRequest [optional]

Return type

CreateKeypairResponse

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). -
409 The HTTP 409 response (Conflict). -
500 The HTTP 500 response (Internal Server Error). -

deleteKeypair

DeleteKeypairResponse deleteKeypair(deleteKeypairRequest)

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

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

    KeypairApi apiInstance = new KeypairApi(defaultClient);
    DeleteKeypairRequest deleteKeypairRequest = new DeleteKeypairRequest(); // DeleteKeypairRequest | 
    try {
      DeleteKeypairResponse result = apiInstance.deleteKeypair(deleteKeypairRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling KeypairApi#deleteKeypair");
      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
deleteKeypairRequest DeleteKeypairRequest [optional]

Return type

DeleteKeypairResponse

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). -

readKeypairs

ReadKeypairsResponse readKeypairs(readKeypairsRequest)

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

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

    KeypairApi apiInstance = new KeypairApi(defaultClient);
    ReadKeypairsRequest readKeypairsRequest = new ReadKeypairsRequest(); // ReadKeypairsRequest | 
    try {
      ReadKeypairsResponse result = apiInstance.readKeypairs(readKeypairsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling KeypairApi#readKeypairs");
      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
readKeypairsRequest ReadKeypairsRequest [optional]

Return type

ReadKeypairsResponse

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). -