CloudApi

All URIs are relative to http://localhost:9000

Method	HTTP request	Description
addCloud	POST /clouds
addVM	POST /vm
deleteCloud	DELETE /clouds/{id}
discoveryStatus	GET /discovery/status
editHardware	PUT /hardware/{id}
editImage	PUT /images/{id}
editLocation	PUT /locations/{id}
findCloud	GET /clouds/{id}
findClouds	GET /clouds
findFunctions	GET /function
findHardware	GET /hardware
findImages	GET /images
findLocations	GET /locations
findVMs	GET /vm
getFunction	GET /function/{id}
getHardware	GET /hardware/{id}
getImage	GET /images/{id}
getLocation	GET /locations/{id}
getVM	GET /vm/{id}

addCloud

Cloud addCloud(cloud)

Creates a new cloud.

Example

// Import classes:
import io.github.cloudiator.rest.ApiClient;
import io.github.cloudiator.rest.ApiException;
import io.github.cloudiator.rest.Configuration;
import io.github.cloudiator.rest.auth.*;
import io.github.cloudiator.rest.models.*;
import io.github.cloudiator.rest.api.CloudApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:9000");
    
    // 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");

    CloudApi apiInstance = new CloudApi(defaultClient);
    NewCloud cloud = new NewCloud(); // NewCloud | Cloud to add
    try {
      Cloud result = apiInstance.addCloud(cloud);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CloudApi#addCloud");
      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
cloud	NewCloud	Cloud to add

Return type

Cloud

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json, code, message,

HTTP response details

Status code	Description	Response headers
201	Created	-
400	Bad Request	-
401	Authorization for this action is missing	-
403	Forbidden action	-
404	Item not found	-
500	An unexpected Error occured	-
504	Service temporary unavailable	-

addVM

Queue addVM(virtualMachineRequest)

Creates a new virtual machine request

Example

// Import classes:
import io.github.cloudiator.rest.ApiClient;
import io.github.cloudiator.rest.ApiException;
import io.github.cloudiator.rest.Configuration;
import io.github.cloudiator.rest.auth.*;
import io.github.cloudiator.rest.models.*;
import io.github.cloudiator.rest.api.CloudApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:9000");
    
    // 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");

    CloudApi apiInstance = new CloudApi(defaultClient);
    VirtualMachineRequest virtualMachineRequest = new VirtualMachineRequest(); // VirtualMachineRequest | VirtualMachine Request
    try {
      Queue result = apiInstance.addVM(virtualMachineRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CloudApi#addVM");
      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
virtualMachineRequest	VirtualMachineRequest	VirtualMachine Request

Return type

Queue

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json, code, message,

HTTP response details

Status code	Description	Response headers
202	ACCEPTED	-
400	Bad Request	-
401	Authorization for this action is missing	-
403	Forbidden action	-
404	Item not found	-
500	An unexpected Error occured	-
504	Server temporary not available	-

deleteCloud

deleteCloud(id)

Deletes the cloud identified by the given id paramater.

Example

// Import classes:
import io.github.cloudiator.rest.ApiClient;
import io.github.cloudiator.rest.ApiException;
import io.github.cloudiator.rest.Configuration;
import io.github.cloudiator.rest.auth.*;
import io.github.cloudiator.rest.models.*;
import io.github.cloudiator.rest.api.CloudApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:9000");
    
    // 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");

    CloudApi apiInstance = new CloudApi(defaultClient);
    String id = "id_example"; // String | Unique identifier of the resource
    try {
      apiInstance.deleteCloud(id);
    } catch (ApiException e) {
      System.err.println("Exception when calling CloudApi#deleteCloud");
      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
id	String	Unique identifier of the resource

Return type

null (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, code, message

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Authorization for this action is missing	-
403	Forbidden action	-
404	Item not found	-
500	An unexpected Error occured	-
504	Server temporary not available	-

discoveryStatus

Map<String, String> discoveryStatus()

Gets the status of the discovery engine

Example

// Import classes:
import io.github.cloudiator.rest.ApiClient;
import io.github.cloudiator.rest.ApiException;
import io.github.cloudiator.rest.Configuration;
import io.github.cloudiator.rest.auth.*;
import io.github.cloudiator.rest.models.*;
import io.github.cloudiator.rest.api.CloudApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:9000");
    
    // 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");

    CloudApi apiInstance = new CloudApi(defaultClient);
    try {
      Map<String, String> result = apiInstance.discoveryStatus();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CloudApi#discoveryStatus");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

Map<String, String>

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

editHardware

Hardware editHardware(id, hardware)

Updates a specific hardware

Example

// Import classes:
import io.github.cloudiator.rest.ApiClient;
import io.github.cloudiator.rest.ApiException;
import io.github.cloudiator.rest.Configuration;
import io.github.cloudiator.rest.auth.*;
import io.github.cloudiator.rest.models.*;
import io.github.cloudiator.rest.api.CloudApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:9000");
    
    // 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");

    CloudApi apiInstance = new CloudApi(defaultClient);
    String id = "id_example"; // String | Unique identifier of the resource
    Hardware hardware = new Hardware(); // Hardware | Hardware to update 
    try {
      Hardware result = apiInstance.editHardware(id, hardware);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CloudApi#editHardware");
      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
id	String	Unique identifier of the resource
hardware	Hardware	Hardware to update

Return type

Hardware

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json, code, message,

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Authorization for this action is missing	-
403	Forbidden action	-
404	Item not found	-
500	An unexpected Error occured	-
504	Server temporary not available	-

editImage

Image editImage(id, image)

Updates a specific image

Example

// Import classes:
import io.github.cloudiator.rest.ApiClient;
import io.github.cloudiator.rest.ApiException;
import io.github.cloudiator.rest.Configuration;
import io.github.cloudiator.rest.auth.*;
import io.github.cloudiator.rest.models.*;
import io.github.cloudiator.rest.api.CloudApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:9000");
    
    // 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");

    CloudApi apiInstance = new CloudApi(defaultClient);
    String id = "id_example"; // String | Unique identifier of the resource
    Image image = new Image(); // Image | Image to update 
    try {
      Image result = apiInstance.editImage(id, image);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CloudApi#editImage");
      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
id	String	Unique identifier of the resource
image	Image	Image to update

Return type

Image

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json, code, message,

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Authorization for this action is missing	-
403	Forbidden action	-
404	Item not found	-
500	An unexpected Error occured	-
504	Server temporary not available	-

editLocation

Location editLocation(id, location)

Updates a specific location

Example

// Import classes:
import io.github.cloudiator.rest.ApiClient;
import io.github.cloudiator.rest.ApiException;
import io.github.cloudiator.rest.Configuration;
import io.github.cloudiator.rest.auth.*;
import io.github.cloudiator.rest.models.*;
import io.github.cloudiator.rest.api.CloudApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:9000");
    
    // 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");

    CloudApi apiInstance = new CloudApi(defaultClient);
    String id = "id_example"; // String | Unique identifier of the resource
    Location location = new Location(); // Location | Location to update 
    try {
      Location result = apiInstance.editLocation(id, location);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CloudApi#editLocation");
      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
id	String	Unique identifier of the resource
location	Location	Location to update

Return type

Location

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json, code, message,

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Authorization for this action is missing	-
403	Forbidden action	-
404	Item not found	-
500	An unexpected Error occured	-
504	Server temporary not available	-

findCloud

Cloud findCloud(id)

Returns the cloud identified by the given id parameter

Example

// Import classes:
import io.github.cloudiator.rest.ApiClient;
import io.github.cloudiator.rest.ApiException;
import io.github.cloudiator.rest.Configuration;
import io.github.cloudiator.rest.auth.*;
import io.github.cloudiator.rest.models.*;
import io.github.cloudiator.rest.api.CloudApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:9000");
    
    // 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");

    CloudApi apiInstance = new CloudApi(defaultClient);
    String id = "id_example"; // String | Unique identifier of the resource
    try {
      Cloud result = apiInstance.findCloud(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CloudApi#findCloud");
      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
id	String	Unique identifier of the resource

Return type

Cloud

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, code, message,

HTTP response details

Status code	Description	Response headers
200	The cloud identified by the id	-
401	Authorization for this action is missing	-
403	Forbidden action	-
500	An unexpected Error occured	-
504	Server temporary not available	-

findClouds

List<Cloud> findClouds()

Returns all clouds from the system that the user has access to

Example

// Import classes:
import io.github.cloudiator.rest.ApiClient;
import io.github.cloudiator.rest.ApiException;
import io.github.cloudiator.rest.Configuration;
import io.github.cloudiator.rest.auth.*;
import io.github.cloudiator.rest.models.*;
import io.github.cloudiator.rest.api.CloudApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:9000");
    
    // 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");

    CloudApi apiInstance = new CloudApi(defaultClient);
    try {
      List<Cloud> result = apiInstance.findClouds();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CloudApi#findClouds");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

List<Cloud>

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, code, message,

HTTP response details

Status code	Description	Response headers
200	All clouds	-
401	Authorization for this action is missing	-
403	Forbidden action	-
500	An unexpected Error occured	-
504	Server temporary not available	-

findFunctions

List<Function> findFunctions()

Finds all functions the user has access to

Example

// Import classes:
import io.github.cloudiator.rest.ApiClient;
import io.github.cloudiator.rest.ApiException;
import io.github.cloudiator.rest.Configuration;
import io.github.cloudiator.rest.auth.*;
import io.github.cloudiator.rest.models.*;
import io.github.cloudiator.rest.api.CloudApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:9000");
    
    // 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");

    CloudApi apiInstance = new CloudApi(defaultClient);
    try {
      List<Function> result = apiInstance.findFunctions();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CloudApi#findFunctions");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

List<Function>

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

findHardware

List<Hardware> findHardware(cloudId)

Returns all hardware visible to the user

Example

// Import classes:
import io.github.cloudiator.rest.ApiClient;
import io.github.cloudiator.rest.ApiException;
import io.github.cloudiator.rest.Configuration;
import io.github.cloudiator.rest.auth.*;
import io.github.cloudiator.rest.models.*;
import io.github.cloudiator.rest.api.CloudApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:9000");
    
    // 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");

    CloudApi apiInstance = new CloudApi(defaultClient);
    String cloudId = "cloudId_example"; // String | (Optional) Unique identifier to filter a specific cloud
    try {
      List<Hardware> result = apiInstance.findHardware(cloudId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CloudApi#findHardware");
      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
cloudId	String	(Optional) Unique identifier to filter a specific cloud	[optional]

Return type

List<Hardware>

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, code, message,

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Authorization for this action is missing	-
403	Forbidden action	-
500	An unexpected Error occured	-
504	Server temporary not available	-

findImages

List<Image> findImages(cloudId)

Returns all images visable to the user

Example

// Import classes:
import io.github.cloudiator.rest.ApiClient;
import io.github.cloudiator.rest.ApiException;
import io.github.cloudiator.rest.Configuration;
import io.github.cloudiator.rest.auth.*;
import io.github.cloudiator.rest.models.*;
import io.github.cloudiator.rest.api.CloudApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:9000");
    
    // 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");

    CloudApi apiInstance = new CloudApi(defaultClient);
    String cloudId = "cloudId_example"; // String | (Optional) Unique identifier to filter a specific cloud
    try {
      List<Image> result = apiInstance.findImages(cloudId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CloudApi#findImages");
      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
cloudId	String	(Optional) Unique identifier to filter a specific cloud	[optional]

Return type

List<Image>

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, code, message,

HTTP response details

Status code	Description	Response headers
200	All images	-
401	Authorization for this action is missing	-
403	Forbidden action	-
500	An unexpected Error occured	-
504	Server temporary not available	-

findLocations

List<Location> findLocations(cloudId)

Returns all locations visible to the user

Example

// Import classes:
import io.github.cloudiator.rest.ApiClient;
import io.github.cloudiator.rest.ApiException;
import io.github.cloudiator.rest.Configuration;
import io.github.cloudiator.rest.auth.*;
import io.github.cloudiator.rest.models.*;
import io.github.cloudiator.rest.api.CloudApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:9000");
    
    // 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");

    CloudApi apiInstance = new CloudApi(defaultClient);
    String cloudId = "cloudId_example"; // String | (Optional) Unique identifier to filter a specific cloud
    try {
      List<Location> result = apiInstance.findLocations(cloudId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CloudApi#findLocations");
      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
cloudId	String	(Optional) Unique identifier to filter a specific cloud	[optional]

Return type

List<Location>

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json, code, message,

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Authorization for this action is missing	-
403	Forbidden action	-
500	An unexpected Error occured	-
504	Server temporary not available	-

findVMs

List<VirtualMachine> findVMs(cloudId)

Finds all virtual machines the user has access to

Example

// Import classes:
import io.github.cloudiator.rest.ApiClient;
import io.github.cloudiator.rest.ApiException;
import io.github.cloudiator.rest.Configuration;
import io.github.cloudiator.rest.auth.*;
import io.github.cloudiator.rest.models.*;
import io.github.cloudiator.rest.api.CloudApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:9000");
    
    // 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");

    CloudApi apiInstance = new CloudApi(defaultClient);
    String cloudId = "cloudId_example"; // String | (Optional) Unique identifier to filter a specific cloud
    try {
      List<VirtualMachine> result = apiInstance.findVMs(cloudId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CloudApi#findVMs");
      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
cloudId	String	(Optional) Unique identifier to filter a specific cloud	[optional]

Return type

List<VirtualMachine>

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

getFunction

Function getFunction(id)

Finds the function identified by the given id parameter

Example

// Import classes:
import io.github.cloudiator.rest.ApiClient;
import io.github.cloudiator.rest.ApiException;
import io.github.cloudiator.rest.Configuration;
import io.github.cloudiator.rest.auth.*;
import io.github.cloudiator.rest.models.*;
import io.github.cloudiator.rest.api.CloudApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:9000");
    
    // 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");

    CloudApi apiInstance = new CloudApi(defaultClient);
    String id = "id_example"; // String | Unique identifier of the resource
    try {
      Function result = apiInstance.getFunction(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CloudApi#getFunction");
      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
id	String	Unique identifier of the resource

Return type

Function

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

getHardware

Hardware getHardware(id)

Retrieves the hardware with the given id.

Example

// Import classes:
import io.github.cloudiator.rest.ApiClient;
import io.github.cloudiator.rest.ApiException;
import io.github.cloudiator.rest.Configuration;
import io.github.cloudiator.rest.auth.*;
import io.github.cloudiator.rest.models.*;
import io.github.cloudiator.rest.api.CloudApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:9000");
    
    // 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");

    CloudApi apiInstance = new CloudApi(defaultClient);
    String id = "id_example"; // String | Unique identifier of the resource
    try {
      Hardware result = apiInstance.getHardware(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CloudApi#getHardware");
      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
id	String	Unique identifier of the resource

Return type

Hardware

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

getImage

Image getImage(id)

Retrieves the image with the given id.

Example

// Import classes:
import io.github.cloudiator.rest.ApiClient;
import io.github.cloudiator.rest.ApiException;
import io.github.cloudiator.rest.Configuration;
import io.github.cloudiator.rest.auth.*;
import io.github.cloudiator.rest.models.*;
import io.github.cloudiator.rest.api.CloudApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:9000");
    
    // 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");

    CloudApi apiInstance = new CloudApi(defaultClient);
    String id = "id_example"; // String | Unique identifier of the resource
    try {
      Image result = apiInstance.getImage(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CloudApi#getImage");
      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
id	String	Unique identifier of the resource

Return type

Image

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

getLocation

Location getLocation(id)

Retrieves the location with the given id.

Example

// Import classes:
import io.github.cloudiator.rest.ApiClient;
import io.github.cloudiator.rest.ApiException;
import io.github.cloudiator.rest.Configuration;
import io.github.cloudiator.rest.auth.*;
import io.github.cloudiator.rest.models.*;
import io.github.cloudiator.rest.api.CloudApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:9000");
    
    // 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");

    CloudApi apiInstance = new CloudApi(defaultClient);
    String id = "id_example"; // String | Unique identifier of the resource
    try {
      Location result = apiInstance.getLocation(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CloudApi#getLocation");
      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
id	String	Unique identifier of the resource

Return type

Location

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

getVM

VirtualMachine getVM(id)

Finds the virtual machine identified by the given id parameter

Example

// Import classes:
import io.github.cloudiator.rest.ApiClient;
import io.github.cloudiator.rest.ApiException;
import io.github.cloudiator.rest.Configuration;
import io.github.cloudiator.rest.auth.*;
import io.github.cloudiator.rest.models.*;
import io.github.cloudiator.rest.api.CloudApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost:9000");
    
    // 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");

    CloudApi apiInstance = new CloudApi(defaultClient);
    String id = "id_example"; // String | Unique identifier of the resource
    try {
      VirtualMachine result = apiInstance.getVM(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CloudApi#getVM");
      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
id	String	Unique identifier of the resource

Return type

VirtualMachine

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

Files

CloudApi.md

Latest commit

History

CloudApi.md

File metadata and controls

CloudApi

addCloud

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

addVM

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteCloud

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

discoveryStatus

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

editHardware

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

editImage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

editLocation

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

findCloud

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

findClouds

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

findFunctions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

findHardware

Example

Parameters