---
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-serverless/operation/operation-put-parameter
resource: https://www.elastic.co/elastic/docs-builder/docs/4493/api/doc/kibana-serverless/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 · 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.

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.

## Required authorization

- Privileges: `uptime-read` and `uptime-write`

## Authentication

- Api key: `Authorization: <value>`
  You must create an API key and use the encoded value in the request header. To learn about creating keys, go to [API keys](https://www.elastic.co/docs/current/serverless/api-keys).

## Header parameters

- `kbn-xsrf` (string) — required
  A required header to protect against CSRF attacks

## Request body

`application/json`

- `description` (string · max length: 4096) — optional
  The updated description of the parameter.
- `key` (string · min length: 1 · max length: 1024) — optional
  The key of the parameter.
- `tags` (string[] · max items: 100) — optional
  An array of updated tags to categorize the parameter.
- `value` (string · min length: 1 · max length: 1000000) — optional
  The updated value associated with the parameter.

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

The request body is empty.

#### `404`

The parameter does not exist.

## Code examples

#### Console

```console
PUT kbn://api/synthetics/params/param-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/param-id" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -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
{
  "description": "Updated Param to be used in browser monitor",
  "id": "param_id1",
  "key": "updated_param_key",
  "tags": [
    "authentication",
    "security",
    "updated"
  ],
  "value": "updated-param-value"
}
```