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}

curl Shell

curl \
  -X POST "${KIBANA_URL}/api/synthetics/params" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -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}'

Request Console 1 / 2 languages

Add a single parameter.

Console Kibana Dev Tools

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

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

A successful response for a single added parameter.

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

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 "kbn-xsrf: true" \
  -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"
  }
]