Update a parameter

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.

Required authorization

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 · min length: 1 · max length: 1024 required: The unique identifier for the parameter.

kbn-xsrf string required: A required header to protect against CSRF attacks

description string · max length: 4096: The updated description of the parameter.
key string · min length: 1 · max length: 1024: The key of the parameter.
tags string[] · max items: 100: An array of updated tags to categorize the parameter.
value string · min length: 1 · max length: 1000000: The updated value associated with the parameter.

A successful response.

application/json

description string: The description of the parameter. It is included in the response if the user has read-only permissions to the Synthetics app.
id string: The unique identifier of the parameter.
key string: The key of the parameter.
namespaces string[]: The namespaces associated with the parameter. It is included in the response if the user has read-only permissions to the Synthetics app.
tags string[]: An array of tags associated with the parameter. It is included in the response if the user has read-only permissions to the Synthetics app.
value string: The value associated with the parameter. It will be included in the response if the user has write permissions.

400

The request body is empty.

404

The parameter does not exist.