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.

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

Response

A successful response.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/synthetics/params/ID

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

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

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