Delete a parameter

Auth

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.

Required authorization

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
id string · min length: 1 · max length: 1024 required: The ID for the parameter to delete.

kbn-xsrf string required: A required header to protect against CSRF attacks

A successful response.

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

DELETE kbn://api/synthetics/params/param-id

curl Shell

curl \
  -X DELETE "${KIBANA_URL}/api/synthetics/params/param-id" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "kbn-xsrf: true"

Response

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