# RequestsApi ## RequestsApi All URIs are relative to ** | Method | HTTP request | Description | | ------------------------------------------- | ------------------------------------ | ----------------------- | | [**requestsFindById**](#requestsfindbyid) | **GET** /requests/{requestId} | Retrieve requests | | [**requestsGet**](#requestsget) | **GET** /requests | List requests | | [**requestsStatusGet**](#requestsstatusget) | **GET** /requests/{requestId}/status | Retrieve request status | ## **requestsFindById** > Request requestsFindById(requestId, pretty, depth, xContractNumber) Retrieve requests Retrieve the properties of the specified request. #### Parameters | Name | Type | Description | Notes | | ------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **requestId** | **String** | The unique ID of the request. | | | **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] | #### Return type [**Request**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/request) #### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ⚠️ **Note**: the example bellow uses the requestsFindByIdWithHttpInfo which also returns the status code and the headers, if you don't need them you may use requestsFindById instead #### Example ```java // Import classes: import com.ionoscloud.ApiClient; import com.ionoscloud.ApiException; import com.ionoscloud.ApiResponse; import com.ionoscloud.Configuration; import com.ionoscloud.auth.*; import com.ionoscloud.model.*; import com.ionoscloud.api.RequestsApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure HTTP basic authorization: Basic Authentication HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication"); basicAuthentication.setUsername("YOUR USERNAME"); basicAuthentication.setPassword("YOUR PASSWORD"); // Configure Api Key authorization: Token Authentication defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN"); RequestsApi apiInstance = new RequestsApi(defaultClient); String requestId = "requestId_example"; // String | The unique ID of the request. 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. try { ApiResponse result = apiInstance.requestsFindByIdWithHttpInfo(requestId, pretty, depth, xContractNumber); 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 RequestsApi#requestsFindById"); 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: ```java try { Request result = apiInstance.requestsFindById(requestId) .pretty(true) .depth(0) .xContractNumber(56) .execute(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RequestsApi#requestsFindById"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } ``` ## **requestsGet** > Requests requestsGet(pretty, depth, xContractNumber, filterStatus, filterCreatedAfter, filterCreatedBefore, filterCreatedDate, filterCreatedBy, filterEtag, filterRequestStatus, filterMethod, filterHeaders, filterBody, filterUrl, offset, limit) List requests List all API requests. #### Parameters | Name | Type | Description | Notes | | ----------------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **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] | | **filterStatus** | **String** | Filter the list by request status \[QUEUED, RUNNING, DONE, FAILED]. Filter is not affected by the depth query parameter. | \[optional] | | **filterCreatedAfter** | **String** | Filter the list to only include the requests created after the date, specified in the yyyy-MM-dd HH:mm:ss format. Filter is not affected by the depth query parameter. | \[optional] | | **filterCreatedBefore** | **String** | Filter the list to only include the requests created before the date, specified in the yyyy-MM-dd HH:mm:ss format. Filter is not affected by the depth query parameter. | \[optional] | | **filterCreatedDate** | **String** | Filter the list to only include the requests that contain the createdDate, specified in the yyyy-MM-dd HH:mm:ss format. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. | \[optional] | | **filterCreatedBy** | **String** | Filter the list to only include the requests that contain the createdBy, specified in the yyyy-MM-dd HH:mm:ss format. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. | \[optional] | | **filterEtag** | **String** | Filter the list to only include the requests that contain the specified etag. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. | \[optional] | | **filterRequestStatus** | **String** | Filter the list to only include the requests that contain the specified requestStatus. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. | \[optional] | | **filterMethod** | **String** | Filter the list to only include the requests that contain the specified method. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. | \[optional] | | **filterHeaders** | **String** | Filter the list to only include the requests that contain the specified headers. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. | \[optional] | | **filterBody** | **String** | Filter the list to only include the requests that contain the specified body. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. | \[optional] | | **filterUrl** | **String** | Filter the list to only include the requests that contain the specified URL. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. | \[optional] | | **offset** | **Integer** | The first element (from the complete list of the elements) to include in the response (used together with \\limit\\ for pagination). | \[optional] \[default to 0] | | **limit** | **Integer** | The maximum number of elements to return (use together with offset for pagination). | \[optional] \[default to 1000] | | 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\ | Limit results to those containing a matching value for a specific property. | \[optional] | #### Return type [**Requests**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/requests) #### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ⚠️ **Note**: the example bellow uses the requestsGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use requestsGet instead #### Example ```java // Import classes: import com.ionoscloud.ApiClient; import com.ionoscloud.ApiException; import com.ionoscloud.ApiResponse; import com.ionoscloud.Configuration; import com.ionoscloud.auth.*; import com.ionoscloud.model.*; import com.ionoscloud.api.RequestsApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure HTTP basic authorization: Basic Authentication HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication"); basicAuthentication.setUsername("YOUR USERNAME"); basicAuthentication.setPassword("YOUR PASSWORD"); // Configure Api Key authorization: Token Authentication defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN"); RequestsApi apiInstance = new RequestsApi(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 filterStatus = "filterStatus_example"; // String | Filter the list by request status [QUEUED, RUNNING, DONE, FAILED]. Filter is not affected by the depth query parameter. String filterCreatedAfter = "filterCreatedAfter_example"; // String | Filter the list to only include the requests created after the date, specified in the yyyy-MM-dd HH:mm:ss format. Filter is not affected by the depth query parameter. String filterCreatedBefore = "filterCreatedBefore_example"; // String | Filter the list to only include the requests created before the date, specified in the yyyy-MM-dd HH:mm:ss format. Filter is not affected by the depth query parameter. String filterCreatedDate = "filterCreatedDate_example"; // String | Filter the list to only include the requests that contain the createdDate, specified in the yyyy-MM-dd HH:mm:ss format. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. String filterCreatedBy = "filterCreatedBy_example"; // String | Filter the list to only include the requests that contain the createdBy, specified in the yyyy-MM-dd HH:mm:ss format. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. String filterEtag = "filterEtag_example"; // String | Filter the list to only include the requests that contain the specified etag. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. String filterRequestStatus = "filterRequestStatus_example"; // String | Filter the list to only include the requests that contain the specified requestStatus. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. String filterMethod = "filterMethod_example"; // String | Filter the list to only include the requests that contain the specified method. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. String filterHeaders = "filterHeaders_example"; // String | Filter the list to only include the requests that contain the specified headers. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. String filterBody = "filterBody_example"; // String | Filter the list to only include the requests that contain the specified body. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. String filterUrl = "filterUrl_example"; // String | Filter the list to only include the requests that contain the specified URL. The value is not case-sensitive, and the filter requires that the depth query parameter value is greater than zero. Integer offset = 0; // Integer | The first element (from the complete list of the elements) to include in the response (used together with limit for pagination). Integer limit = 1000; // Integer | The maximum number of elements to return (use together with offset for pagination). String orderBy = "orderBy_example"; // String | Order by field Integer maxResults = "maxResults_example"; // Integer | Maximum number of results to return Map filters = new HashMap(); // Map | Filter results by field try { ApiResponse result = apiInstance.requestsGetWithHttpInfo(pretty, depth, xContractNumber, filterStatus, filterCreatedAfter, filterCreatedBefore, filterCreatedDate, filterCreatedBy, filterEtag, filterRequestStatus, filterMethod, filterHeaders, filterBody, filterUrl, offset, limit, 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 RequestsApi#requestsGet"); 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: ```java try { Requests result = apiInstance.requestsGet() .pretty(true) .depth(0) .filterStatus("filterStatus_example") .filterCreatedAfter("filterCreatedAfter_example") .filterCreatedBefore("filterCreatedBefore_example") .filterCreatedDate("filterCreatedDate_example") .filterCreatedBy("filterCreatedBy_example") .filterEtag("filterEtag_example") .filterRequestStatus("filterRequestStatus_example") .filterMethod("filterMethod_example") .filterHeaders("filterHeaders_example") .filterBody("filterBody_example") .filterUrl("filterUrl_example") .offset(0) .limit(1000) .xContractNumber(56) .orderBy("orderBy_example") .maxResults(5) .filters(filters) .execute(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RequestsApi#requestsGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } ``` ## **requestsStatusGet** > RequestStatus requestsStatusGet(requestId, pretty, depth, xContractNumber) Retrieve request status Retrieve the status of the specified request. #### Parameters | Name | Type | Description | Notes | | ------------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **requestId** | **String** | The unique ID of the request. | | | **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\ | Limit results to those containing a matching value for a specific property. | \[optional] | #### Return type [**RequestStatus**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/requeststatus) #### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ⚠️ **Note**: the example bellow uses the requestsStatusGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use requestsStatusGet instead #### Example ```java // Import classes: import com.ionoscloud.ApiClient; import com.ionoscloud.ApiException; import com.ionoscloud.ApiResponse; import com.ionoscloud.Configuration; import com.ionoscloud.auth.*; import com.ionoscloud.model.*; import com.ionoscloud.api.RequestsApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); // Configure HTTP basic authorization: Basic Authentication HttpBasicAuth basicAuthentication = (HttpBasicAuth) defaultClient.getAuthentication("Basic Authentication"); basicAuthentication.setUsername("YOUR USERNAME"); basicAuthentication.setPassword("YOUR PASSWORD"); // Configure Api Key authorization: Token Authentication defaultClient.setApiKeyWithBearerPrefix("YOUR TOKEN"); RequestsApi apiInstance = new RequestsApi(defaultClient); String requestId = "requestId_example"; // String | The unique ID of the request. 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 filters = new HashMap(); // Map | Filter results by field try { ApiResponse result = apiInstance.requestsStatusGetWithHttpInfo(requestId, 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 RequestsApi#requestsStatusGet"); 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: ```java try { RequestStatus result = apiInstance.requestsStatusGet(requestId) .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 RequestsApi#requestsStatusGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } ```