VmApi

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

Method	HTTP request	Description
createVms	POST /CreateVms
deleteVms	POST /DeleteVms
readAdminPassword	POST /ReadAdminPassword
readConsoleOutput	POST /ReadConsoleOutput
readVmTypes	POST /ReadVmTypes
readVms	POST /ReadVms
readVmsState	POST /ReadVmsState
rebootVms	POST /RebootVms
startVms	POST /StartVms
stopVms	POST /StopVms
updateVm	POST /UpdateVm

createVms

CreateVmsResponse createVms(createVmsRequest)

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

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

    VmApi apiInstance = new VmApi(defaultClient);
    CreateVmsRequest createVmsRequest = new CreateVmsRequest(); // CreateVmsRequest | 
    try {
      CreateVmsResponse result = apiInstance.createVms(createVmsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VmApi#createVms");
      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
createVmsRequest	CreateVmsRequest		[optional]

Return type

CreateVmsResponse

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

deleteVms

DeleteVmsResponse deleteVms(deleteVmsRequest)

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

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

    VmApi apiInstance = new VmApi(defaultClient);
    DeleteVmsRequest deleteVmsRequest = new DeleteVmsRequest(); // DeleteVmsRequest | 
    try {
      DeleteVmsResponse result = apiInstance.deleteVms(deleteVmsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VmApi#deleteVms");
      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
deleteVmsRequest	DeleteVmsRequest		[optional]

Return type

DeleteVmsResponse

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

readAdminPassword

ReadAdminPasswordResponse readAdminPassword(readAdminPasswordRequest)

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

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

    VmApi apiInstance = new VmApi(defaultClient);
    ReadAdminPasswordRequest readAdminPasswordRequest = new ReadAdminPasswordRequest(); // ReadAdminPasswordRequest | 
    try {
      ReadAdminPasswordResponse result = apiInstance.readAdminPassword(readAdminPasswordRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VmApi#readAdminPassword");
      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
readAdminPasswordRequest	ReadAdminPasswordRequest		[optional]

Return type

ReadAdminPasswordResponse

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

readConsoleOutput

ReadConsoleOutputResponse readConsoleOutput(readConsoleOutputRequest)

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

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

    VmApi apiInstance = new VmApi(defaultClient);
    ReadConsoleOutputRequest readConsoleOutputRequest = new ReadConsoleOutputRequest(); // ReadConsoleOutputRequest | 
    try {
      ReadConsoleOutputResponse result = apiInstance.readConsoleOutput(readConsoleOutputRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VmApi#readConsoleOutput");
      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
readConsoleOutputRequest	ReadConsoleOutputRequest		[optional]

Return type

ReadConsoleOutputResponse

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

readVmTypes

ReadVmTypesResponse readVmTypes(readVmTypesRequest)

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.models.*;
import io.github.outscale.osc_sdk_java.client.api.VmApi;

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

    VmApi apiInstance = new VmApi(defaultClient);
    ReadVmTypesRequest readVmTypesRequest = new ReadVmTypesRequest(); // ReadVmTypesRequest | 
    try {
      ReadVmTypesResponse result = apiInstance.readVmTypes(readVmTypesRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VmApi#readVmTypes");
      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
readVmTypesRequest	ReadVmTypesRequest		[optional]

Return type

ReadVmTypesResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

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

readVms

ReadVmsResponse readVms(readVmsRequest)

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

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

    VmApi apiInstance = new VmApi(defaultClient);
    ReadVmsRequest readVmsRequest = new ReadVmsRequest(); // ReadVmsRequest | 
    try {
      ReadVmsResponse result = apiInstance.readVms(readVmsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VmApi#readVms");
      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
readVmsRequest	ReadVmsRequest		[optional]

Return type

ReadVmsResponse

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

readVmsState

ReadVmsStateResponse readVmsState(readVmsStateRequest)

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

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

    VmApi apiInstance = new VmApi(defaultClient);
    ReadVmsStateRequest readVmsStateRequest = new ReadVmsStateRequest(); // ReadVmsStateRequest | 
    try {
      ReadVmsStateResponse result = apiInstance.readVmsState(readVmsStateRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VmApi#readVmsState");
      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
readVmsStateRequest	ReadVmsStateRequest		[optional]

Return type

ReadVmsStateResponse

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

rebootVms

RebootVmsResponse rebootVms(rebootVmsRequest)

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

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

    VmApi apiInstance = new VmApi(defaultClient);
    RebootVmsRequest rebootVmsRequest = new RebootVmsRequest(); // RebootVmsRequest | 
    try {
      RebootVmsResponse result = apiInstance.rebootVms(rebootVmsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VmApi#rebootVms");
      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
rebootVmsRequest	RebootVmsRequest		[optional]

Return type

RebootVmsResponse

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

startVms

StartVmsResponse startVms(startVmsRequest)

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

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

    VmApi apiInstance = new VmApi(defaultClient);
    StartVmsRequest startVmsRequest = new StartVmsRequest(); // StartVmsRequest | 
    try {
      StartVmsResponse result = apiInstance.startVms(startVmsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VmApi#startVms");
      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
startVmsRequest	StartVmsRequest		[optional]

Return type

StartVmsResponse

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

stopVms

StopVmsResponse stopVms(stopVmsRequest)

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

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

    VmApi apiInstance = new VmApi(defaultClient);
    StopVmsRequest stopVmsRequest = new StopVmsRequest(); // StopVmsRequest | 
    try {
      StopVmsResponse result = apiInstance.stopVms(stopVmsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VmApi#stopVms");
      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
stopVmsRequest	StopVmsRequest		[optional]

Return type

StopVmsResponse

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

updateVm

UpdateVmResponse updateVm(updateVmRequest)

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

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

    VmApi apiInstance = new VmApi(defaultClient);
    UpdateVmRequest updateVmRequest = new UpdateVmRequest(); // UpdateVmRequest | 
    try {
      UpdateVmResponse result = apiInstance.updateVm(updateVmRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VmApi#updateVm");
      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
updateVmRequest	UpdateVmRequest		[optional]

Return type

UpdateVmResponse

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

VmApi.md

Latest commit

History

VmApi.md

File metadata and controls

VmApi

createVms

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteVms

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

readAdminPassword

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

readConsoleOutput

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

readVmTypes

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

readVms

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

readVmsState

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

rebootVms

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

startVms

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

stopVms

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateVm

Example

Parameters