# 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 ```go var result Locations = LocationsFindByRegionId(ctx, regionId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute() ``` Get Locations within a Region ### Example ```go package main import ( "context" "fmt" "os" ionoscloud "github.com/ionos-cloud/sdk-go/v6" ) func main() { regionId := "regionId_example" // string | The unique ID of the region. pretty := true // bool | Controls whether the response is pretty-printed (with indentations and new lines). (optional) (default to true) depth := int32(56) // int32 | 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 := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. (optional) configuration := ionoscloud.NewConfiguration() apiClient := ionoscloud.NewAPIClient(configuration) resource, resp, err := apiClient.LocationsApi.LocationsFindByRegionId(context.Background(), regionId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `LocationsApi.LocationsFindByRegionId``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `LocationsFindByRegionId`: Locations fmt.Fprintf(os.Stdout, "Response from `LocationsApi.LocationsFindByRegionId`: %v\n", resp) } ``` ### Path Parameters | Name | Type | Description | Notes | | ------------ | ------------------- | --------------------------------------------------------------------------- | ----- | | **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. | | | **regionId** | **string** | The unique ID of the region. | | ### Other Parameters Other parameters are passed through a pointer to a apiLocationsFindByRegionIdRequest struct via the builder pattern | Name | Type | Description | Notes | | ------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | | **pretty** | **bool** | Controls whether the response is pretty-printed (with indentations and new lines). | \[default to true] | | **depth** | **int32** | 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 | \[default to 0] | | **xContractNumber** | **int32** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | | ### Return type [**Locations**](/golang-sdk/models/locations.md) ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## LocationsFindByRegionIdAndId ```go var result Location = LocationsFindByRegionIdAndId(ctx, regionId, locationId) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute() ``` Get Location by ID ### Example ```go package main import ( "context" "fmt" "os" ionoscloud "github.com/ionos-cloud/sdk-go/v6" ) func main() { regionId := "regionId_example" // string | The unique ID of the region. locationId := "locationId_example" // string | The unique ID of the location. pretty := true // bool | Controls whether the response is pretty-printed (with indentations and new lines). (optional) (default to true) depth := int32(56) // int32 | 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 := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. (optional) configuration := ionoscloud.NewConfiguration() apiClient := ionoscloud.NewAPIClient(configuration) resource, resp, err := apiClient.LocationsApi.LocationsFindByRegionIdAndId(context.Background(), regionId, locationId).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `LocationsApi.LocationsFindByRegionIdAndId``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `LocationsFindByRegionIdAndId`: Location fmt.Fprintf(os.Stdout, "Response from `LocationsApi.LocationsFindByRegionIdAndId`: %v\n", resp) } ``` ### Path Parameters | Name | Type | Description | Notes | | -------------- | ------------------- | --------------------------------------------------------------------------- | ----- | | **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. | | | **regionId** | **string** | The unique ID of the region. | | | **locationId** | **string** | The unique ID of the location. | | ### Other Parameters Other parameters are passed through a pointer to a apiLocationsFindByRegionIdAndIdRequest struct via the builder pattern | Name | Type | Description | Notes | | ------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | | **pretty** | **bool** | Controls whether the response is pretty-printed (with indentations and new lines). | \[default to true] | | **depth** | **int32** | 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 | \[default to 0] | | **xContractNumber** | **int32** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | | ### Return type [**Location**](/golang-sdk/models/location.md) ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json ## LocationsGet ```go var result Locations = LocationsGet(ctx) .Pretty(pretty) .Depth(depth) .XContractNumber(xContractNumber) .Execute() ``` Get Locations ### Example ```go package main import ( "context" "fmt" "os" ionoscloud "github.com/ionos-cloud/sdk-go/v6" ) func main() { pretty := true // bool | Controls whether the response is pretty-printed (with indentations and new lines). (optional) (default to true) depth := int32(56) // int32 | 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 := int32(56) // int32 | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. (optional) configuration := ionoscloud.NewConfiguration() apiClient := ionoscloud.NewAPIClient(configuration) resource, resp, err := apiClient.LocationsApi.LocationsGet(context.Background()).Pretty(pretty).Depth(depth).XContractNumber(xContractNumber).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `LocationsApi.LocationsGet``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `LocationsGet`: Locations fmt.Fprintf(os.Stdout, "Response from `LocationsApi.LocationsGet`: %v\n", resp) } ``` ### Path Parameters ### Other Parameters Other parameters are passed through a pointer to a apiLocationsGetRequest struct via the builder pattern | Name | Type | Description | Notes | | ------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | | **pretty** | **bool** | Controls whether the response is pretty-printed (with indentations and new lines). | \[default to true] | | **depth** | **int32** | 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 | \[default to 0] | | **xContractNumber** | **int32** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | | ### Return type [**Locations**](/golang-sdk/models/locations.md) ### HTTP request headers * **Content-Type**: Not defined * **Accept**: application/json --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.ionos.com/golang-sdk/api/locationsapi.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.