DefaultApi
DefaultApi
All URIs are relative to https://api.ionos.com/cloudapi/v6
apiInfoGet
Info apiInfoGet(pretty, depth, xContractNumber)
Get API information
Retrieves the API information such as API version.
Parameters
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional] [default to true]
depth
Integer
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
[optional] [default to 0]
xContractNumber
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]
orderBy
String
Sorts the results alphanumerically in ascending order based on the specified property.
[optional]
maxResults
Integer
Limits the number of results returned.
[optional]
filters
Map<String, String>
Limit results to those containing a matching value for a specific property.
[optional]
Return type
HTTP request headers
Content-Type: Not defined
Accept: application/json
⚠️ Note: the example bellow uses the apiInfoGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use apiInfoGet instead
Example
// Import classes:
import com.ionoscloud.ApiClient;
import com.ionoscloud.ApiException;
import com.ionoscloud.ApiResponse;
import com.ionoscloud.Configuration;
import com.ionoscloud.model.*;
import com.ionoscloud.api.DefaultApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
DefaultApi apiInstance = new DefaultApi(defaultClient);
Boolean pretty = true; // Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
Integer depth = 0; // Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) are not included. - depth=1: Direct properties and children references are included. - depth=2: Direct properties and children properties are included. - depth=3: Direct properties and children properties and children's children are included. - depth=... and so on
Integer xContractNumber = 56; // Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
String orderBy = "orderBy_example"; // String | Order by field
Integer maxResults = "maxResults_example"; // Integer | Maximum number of results to return
Map<String, String> filters = new HashMap<String, String>(); // Map<String, String> | Filter results by field
try {
ApiResponse<Info> result = apiInstance.apiInfoGetWithHttpInfo(pretty, depth, xContractNumber, orderBy, maxResults, filters);
System.out.println("Response: " + result.getData());
System.out.println("Status Code: " + result.getStatusCode());
System.out.println("Headers: " + result.getHeaders());
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#apiInfoGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
⚠️ Note: for the example above, you need to provide all parameters to the method call. Null values will resolve to the API defaults.
For convenience, you can alternatively use a builder, which allows to omit optional parameters:
try {
Info result = apiInstance.apiInfoGet()
.pretty(true)
.depth(0)
.xContractNumber(56)
.orderBy("orderBy_example")
.maxResults(5)
.filters(filters)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#apiInfoGet");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
Last updated