--- title: Create a private location description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Synthetics --- # Create a private location{% #create-a-private-location %} {% tab title="v1" %} | Datadog site | API endpoint | | ----------------- | ---------------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v1/synthetics/private-locations | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v1/synthetics/private-locations | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v1/synthetics/private-locations | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v1/synthetics/private-locations | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v1/synthetics/private-locations | | app.datadoghq.com | POST https://api.datadoghq.com/api/v1/synthetics/private-locations | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v1/synthetics/private-locations | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v1/synthetics/private-locations | ### Overview Create a new Synthetic private location. This endpoint requires the `synthetics_private_location_write` permission. OAuth apps require the `synthetics_private_location_write` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#synthetics) to access this endpoint. ### Request #### Body Data (required) Details of the private location to create. {% tab title="Model" %} | 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": "Test Example-Synthetic description", "metadata": { "restricted_roles": [ "string" ] }, "name": "Example-Synthetic", "tags": [ "test:examplesynthetic" ] } ``` {% /tab %} ### Response {% tab title="200" %} OK {% tab title="Model" %} Object that contains the new private location, the public key for result encryption, and the configuration skeleton. | Parent field | Field | Type | Description | | ----------------- | ----------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | config | object | Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration. | | | private_location | object | Object containing information about the private location to create. | | private_location | description [*required*] | string | Description of the private location. | | private_location | id | string | Unique identifier of the private location. | | 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. | | private_location | name [*required*] | string | Name of the private location. | | 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. | | private_location | tags [*required*] | [string] | Array of tags attached to the private location. | | | result_encryption | object | Public key for the result encryption. | | result_encryption | id | string | Fingerprint for the encryption key. | | result_encryption | key | string | Public key for result encryption. | {% /tab %} {% tab title="Example" %} ```json { "config": {}, "private_location": { "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" ] }, "result_encryption": { "id": "string", "key": "string" } } ``` {% /tab %} {% /tab %} {% tab title="402" %} Quota reached for private locations {% 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="404" %} Private locations are not activated for the user {% 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 ##### \## default # \# Curl command curl -X POST "https://api.datadoghq.com/api/v1/synthetics/private-locations" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "description": "Description of private location", "name": "New private location", "tags": [ "team:front" ] } EOF ##### ```go // Create 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() { // there is a valid "role" in the system RoleDataID := os.Getenv("ROLE_DATA_ID") body := datadogV1.SyntheticsPrivateLocation{ Description: "Test Example-Synthetic description", Metadata: &datadogV1.SyntheticsPrivateLocationMetadata{ RestrictedRoles: []string{ RoleDataID, }, }, Name: "Example-Synthetic", Tags: []string{ "test:examplesynthetic", }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewSyntheticsApi(apiClient) resp, r, err := api.CreatePrivateLocation(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SyntheticsApi.CreatePrivateLocation`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `SyntheticsApi.CreatePrivateLocation`:\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 // Create 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; import com.datadog.api.client.v1.model.SyntheticsPrivateLocationCreationResponse; import com.datadog.api.client.v1.model.SyntheticsPrivateLocationMetadata; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); SyntheticsApi apiInstance = new SyntheticsApi(defaultClient); // there is a valid "role" in the system String ROLE_DATA_ID = System.getenv("ROLE_DATA_ID"); SyntheticsPrivateLocation body = new SyntheticsPrivateLocation() .description("Test Example-Synthetic description") .metadata( new SyntheticsPrivateLocationMetadata() .restrictedRoles(Collections.singletonList(ROLE_DATA_ID))) .name("Example-Synthetic") .tags(Collections.singletonList("test:examplesynthetic")); try { SyntheticsPrivateLocationCreationResponse result = apiInstance.createPrivateLocation(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling SyntheticsApi#createPrivateLocation"); 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" ##### ```python """ Create a private location returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.synthetics_api import SyntheticsApi from datadog_api_client.v1.model.synthetics_private_location import SyntheticsPrivateLocation from datadog_api_client.v1.model.synthetics_private_location_metadata import SyntheticsPrivateLocationMetadata from datadog_api_client.v1.model.synthetics_restricted_roles import SyntheticsRestrictedRoles # there is a valid "role" in the system ROLE_DATA_ID = environ["ROLE_DATA_ID"] body = SyntheticsPrivateLocation( description="Test Example-Synthetic description", metadata=SyntheticsPrivateLocationMetadata( restricted_roles=SyntheticsRestrictedRoles( [ ROLE_DATA_ID, ] ), ), name="Example-Synthetic", tags=[ "test:examplesynthetic", ], ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = SyntheticsApi(api_client) response = api_instance.create_private_location(body=body) 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 # Create a private location returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::SyntheticsAPI.new # there is a valid "role" in the system ROLE_DATA_ID = ENV["ROLE_DATA_ID"] body = DatadogAPIClient::V1::SyntheticsPrivateLocation.new({ description: "Test Example-Synthetic description", metadata: DatadogAPIClient::V1::SyntheticsPrivateLocationMetadata.new({ restricted_roles: [ ROLE_DATA_ID, ], }), name: "Example-Synthetic", tags: [ "test:examplesynthetic", ], }) p api_instance.create_private_location(body) ``` #### 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" ##### ```rust // Create a private location returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_synthetics::SyntheticsAPI; use datadog_api_client::datadogV1::model::SyntheticsPrivateLocation; use datadog_api_client::datadogV1::model::SyntheticsPrivateLocationMetadata; #[tokio::main] async fn main() { // there is a valid "role" in the system let role_data_id = std::env::var("ROLE_DATA_ID").unwrap(); let body = SyntheticsPrivateLocation::new( "Test Example-Synthetic description".to_string(), "Example-Synthetic".to_string(), vec!["test:examplesynthetic".to_string()], ) .metadata( SyntheticsPrivateLocationMetadata::new().restricted_roles(vec![role_data_id.clone()]), ); let configuration = datadog::Configuration::new(); let api = SyntheticsAPI::with_config(configuration); let resp = api.create_private_location(body).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 /** * Create a private location returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.SyntheticsApi(configuration); // there is a valid "role" in the system const ROLE_DATA_ID = process.env.ROLE_DATA_ID as string; const params: v1.SyntheticsApiCreatePrivateLocationRequest = { body: { description: "Test Example-Synthetic description", metadata: { restrictedRoles: [ROLE_DATA_ID], }, name: "Example-Synthetic", tags: ["test:examplesynthetic"], }, }; apiInstance .createPrivateLocation(params) .then((data: v1.SyntheticsPrivateLocationCreationResponse) => { 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 %}