Delete Parameters API | Kibana Guide [8.13]

› › ›

Delete Parameters APIedit

Deletes one or more parameters from the Synthetics app.

DELETE <kibana host>:<port>/api/synthetics/params

DELETE <kibana host>:<port>/s/<space_id>/api/synthetics/params

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

The request body should contain an array of parameter IDs that you want to delete.

Here is an example of a DELETE request to delete a list of parameters by ID:

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

The API response includes information about the deleted parameters, where each entry in the response array contains the following attributes:

id (string): The unique identifier of the deleted parameter.
deleted (boolean): Indicates whether the parameter was successfully deleted (true if deleted, false if not).

Here’s an example response for deleting multiple parameters:

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