--- title: Modifier un emplacement privé description: Modifiez un emplacement privé Synthetic. breadcrumbs: Documentation > API > Modifier un emplacement privé --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # Modifier un emplacement privé ## v1 (latest) | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------------------------------- | | app.datadoghq.com | PUT https://api.datadoghq.com/api/v1/synthetics/private-locations/{location_id} | | us3.datadoghq.com | PUT https://api.us3.datadoghq.com/api/v1/synthetics/private-locations/{location_id} | | us5.datadoghq.com | PUT https://api.us5.datadoghq.com/api/v1/synthetics/private-locations/{location_id} | | app.datadoghq.eu | PUT https://api.datadoghq.eu/api/v1/synthetics/private-locations/{location_id} | | ap1.datadoghq.com | PUT https://api.ap1.datadoghq.com/api/v1/synthetics/private-locations/{location_id} | | ap2.datadoghq.com | PUT https://api.ap2.datadoghq.com/api/v1/synthetics/private-locations/{location_id} | | uk1.datadoghq.com | PUT https://api.uk1.datadoghq.com/api/v1/synthetics/private-locations/{location_id} | | app.ddog-gov.com | PUT https://api.ddog-gov.com/api/v1/synthetics/private-locations/{location_id} | | us2.ddog-gov.com | PUT https://api.us2.ddog-gov.com/api/v1/synthetics/private-locations/{location_id} | ### Overview Modifiez un emplacement privé Synthetic. This endpoint requires the `synthetics_private_location_write` permission. OAuth apps require the `synthetics_private_location_write` authorization [scope](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/fr/api/latest/scopes.md#synthetics) to access this endpoint. ### Arguments #### Path Parameters | Field | Type | Description | | ------------------------ | ------ | ------------------------------- | | location_id [*required*] | string | The ID of the private location. | ### Request #### Body Data (required) Détails de l'emplacement privé à modifier. {% tabs %} {% tab label="Model" %} | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | description [*required*] | string | Objet contenant des informations concernant l'emplacement privé à créer. | | | 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. | | | tags [*required*] | [string] | Array of tags attached to the private location. | {% /tab %} {% tab label="Example" %} ```json { "description": "Description of private location", "metadata": { "restricted_roles": [ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" ] }, "name": "New private location", "tags": [ "team:front" ] } ``` {% /tab %} {% /tabs %} ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="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. Read-only. | | | 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. Read-only. | | secrets | authentication | object | Authentication part of the secrets. | | authentication | id | string | Access key for the private location. Read-only. | | authentication | key | string | Secret access key for the private location. Read-only. | | secrets | config_decryption | object | Private key for the private location. | | config_decryption | key | string | Private key for the private location. Read-only. | | | tags [*required*] | [string] | Array of tags attached to the private location. | {% /tab %} {% tab label="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 %} {% /tabs %} {% /tab %} {% tab label="404" %} - Private locations are not activated for the user - Private location does not exist {% tabs %} {% tab label="Model" %} Error response object. | Field | Type | Description | | ------------------- | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} Error response object. | Field | Type | Description | | ------------------- | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Path parameters export location_id="CHANGE_ME" # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X PUT "https://api.${DD_SITE}/api/v1/synthetics/private-locations/${location_id}" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \ -d @- << EOF { "description": "Description of private location", "name": "New private location", "tags": [ "team:front" ] } EOF ``` {% /tab %} {% tab label="Go" %} ```go // Edit 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() { body := datadogV1.SyntheticsPrivateLocation{ Description: "Description of private location", Metadata: &datadogV1.SyntheticsPrivateLocationMetadata{ RestrictedRoles: []string{ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", }, }, Name: "New private location", Tags: []string{ "team:front", }, } ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewSyntheticsApi(apiClient) resp, r, err := api.UpdatePrivateLocation(ctx, "location_id", body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `SyntheticsApi.UpdatePrivateLocation`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `SyntheticsApi.UpdatePrivateLocation`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // Edit 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.SyntheticsPrivateLocationMetadata; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); SyntheticsApi apiInstance = new SyntheticsApi(defaultClient); SyntheticsPrivateLocation body = new SyntheticsPrivateLocation() .description("Description of private location") .metadata( new SyntheticsPrivateLocationMetadata() .restrictedRoles( Collections.singletonList("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"))) .name("New private location") .tags(Collections.singletonList("team:front")); try { SyntheticsPrivateLocation result = apiInstance.updatePrivateLocation("location_id", body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling SyntheticsApi#updatePrivateLocation"); 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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ Edit 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 body = SyntheticsPrivateLocation( description="Description of private location", metadata=SyntheticsPrivateLocationMetadata( restricted_roles=SyntheticsRestrictedRoles( [ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", ] ), ), name="New private location", tags=[ "team:front", ], ) configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = SyntheticsApi(api_client) response = api_instance.update_private_location(location_id="location_id", body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Edit a private location returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] end api_instance = DatadogAPIClient::V1::SyntheticsAPI.new body = DatadogAPIClient::V1::SyntheticsPrivateLocation.new({ description: "Description of private location", metadata: DatadogAPIClient::V1::SyntheticsPrivateLocationMetadata.new({ restricted_roles: [ "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", ], }), name: "New private location", tags: [ "team:front", ], }) p api_instance.update_private_location("location_id", body) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // Edit 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() { let body = SyntheticsPrivateLocation::new( "Description of private location".to_string(), "New private location".to_string(), vec!["team:front".to_string()], ) .metadata( SyntheticsPrivateLocationMetadata::new() .restricted_roles(vec!["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx".to_string()]), ); let configuration = datadog::Configuration::new(); let api = SyntheticsAPI::with_config(configuration); let resp = api .update_private_location("location_id".to_string(), body) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * Edit a private location returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); const apiInstance = new v1.SyntheticsApi(configuration); const params: v1.SyntheticsApiUpdatePrivateLocationRequest = { body: { description: "Description of private location", metadata: { restrictedRoles: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], }, name: "New private location", tags: ["team:front"], }, locationId: "location_id", }; apiInstance .updatePrivateLocation(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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% /tabs %}