Update a parameter

PUT /api/synthetics/params/{id}

Update a parameter in the Synthetics app. You must have all privileges for the Synthetics feature in the Observability section of the Kibana feature privileges.

Path parameters

id string Required

The unique identifier for the parameter.

application/json

Body Required

The request body cannot be empty; at least one attribute is required.

description string

The updated description of the parameter.
key string

The key of the parameter.
tags array[string]

An array of updated tags to categorize the parameter.
value string

The updated value associated with the parameter.

Responses

200 application/json

A successful response.

PUT /api/synthetics/params/{id}

curl \
 --request PUT 'https://localhost:5601/api/synthetics/params/{id}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"key\": \"updated_param_key\",\n  \"value\": \"updated-param-value\",\n  \"description\": \"Updated Param to be used in browser monitor\",\n  \"tags\": [\"authentication\", \"security\", \"updated\"]\n}"'

Request example

{
  "key": "updated_param_key",
  "value": "updated-param-value",
  "description": "Updated Param to be used in browser monitor",
  "tags": ["authentication", "security", "updated"]
}

Response examples (200)

{
  "id": "param_id1",
  "key": "updated_param_key",
  "value": "updated-param-value",
  "description": "Updated Param to be used in browser monitor",
  "tags": ["authentication", "security", "updated"]
}