Update a parameter

Base URL: https://{kibana_url}

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.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Request body

Response

A successful response.

application/json

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"]
}

Authentication

Path parameters

Request body { }

Response

Request body