Edit Parameter by ID API
editEdit Parameter by ID API
editEdits a parameter with the specified ID.
Request
editPUT <kibana host>:<port>/api/synthetics/params
PUT <kibana host>:<port>/s/<space_id>/api/synthetics/params
Prerequisites
editYou 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
editThe request body should contain the following attributes:
-
key - (Required, string) The key of the parameter.
-
value - (Required, 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
editHere 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"]
}