Sign in
synthetics

Get a parameter

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/{id}</span></div>

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.

get/api/synthetics/params/{id}

Path parameters

idstring required

The unique identifier for the parameter.

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 recorded changes to this endpoint across all 92 revisions of this API.