Add parameters

Base URL: https://{kibana_url}

POST /api/synthetics/params
POST /s/{space_id}/api/synthetics/params

Auth

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.

Path parameters

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.

Request body

The request body can contain either a single parameter object or an array of parameter objects.

One of:

{} Parameter request[]

description string: A description of the parameter.
key string required: The key of the parameter.
share_across_spaces boolean: Specify whether the parameter should be shared across spaces.
tags string[]: An array of tags to categorize the parameter.
value string required: The value associated with the parameter.

Response

A successful response.

application/json

One of:

{} Post parameter response[]

description string: A description of the parameter.
id string: The unique identifier for the parameter.
key string: The parameter key.
share_across_spaces boolean: Indicates whether the parameter is shared across spaces.
tags string[]: An array of tags associated with the parameter.
value string: The value associated with the parameter.

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Add a single parameter.

Console Kibana Dev Tools

POST kbn:/api/synthetics/params
{
  "key": "your-key-name",
  "value": "your-parameter-value",
  "description": "Param to use in browser monitor",
  "tags": ["authentication", "security"],
  "share_across_spaces": true
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/synthetics/params" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "your-key-name",
    "value": "your-parameter-value",
    "description": "Param to use in browser monitor",
    "tags": ["authentication", "security"],
    "share_across_spaces": true
  }'

Generated from the API spec

Response

A successful response for a single added parameter.

{
  "id": "unique-parameter-id",
  "key": "your-key-name",
  "value": "your-param-value",
  "description": "Param to use in browser monitor",
  "tags": ["authentication", "security"],
  "share_across_spaces": true
}

Request Console 1 / 2 languages

Add multiple parameters.

Console Kibana Dev Tools

POST kbn:/api/synthetics/params
[
  {
    "key": "param1",
    "value": "value1"
  },
  {
    "key": "param2",
    "value": "value2"
  }
]

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/synthetics/params" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "key": "param1",
      "value": "value1"
    },
    {
      "key": "param2",
      "value": "value2"
    }
  ]'

Generated from the API spec

Response

A successful response for multiple added parameters.

[
  {
    "id": "param1-id",
    "key": "param1",
    "value": "value1"
  },
  {
    "id": "param2-id",
    "key": "param2",
    "value": "value2"
  }
]