Get a parameter

Base URL: https://{kibana_url}

GET /api/synthetics/params/{id}
GET /s/{space_id}/api/synthetics/params/{id}

Refer to Spaces for more information.

Get a parameter from the Synthetics app.

You must have read privileges for the Synthetics feature in the Observability section of the Kibana feature privileges.

Required authorization

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>

Path parameters

Responses

A successful response.

application/json

404

The parameter or the Kibana space does not exist.

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn://api/synthetics/params/param-id

curl Shell

curl \
  -X GET "${KIBANA_URL}/api/synthetics/params/param-id" \
  -H "Authorization: ApiKey ${API_KEY}"

Response

A successful response for a user with read-only permissions to get a single parameter.

{
  "description": "Param to use in browser monitor",
  "id": "unique-parameter-id",
  "key": "your-api-key",
  "namespaces": [
    "namespace1",
    "namespace2"
  ],
  "tags": [
    "authentication",
    "security"
  ]
}