Add parameters
https://{kibana_url}
- POST /api/synthetics/params
- POST /s/{space_id}/api/synthetics/params
Refer to Spaces for more information.
Add one or more parameters to the Synthetics app.
You must have all privileges for the Synthetics feature in the Observability section of the Kibana feature privileges.
Request
The request body can contain either a single parameter object or an array of parameter objects.
One of:Synthetics_parameterRequest
-
descriptionstring -
A description of the parameter.
-
keystringrequired -
The key of the parameter.
-
Specify whether the parameter should be shared across spaces.
-
An array of tags to categorize the parameter.
-
valuestringrequired -
The value associated with the parameter.
-
descriptionstring -
A description of the parameter.
-
keystringrequired -
The key of the parameter.
-
Specify whether the parameter should be shared across spaces.
-
An array of tags to categorize the parameter.
-
valuestringrequired -
The value associated with the parameter.
Response
A successful response.
Synthetics_postParameterResponse
-
descriptionstring -
A description of the parameter.
-
idstring -
The unique identifier for the parameter.
-
keystring -
The parameter key.
-
Indicates whether the parameter is shared across spaces.
-
An array of tags associated with the parameter.
-
valuestring -
The value associated with the parameter.
-
descriptionstring -
A description of the parameter.
-
idstring -
The unique identifier for the parameter.
-
keystring -
The parameter key.
-
Indicates whether the parameter is shared across spaces.
-
An array of tags associated with the parameter.
-
valuestring -
The value associated with the parameter.