Delete parameters

DELETE /api/synthetics/params/_bulk_delete
Api key auth Basic 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.

application/json

Body Required

object object

Responses

  • 200 application/json

    A successful response.

    Hide response attributes Show response attributes object
    • deleted boolean

      Indicates whether the parameter was successfully deleted. It is true if it was deleted. It is false if it was not deleted.

    • id string

      The unique identifier for the deleted parameter.
DELETE /api/synthetics/params/_bulk_delete 
curl \
 --request DELETE 'https://localhost:5601/api/synthetics/params/_bulk_delete' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"ids\": [\"param1-id\", \"param2-id\"]\n}"'
Request example
Run `POST /api/synthetics/params/_bulk_delete` to delete multiple parameters. 
{
  "ids": ["param1-id", "param2-id"]
}
Response examples (200) 
[
  {
    "id": "param1-id",
    "deleted": true
  }
]