---
title: "Add parameters"
method: POST
path: "/api/synthetics/params"
tags: ["synthetics"]
---

# Add parameters

`POST /api/synthetics/params`

**Spaces method and path for this operation:**

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

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

Add one or more parameters to the Synthetics app.
You must have `all` privileges for the Synthetics feature in the Observability section of the Kibana feature privileges.

## Request body

- union
  - SyntheticsParameterRequest[]
    - `description` string — A description of the parameter.
    - `key` string, required — The key of the parameter.
    - `share_across_spaces` boolean — Specify whether the parameter should be shared across spaces.
    - `tags` string[] — An array of tags to categorize the parameter.
    - `value` string, required — The value associated with the parameter.
  - SyntheticsParameterRequest
    - `description` string — A description of the parameter.
    - `key` string, required — The key of the parameter.
    - `share_across_spaces` boolean — Specify whether the parameter should be shared across spaces.
    - `tags` string[] — An array of tags to categorize the parameter.
    - `value` string, required — The value associated with the parameter.

## Response `200`

A successful response.

- union
  - SyntheticsPostParameterResponse[]
    - `description` string — A description of the parameter.
    - `id` string — The unique identifier for the parameter.
    - `key` string — The parameter key.
    - `share_across_spaces` boolean — Indicates whether the parameter is shared across spaces.
    - `tags` string[] — An array of tags associated with the parameter.
    - `value` string — The value associated with the parameter.
  - SyntheticsPostParameterResponse
    - `description` string — A description of the parameter.
    - `id` string — The unique identifier for the parameter.
    - `key` string — The parameter key.
    - `share_across_spaces` boolean — Indicates whether the parameter is shared across spaces.
    - `tags` string[] — An array of tags associated with the parameter.
    - `value` string — The value associated with the parameter.

---

[API](https://skmtc.net/elastic/apis/kibana-apis.md) · [All operations](https://skmtc.net/elastic/apis/kibana-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elastic/kibana-apis/versions/531c9e2a7d23/schema)