Get parameters

Server: https://{kibana_url}

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

Refer to Spaces for more information.

Get a list of all parameters. You must have read privileges for the Synthetics feature in the Observability section of the Kibana feature privileges.

Response

A successful response.

application/json

Examples

A successful response for a user with read-only permissions to get a list of parameters.

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET /api/synthetics/params

curl Shell

curl -X GET "https://{kibana_url}/api/synthetics/params"

Response

[
  {
    "id": "param1-id",
    "key": "param1",
    "description": "Description for param1",
    "tags": ["tag1", "tag2"],
    "namespaces": ["namespace1"]
  },
  {
    "id": "param2-id",
    "key": "param2",
    "description": "Description for param2",
    "tags": ["tag3"],
    "namespaces": ["namespace2"]
  }
]