---
type: api
title: Get a parameter
description: **Spaces method and path for this operation:**
url: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/kibana/operation/operation-get-parameter
resource: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/kibana/operation/operation-get-parameter
products:
  - Kibana
---

# Get a parameter

- Server: `https://{kibana_url}`

## Paths

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

#### Path parameters

- `id` (string · min length: 1 · max length: 1024) — required
  The unique identifier for the parameter.

## Description

Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-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.

## Required authorization

- Privileges: `uptime-read`

## 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>`

## Responses

#### `200`

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.

## Code examples

#### Console

```console
GET kbn://api/synthetics/params/param-id
```

#### curl

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

## Response examples

#### Read access

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

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

#### Write access

A successful response for a user with write permissions to get a single parameter.

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