# LocationsApi ## LocationsApi All URIs are relative to ** | Method | HTTP request | Description | | ----------------------------------------------------------------- | ------------------------------------------ | ----------------------------- | | [**locationsFindByRegionId**](#locationsfindbyregionid) | **GET** /locations/{regionId} | Get Locations within a Region | | [**locationsFindByRegionIdAndId**](#locationsfindbyregionidandid) | **GET** /locations/{regionId}/{locationId} | Get Location by ID | | [**locationsGet**](#locationsget) | **GET** /locations | Get Locations | ## **locationsFindByRegionId** > Locations locationsFindByRegionId(regionId, pretty, depth, xContractNumber) Get Locations within a Region Retrieves the available locations in a region specified by its ID. The 'regionId' consists of the two character identifier of the region (country), e.g., 'de'. #### Parameters | Name | Type | Description | Notes | | ------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **regionId** | **String** | The unique ID of the region. | | | **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 [**Locations**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/locations) #### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ⚠️ **Note**: the example bellow uses the locationsFindByRegionIdWithHttpInfo which also returns the status code and the headers, if you don't need them you may use locationsFindByRegionId 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.LocationsApi; 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"); LocationsApi apiInstance = new LocationsApi(defaultClient); String regionId = "regionId_example"; // String | The unique ID of the region. 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.locationsFindByRegionIdWithHttpInfo(regionId, 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 LocationsApi#locationsFindByRegionId"); 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 { Locations result = apiInstance.locationsFindByRegionId(regionId) .pretty(true) .depth(0) .xContractNumber(56) .execute(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling LocationsApi#locationsFindByRegionId"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } ``` ## **locationsFindByRegionIdAndId** > Location locationsFindByRegionIdAndId(regionId, locationId, pretty, depth, xContractNumber) Get Location by ID Retrieves the information about the location specified by its ID. The 'locationId' consists of the three-digit identifier of the city according to the IATA code. #### Parameters | Name | Type | Description | Notes | | ------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | **regionId** | **String** | The unique ID of the region. | | | **locationId** | **String** | The unique ID of the location. | | | **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 [**Location**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/location) #### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ⚠️ **Note**: the example bellow uses the locationsFindByRegionIdAndIdWithHttpInfo which also returns the status code and the headers, if you don't need them you may use locationsFindByRegionIdAndId 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.LocationsApi; 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"); LocationsApi apiInstance = new LocationsApi(defaultClient); String regionId = "regionId_example"; // String | The unique ID of the region. String locationId = "locationId_example"; // String | The unique ID of the location. 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.locationsFindByRegionIdAndIdWithHttpInfo(regionId, locationId, 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 LocationsApi#locationsFindByRegionIdAndId"); 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 { Location result = apiInstance.locationsFindByRegionIdAndId(regionId, locationId) .pretty(true) .depth(0) .xContractNumber(56) .execute(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling LocationsApi#locationsFindByRegionIdAndId"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } ``` ## **locationsGet** > Locations locationsGet(pretty, depth, xContractNumber) Get Locations Retrieves the available physical locations where you can deploy cloud resources in a VDC. A location is identified by a combination of the following characters: \* a two-character **regionId**, which represents a country (example: 'de') \* a three-character **locationId**, which represents a city. The 'locationId' is typically based on the IATA code of the city's airport (example: 'txl'). >Note that 'locations' are read-only and cannot be changed. #### 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] | | 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 [**Locations**](https://docs.ionos.com/sections-test/java-sdk/cloud-api-java-sdk/models/locations) #### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ⚠️ **Note**: the example bellow uses the locationsGetWithHttpInfo which also returns the status code and the headers, if you don't need them you may use locationsGet 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.LocationsApi; 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"); LocationsApi apiInstance = new LocationsApi(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 filters = new HashMap(); // Map | Filter results by field try { ApiResponse result = apiInstance.locationsGetWithHttpInfo(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 LocationsApi#locationsGet"); 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 { Locations result = apiInstance.locationsGet() .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 LocationsApi#locationsGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } ```