Dashboards

Delete a dashboard

DELETE/dashboards/{id}
dashboards:writedelete_dashboardDestructiveIdempotent

Deletes the dashboard, returning 204; users it served fall back to the default dashboard of its type, if any. It has no dry run. Emits dashboard.deleted; no email. It cannot be undone through the API, but its type and user type are free to create again.

Path parameters

  • idstring (uuid)Required#

    The dashboard's id, a UUID.

Responses

204

The dashboard was deleted.

401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X DELETE https://your-org-domain/kong/core/api/v2/dashboards/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"