New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
« Edit Parameter by ID API Create Private Location API »
Elastic Docs ›Kibana Guide [8.17] ›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/<param_id>

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

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.

Path Parameters

edit

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

param_id
(Required, string) An id of parameter to delete.

Here is an example of a DELETE request to delete a parameter by its ID:

DELETE /api/synthetics/params/param_id1

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

Bulk delete parameters

edit

To delete multiple parameters, you can send a POST request to /api/synthetics/params/_bulk_delete with an array of parameter IDs to delete via body.

Here is an example of a POST request to delete multiple parameters:

POST /api/synthetics/params/_bulk_delete
{
  "ids": ["param1-id", "param2-id"]
}
« Edit Parameter by ID API Create Private Location API »

On this page

Was this helpful?
Feedback