synthetics

Delete a parameter

Spaces method and path for this operation:

<div><span class="operation-verb delete">delete</span>&nbsp;<span class="operation-path">/s/{space_id}/api/synthetics/params/{id}</span></div>

Refer to Spaces for more information.

Delete a parameter from the Synthetics app.

You must have all privileges for the Synthetics feature in the Observability section of the Kibana feature privileges.<br/><br/>[Required authorization] Route required privileges: uptime-read AND uptime-write.

delete/api/synthetics/params/{id}

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/synthetics/params/{id}
  • Auth
    • API key in header Authorization
    • or HTTP basic

Path parameters

idstring required

The ID for the parameter to delete.

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Response

A successful response.

deletedboolean

If true, the object was deleted. If false, it was not deleted.

idstring

The unique identifier of the deleted object.

Changes

No operation changes recorded.