synthetics

Search parameters

Spaces method and path for this operation:

<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/synthetics/params</span></div>

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.<br/><br/>[Required authorization] Route required privileges: uptime-read.

get/api/synthetics/params

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/synthetics/params
  • Auth
    • API key in header Authorization
    • or HTTP basic

Response

A successful response.

descriptionstring

The description of the parameter. It is included in the response if the user has read-only permissions to the Synthetics app.

idstring

The unique identifier of the parameter.

keystring

The key of the parameter.

namespacesstring[]

The namespaces associated with the parameter. It is included in the response if the user has read-only permissions to the Synthetics app.

tagsstring[]

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.

valuestring

The value associated with the parameter. It will be included in the response if the user has write permissions.

Changes

No operation changes recorded.