This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« Edit Parameter by ID API Create Private Location API »
Elastic Docs ›Kibana Guide [master] ›REST API ›Synthetics APIs

Delete Parameters API

edit

Delete Parameters API

edit

Deletes one or more parameters from the Synthetics app.

Request

edit

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

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

Prerequisites

edit

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

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

Request Body

edit

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

ids
(Required, array of strings) An array of parameter IDs 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"
  ]
}

Response Example

edit

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
  }
]
« Edit Parameter by ID API Create Private Location API »