--- title: Get a private location description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Synthetics --- # Get a private location{% #get-a-private-location %} Copy pageCopied {% tab title="v1" %} | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v1/synthetics/private-locations/{location_id} | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v1/synthetics/private-locations/{location_id} | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v1/synthetics/private-locations/{location_id} | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v1/synthetics/private-locations/{location_id} | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v1/synthetics/private-locations/{location_id} | | app.datadoghq.com | GET https://api.datadoghq.com/api/v1/synthetics/private-locations/{location_id} | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v1/synthetics/private-locations/{location_id} | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v1/synthetics/private-locations/{location_id} | ### Overview Get a Synthetic private location. This endpoint requires the `synthetics_private_location_read` permission. OAuth apps require the `synthetics_private_location_read` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#synthetics) to access this endpoint. ### Arguments #### Path Parameters | Name | Type | Description | | ----------------------------- | ------ | ------------------------------- | | location_id [*required*] | string | The ID of the private location. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Object containing information about the private location to create. | Parent field | Field | Type | Description | | ----------------- | ----------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | description [*required*] | string | Description of the private location. | | | id | string | Unique identifier of the private location. | | | metadata | object | Object containing metadata about the private location. | | metadata | restricted_roles | [string] | **DEPRECATED**: A list of role identifiers that can be pulled from the Roles API, for restricting read and write access. This field is deprecated. Use the restriction policies API to manage permissions. | | | name [*required*] | string | Name of the private location. | | | secrets | object | Secrets for the private location. Only present in the response when creating the private location. | | secrets | authentication | object | Authentication part of the secrets. | | authentication | id | string | Access key for the private location. | | authentication | key | string | Secret access key for the private location. | | secrets | config_decryption | object | Private key for the private location. | | config_decryption | key | string | Private key for the private location. | | | tags [*required*] | [string] | Array of tags attached to the private location. | {% /tab %} {% tab title="Example" %} ```json { "description": "Description of private location", "id": "string", "metadata": { "restricted_roles": [ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ] }, "name": "New private location", "secrets": { "authentication": { "id": "string", "key": "string" }, "config_decryption": { "key": "string" } }, "tags": [ "team:front" ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} - Synthetic private locations are not activated for the user - Private location does not exist {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Path parameters export location_id="CHANGE_ME" \# Curl command curl -X GET "https://api.datadoghq.com/api/v1/synthetics/private-locations/${location_id}" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get a private location returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.synthetics_api import SyntheticsApi configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = SyntheticsApi(api_client) response = api_instance.get_private_location( location_id="location_id", ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Get a private location returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::SyntheticsAPI.new p api_instance.get_private_location("location_id") ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Get a private location returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewSyntheticsApi(apiClient) resp, r, err := api.GetPrivateLocation(ctx, "location_id") if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SyntheticsApi.GetPrivateLocation`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `SyntheticsApi.GetPrivateLocation`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Get a private location returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.SyntheticsApi; import com.datadog.api.client.v1.model.SyntheticsPrivateLocation; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); SyntheticsApi apiInstance = new SyntheticsApi(defaultClient); try { SyntheticsPrivateLocation result = apiInstance.getPrivateLocation("location_id"); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling SyntheticsApi#getPrivateLocation"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Get a private location returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_synthetics::SyntheticsAPI; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = SyntheticsAPI::with_config(configuration); let resp = api.get_private_location("location_id".to_string()).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Get a private location returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.SyntheticsApi(configuration); const params: v1.SyntheticsApiGetPrivateLocationRequest = { locationId: "location_id", }; apiInstance .getPrivateLocation(params) .then((data: v1.SyntheticsPrivateLocation) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}