Edit Parameter by ID API

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Edit Parameter by ID API

edit

Edits a parameter with the specified ID.

Request

edit

PUT <kibana host>:<port>/api/synthetics/params

PUT <kibana host>:<port>/s/<space_id>/api/synthetics/params

Prerequisites

edit

You must have all privileges for the Synthetics feature in the Observability section of the Kibana feature privileges.

Path Parameters

edit

id: (Required, string) The unique identifier of the parameter to be edited.

Request body

edit

The request body can contain the following attributes, it can’t be empty at least one attribute is required.:

key: (Optional, string) The key of the parameter.
value: (Optional, string) The updated value associated with the parameter.
description: (Optional, string) The updated description of the parameter.
tags: (Optional, array of strings) An array of updated tags to categorize the parameter.

Example

edit

Here is an example of a PUT request to edit a parameter by its ID:

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

The API returns the updated parameter as follows:

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

« Get Parameters API Delete Parameters API »