Get a parameter

Base URL: https://{kibana_url}

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

Auth

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 privileges

Privileges uptime-read

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.
id string · min length: 1 · max length: 1024 required: The unique identifier for the parameter.

Responses

A successful response.

application/json

description string: The description of the parameter. It is included in the response if the user has read-only permissions to the Synthetics app.
id string: The unique identifier of the parameter.
key string: The key of the parameter.
namespaces string[]: The namespaces associated with the parameter. It is included in the response if the user has read-only permissions to the Synthetics app.
tags string[]: An array of tags associated with the parameter. It is included in the response if the user has read-only permissions to the Synthetics app.
value string: The value associated with the parameter. It will be included in the response if the user has write permissions.

404

The parameter or the Kibana space does not exist.

View as Markdown

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