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

# Update a parameter

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

## Paths

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

#### Path parameters

- `id` (string) — required
  The unique identifier for the parameter.

## Description

Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.

Update a parameter in the Synthetics app.
You must have `all` privileges for the Synthetics feature in the Observability section of the Kibana feature privileges.

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

## Request body

The request body cannot be empty; at least one attribute is required.

`application/json`

- `description` (string) — optional
  The updated description of the parameter.
- `key` (string) — optional
  The key of the parameter.
- `tags` (string[]) — optional
  An array of updated tags to categorize the parameter.
- `value` (string) — optional
  The updated value associated with the parameter.

## Response

A successful response.

`application/json`

Type: `object`

## Code examples

#### Console

```console
PUT kbn:/api/synthetics/params/ID
{
  "key": "updated_param_key",
  "value": "updated-param-value",
  "description": "Updated Param to be used in browser monitor",
  "tags": ["authentication", "security", "updated"]
}
```

#### curl

```curl
curl -X PUT "${KIBANA_URL}/api/synthetics/params/${ID}" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "updated_param_key",
    "value": "updated-param-value",
    "description": "Updated Param to be used in browser monitor",
    "tags": ["authentication", "security", "updated"]
  }'
```

## Response examples

#### Put parameter response example1

```json
{
  "id": "param_id1",
  "key": "updated_param_key",
  "value": "updated-param-value",
  "description": "Updated Param to be used in browser monitor",
  "tags": ["authentication", "security", "updated"]
}
```