Update a parameter

Base URL: https://{kibana_url}

PUT /api/synthetics/params/{id}
PUT /s/{space_id}/api/synthetics/params/{id}

Auth

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

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
id string required: The unique identifier for the parameter.

Request body

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 string[]: An array of updated tags to categorize the parameter.
value string: The updated value associated with the parameter.

Response

A successful response.

application/json

Response Type: object

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT kbn:/api/synthetics/params/ID
{
  "key": "updated_param_key",
  "value": "updated-param-value",
  "description": "Updated Param to be used in browser monitor",
  "tags": ["authentication", "security", "updated"]
}

Generated from the API spec

curl Shell

curl -X PUT "${KIBANA_URL}/api/synthetics/params/${ID}" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "updated_param_key",
    "value": "updated-param-value",
    "description": "Updated Param to be used in browser monitor",
    "tags": ["authentication", "security", "updated"]
  }'

Generated from the API spec

Response

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

Path parameters

Request body { }

Response

Request body