Banners

Delete a banner

DELETE/banners/{id}
banners:writedelete_bannerDestructiveIdempotent

Deletes the banner so it stops showing, returning 204. Its role links are kept. Needs permission to change the organisation. It has no dry run. Emits banner.deleted; no email. It cannot be undone through the API.

Path parameters

  • idintegerRequired#

    The banner's id. Banners are keyed by integer ids, not UUIDs: a whole number from 1 to 2147483647.

Responses

204

The banner 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/banners/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"