Add parameters

Base URL: 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.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Request body

Response

A successful response.

application/json

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"
  }
]