Delete parameters

Base URL: https://{kibana_url}

POST /api/synthetics/params/_bulk_delete
POST /s/{space_id}/api/synthetics/params/_bulk_delete

Auth

Delete parameters from the Synthetics app.

You must have all privileges for the Synthetics feature in the Observability section of the Kibana feature privileges.

Required privileges

Privileges uptime-read and uptime-write

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

ids string[] · max items: 10000 required: An array of parameter IDs to delete.

Response

A successful response.

application/json

<array> object[]

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Run POST /api/synthetics/params/_bulk_delete to delete multiple parameters.

Console Kibana Dev Tools

POST kbn://api/synthetics/params/_bulk_delete
{"ids":["param1-id","param2-id"]}

curl Shell

curl \
  -X POST "${KIBANA_URL}/api/synthetics/params/_bulk_delete" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true" \
  -H "Content-Type: application/json" \
  -d '{"ids":["param1-id","param2-id"]}'

Response

[
  {
    "deleted": true,
    "id": "param1-id"
  }
]