Delete parameters

Base URL: https://{kibana_url}

POST /api/synthetics/params/_bulk_delete

Delete parameters from 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

Response

A successful response.

application/json

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"]
}

Generated from the API spec

curl Shell

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

Generated from the API spec

Response

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

Authentication

Request body { }

Response

Request body