For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/fr/api/latest/synthetics/patch-a-global-variable.md. A documentation index is available at /llms.txt.
Language
Datadog site

Patcher une variable globale

PATCHhttps://api.datadoghq.com/api/v2/synthetics/variables/{variable_id}/jsonpatchhttps://api.us3.datadoghq.com/api/v2/synthetics/variables/{variable_id}/jsonpatchhttps://api.us5.datadoghq.com/api/v2/synthetics/variables/{variable_id}/jsonpatchhttps://api.datadoghq.eu/api/v2/synthetics/variables/{variable_id}/jsonpatchhttps://api.ap1.datadoghq.com/api/v2/synthetics/variables/{variable_id}/jsonpatchhttps://api.ap2.datadoghq.com/api/v2/synthetics/variables/{variable_id}/jsonpatchhttps://api.uk1.datadoghq.com/api/v2/synthetics/variables/{variable_id}/jsonpatchhttps://api.ddog-gov.com/api/v2/synthetics/variables/{variable_id}/jsonpatchhttps://api.us2.ddog-gov.com/api/v2/synthetics/variables/{variable_id}/jsonpatch

Présentation

Mettre à jour partiellement une variable globale à l'aide de JSON Patch (RFC 6902). Cet endpoint permet des mises à jour partielles d'une variable globale en spécifiant uniquement les champs à modifier.

Les opérations courantes sont les suivantes :

  • Remplacer des valeurs de champs : {"op": "replace", "path": "/name", "value": "new_name"}
  • Mettre à jour des valeurs imbriquées : {"op": "replace", "path": "/value/value", "value": "new_value"}
  • Ajouter/mettre à jour des tags : {"op": "add", "path": "/tags/-", "value": "new_tag"}
  • Supprimer des champs : {"op": "remove", "path": "/description"}

This endpoint requires the synthetics_global_variable_write permission.

Arguments

Paramètres du chemin

Name
Type
Description
variable_id [required]
string

The ID of the global variable.

Requête

Body Data (required)

Document de patch JSON avec les opérations à appliquer.

Champ
Type
Description
data [required]
object

Requête de patch JSON pour une variable globale.

Réponse

OK

Global variable response.

Champ
Type
Description
data
object

Synthetics global variable data. Wrapper around the global variable object.

Exemple de code

Patcher une variable globale
# Path parameters
export variable_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/synthetics/variables/${variable_id}/jsonpatch" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "json_patch": [
        {
          "op": "add",
          "path": "/name"
        }
      ]
    },
    "type": "global_variables_json_patch"
  }
}
EOF
# Path parameters
export variable_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/synthetics/variables/${variable_id}/jsonpatch" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "json_patch": [
        {
          "op": "add",
          "path": "/name"
        }
      ]
    },
    "type": "global_variables_json_patch"
  }
}
EOF
# Path parameters
export variable_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/synthetics/variables/${variable_id}/jsonpatch" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "json_patch": [
        {
          "op": "add",
          "path": "/name"
        }
      ]
    },
    "type": "global_variables_json_patch"
  }
}
EOF
# Path parameters
export variable_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/synthetics/variables/${variable_id}/jsonpatch" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "json_patch": [
        {
          "op": "add",
          "path": "/name"
        }
      ]
    },
    "type": "global_variables_json_patch"
  }
}
EOF
# Path parameters
export variable_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/synthetics/variables/${variable_id}/jsonpatch" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "json_patch": [
        {
          "op": "add",
          "path": "/name"
        }
      ]
    },
    "type": "global_variables_json_patch"
  }
}
EOF
# Path parameters
export variable_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/synthetics/variables/${variable_id}/jsonpatch" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "json_patch": [
        {
          "op": "add",
          "path": "/name"
        }
      ]
    },
    "type": "global_variables_json_patch"
  }
}
EOF
# Path parameters
export variable_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/synthetics/variables/${variable_id}/jsonpatch" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "json_patch": [
        {
          "op": "add",
          "path": "/name"
        }
      ]
    },
    "type": "global_variables_json_patch"
  }
}
EOF
# Path parameters
export variable_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/synthetics/variables/${variable_id}/jsonpatch" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "json_patch": [
        {
          "op": "add",
          "path": "/name"
        }
      ]
    },
    "type": "global_variables_json_patch"
  }
}
EOF
# Path parameters
export variable_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X PATCH "https://api.${DD_SITE}/api/v2/synthetics/variables/${variable_id}/jsonpatch" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "json_patch": [
        {
          "op": "add",
          "path": "/name"
        }
      ]
    },
    "type": "global_variables_json_patch"
  }
}
EOF