PlatformApi

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

Method	HTTP request	Description
addPlatform	POST /platform
addPlatformEnvironment	POST /platformEnvironment
addPlatformHardware	POST /platformHardware
addPlatformRuntime	POST /platformRuntime
deletePlatform	DELETE /platform/{id}
findPlatform	GET /platform/{id}
findPlatformEnvironment	GET /platformEnvironment/{id}
findPlatformEnvironments	GET /platformEnvironment
findPlatformHardware	GET /platformHardware/{id}
findPlatformHardwares	GET /platformHardware
findPlatformRuntime	GET /platformRuntime/{id}
findPlatformRuntimes	GET /platformRuntime
findPlatforms	GET /platform

addPlatform

Platform addPlatform(platform)

Creates a new platform.

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

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

    PlatformApi apiInstance = new PlatformApi(defaultClient);
    NewPlatform platform = new NewPlatform(); // NewPlatform | Platform to add
    try {
      Platform result = apiInstance.addPlatform(platform);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PlatformApi#addPlatform");
      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
platform	NewPlatform	Platform to add

Return type

Platform

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	-

addPlatformEnvironment

PlatformEnvironment addPlatformEnvironment(platformEnvironment)

Creates a new PlatformEnvironment

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

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

    PlatformApi apiInstance = new PlatformApi(defaultClient);
    NewPlatformEnvironment platformEnvironment = new NewPlatformEnvironment(); // NewPlatformEnvironment | PlatformEnvironment to be created 
    try {
      PlatformEnvironment result = apiInstance.addPlatformEnvironment(platformEnvironment);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PlatformApi#addPlatformEnvironment");
      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
platformEnvironment	NewPlatformEnvironment	PlatformEnvironment to be created

Return type

PlatformEnvironment

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	-

addPlatformHardware

PlatformHardware addPlatformHardware(platformHardware)

Creates a new PlatformHardware

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

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

    PlatformApi apiInstance = new PlatformApi(defaultClient);
    NewPlatformHardware platformHardware = new NewPlatformHardware(); // NewPlatformHardware | PlatformHardware to be created 
    try {
      PlatformHardware result = apiInstance.addPlatformHardware(platformHardware);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PlatformApi#addPlatformHardware");
      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
platformHardware	NewPlatformHardware	PlatformHardware to be created

Return type

PlatformHardware

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	-

addPlatformRuntime

PlatformRuntime addPlatformRuntime(platformRuntime)

Creates a new PlatformRuntime

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

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

    PlatformApi apiInstance = new PlatformApi(defaultClient);
    NewPlatformRuntime platformRuntime = new NewPlatformRuntime(); // NewPlatformRuntime | PlatformRuntime to be created 
    try {
      PlatformRuntime result = apiInstance.addPlatformRuntime(platformRuntime);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PlatformApi#addPlatformRuntime");
      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
platformRuntime	NewPlatformRuntime	PlatformRuntime to be created

Return type

PlatformRuntime

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	-

deletePlatform

deletePlatform(id)

Deletes the platform 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.PlatformApi;

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

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

findPlatform

Platform findPlatform(id)

Returns the platform 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.PlatformApi;

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

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

Platform

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

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

findPlatformEnvironment

PlatformEnvironment findPlatformEnvironment(id)

Returns the PlatformEnvironment identified by the 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.PlatformApi;

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

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

PlatformEnvironment

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	-

findPlatformEnvironments

List<PlatformEnvironment> findPlatformEnvironments()

Returns all platform environment 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.PlatformApi;

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

    PlatformApi apiInstance = new PlatformApi(defaultClient);
    try {
      List<PlatformEnvironment> result = apiInstance.findPlatformEnvironments();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PlatformApi#findPlatformEnvironments");
      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<PlatformEnvironment>

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	-

findPlatformHardware

PlatformHardware findPlatformHardware(id)

Returns the PlatformHardware identified by the 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.PlatformApi;

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

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

PlatformHardware

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	-

findPlatformHardwares

List<PlatformHardware> findPlatformHardwares()

Returns all platform 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.PlatformApi;

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

    PlatformApi apiInstance = new PlatformApi(defaultClient);
    try {
      List<PlatformHardware> result = apiInstance.findPlatformHardwares();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PlatformApi#findPlatformHardwares");
      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<PlatformHardware>

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	-

findPlatformRuntime

PlatformRuntime findPlatformRuntime(id)

Returns the PlatformRuntime identified by the 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.PlatformApi;

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

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

PlatformRuntime

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	-

findPlatformRuntimes

List<PlatformRuntime> findPlatformRuntimes()

Returns all platform runtime 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.PlatformApi;

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

    PlatformApi apiInstance = new PlatformApi(defaultClient);
    try {
      List<PlatformRuntime> result = apiInstance.findPlatformRuntimes();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PlatformApi#findPlatformRuntimes");
      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<PlatformRuntime>

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	-

findPlatforms

List<Platform> findPlatforms()

Returns all platform 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.PlatformApi;

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

    PlatformApi apiInstance = new PlatformApi(defaultClient);
    try {
      List<Platform> result = apiInstance.findPlatforms();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling PlatformApi#findPlatforms");
      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<Platform>

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

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

Files

PlatformApi.md

Latest commit

History

PlatformApi.md

File metadata and controls

PlatformApi

addPlatform

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

addPlatformEnvironment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

addPlatformHardware

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

addPlatformRuntime

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deletePlatform

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

findPlatform

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

findPlatformEnvironment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

findPlatformEnvironments

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

findPlatformHardware

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

findPlatformHardwares

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

findPlatformRuntime

Example

Parameters