# bunny.net Documentation: API Reference Documentation ## Documentation ### API Reference - [Introduction](https://bunny.net/docs/api-reference/index.md): Learn about the bunny.net APIs and how to integrate with the platform. - [Quickstart](https://bunny.net/docs/api-reference/quickstart.md): Make your first API request to bunny.net in minutes. - [Authentication](https://bunny.net/docs/api-reference/authentication.md): Learn how to authenticate requests to the bunny.net APIs. - [OpenAPI Specifications](https://bunny.net/docs/openapi.md): Download OpenAPI specification files for bunny.net APIs. ### Core Platform API - [Core API Reference](https://bunny.net/docs/api-reference/core/index.md): Manage your bunny.net account, pull zones, storage zones, DNS, and more. - [Errors](https://bunny.net/docs/api-reference/core/errors.md): Standard HTTP error codes returned by the bunny.net API. - [Statistics API date ranges and granularity](https://bunny.net/docs/api-reference/core/statistics-date-ranges.md): The date ranges the Statistics API endpoints accept, what they default to, and when you can request hourly data. #### Countries - [Get Country List](https://bunny.net/docs/api-reference/core/countries/get-country-list.md) #### DNS Zone - [List DNS Zones](https://bunny.net/docs/api-reference/core/dns-zone/list-dns-zones.md) - [Add DNS Zone](https://bunny.net/docs/api-reference/core/dns-zone/add-dns-zone.md) - [Get DNS Zone](https://bunny.net/docs/api-reference/core/dns-zone/get-dns-zone.md) - [Update DNS Zones](https://bunny.net/docs/api-reference/core/dns-zone/update-dns-zones.md) - [Delete DNS Zone](https://bunny.net/docs/api-reference/core/dns-zone/delete-dns-zone.md) - [Get dnszone export](https://bunny.net/docs/api-reference/core/dns-zone/get-dnszone-export.md) - [Check the DNS zone availability](https://bunny.net/docs/api-reference/core/dns-zone/check-the-dns-zone-availability.md) - [List DNS Zone Records](https://bunny.net/docs/api-reference/core/dns-zone/list-dns-zone-records.md) - [Add DNS Record](https://bunny.net/docs/api-reference/core/dns-zone/add-dns-record.md) - [Update DNS Record](https://bunny.net/docs/api-reference/core/dns-zone/update-dns-record.md) - [Delete DNS Record](https://bunny.net/docs/api-reference/core/dns-zone/delete-dns-record.md) - [Import DNS Records](https://bunny.net/docs/api-reference/core/dns-zone/import-dns-records.md) - [Issue new wildcard certificate](https://bunny.net/docs/api-reference/core/dns-zone/issue-new-wildcard-certificate.md) - [Get DNS Query Statistics](https://bunny.net/docs/api-reference/core/dns-zone/get-dns-query-statistics.md) - [Enable DNSSEC on a DNS Zone](https://bunny.net/docs/api-reference/core/dns-zone/enable-dnssec-on-a-dns-zone.md) - [Disable DNSSEC on a DNS Zone](https://bunny.net/docs/api-reference/core/dns-zone/disable-dnssec-on-a-dns-zone.md) - [Trigger a background scan for pre-existing DNS records. Can use ZoneId for existing zones or Domain for pre-zone creation scenarios.](https://bunny.net/docs/api-reference/core/dns-zone/trigger-a-background-scan-for-pre-existing-dns-records-can-use-zoneid-for-existing-zones-or-domain-for-pre-zone-creation-scenarios.md) - [Get the latest DNS record scan result for a DNS Zone](https://bunny.net/docs/api-reference/core/dns-zone/get-the-latest-dns-record-scan-result-for-a-dns-zone.md) #### Pull Zone - [List Pull Zones](https://bunny.net/docs/api-reference/core/pull-zone/list-pull-zones.md) - [Add Pull Zone](https://bunny.net/docs/api-reference/core/pull-zone/add-pull-zone.md) - [Count Pull Zones](https://bunny.net/docs/api-reference/core/pull-zone/count-pull-zones.md) - [Get Pull Zone](https://bunny.net/docs/api-reference/core/pull-zone/get-pull-zone.md) - [Update Pull Zone](https://bunny.net/docs/api-reference/core/pull-zone/update-pull-zone.md) - [Delete Pull Zone](https://bunny.net/docs/api-reference/core/pull-zone/delete-pull-zone.md) - [Delete Edge Rule](https://bunny.net/docs/api-reference/core/pull-zone/delete-edge-rule.md) - [Add/Update Edge Rule](https://bunny.net/docs/api-reference/core/pull-zone/addupdate-edge-rule.md) - [Set Edge Rule Enabled](https://bunny.net/docs/api-reference/core/pull-zone/set-edge-rule-enabled.md) - [Change hostname private key type](https://bunny.net/docs/api-reference/core/pull-zone/change-hostname-private-key-type.md) - [Load Free Certificate](https://bunny.net/docs/api-reference/core/pull-zone/load-free-certificate.md) - [Request External DNS Certificate](https://bunny.net/docs/api-reference/core/pull-zone/request-external-dns-certificate.md) - [Complete External DNS Certificate](https://bunny.net/docs/api-reference/core/pull-zone/complete-external-dns-certificate.md) - [Request External HTTP Certificate](https://bunny.net/docs/api-reference/core/pull-zone/request-external-http-certificate.md) - [Complete External HTTP Certificate](https://bunny.net/docs/api-reference/core/pull-zone/complete-external-http-certificate.md) - [Purge Cache](https://bunny.net/docs/api-reference/core/pull-zone/purge-cache.md) - [Check the pull zone availability](https://bunny.net/docs/api-reference/core/pull-zone/check-the-pull-zone-availability.md) - [Add Custom Certificate](https://bunny.net/docs/api-reference/core/pull-zone/add-custom-certificate.md) - [Remove Certificate](https://bunny.net/docs/api-reference/core/pull-zone/remove-certificate.md) - [Add Custom Hostname](https://bunny.net/docs/api-reference/core/pull-zone/add-custom-hostname.md) - [Remove Custom Hostname](https://bunny.net/docs/api-reference/core/pull-zone/remove-custom-hostname.md) - [Set Force SSL](https://bunny.net/docs/api-reference/core/pull-zone/set-force-ssl.md) - [Reset Token Key](https://bunny.net/docs/api-reference/core/pull-zone/reset-token-key.md) - [Add Allowed Referer](https://bunny.net/docs/api-reference/core/pull-zone/add-allowed-referer.md) - [Remove Allowed Referer](https://bunny.net/docs/api-reference/core/pull-zone/remove-allowed-referer.md) - [Add Blocked Referer](https://bunny.net/docs/api-reference/core/pull-zone/add-blocked-referer.md) - [Remove Blocked Referer](https://bunny.net/docs/api-reference/core/pull-zone/remove-blocked-referer.md) - [Add Blocked IP](https://bunny.net/docs/api-reference/core/pull-zone/add-blocked-ip.md) - [Remove Blocked IP](https://bunny.net/docs/api-reference/core/pull-zone/remove-blocked-ip.md) #### Purge - [Purge URL](https://bunny.net/docs/api-reference/core/purge/purge-url.md) #### Region - [Region list](https://bunny.net/docs/api-reference/core/region/region-list.md) #### Storage Zone - [List Storage Zones](https://bunny.net/docs/api-reference/core/storage-zone/list-storage-zones.md) - [Add Storage Zone](https://bunny.net/docs/api-reference/core/storage-zone/add-storage-zone.md) - [Check the storage zone availability](https://bunny.net/docs/api-reference/core/storage-zone/check-the-storage-zone-availability.md) - [Get Storage Zone](https://bunny.net/docs/api-reference/core/storage-zone/get-storage-zone.md) - [Update Storage Zone](https://bunny.net/docs/api-reference/core/storage-zone/update-storage-zone.md) - [Delete Storage Zone](https://bunny.net/docs/api-reference/core/storage-zone/delete-storage-zone.md) - [Reset Password](https://bunny.net/docs/api-reference/core/storage-zone/reset-password.md) - [Reset Read-Only Password](https://bunny.net/docs/api-reference/core/storage-zone/reset-read-only-password.md) - [Get Storage Zone Egress Statistics](https://bunny.net/docs/api-reference/core/storage-zone/get-storage-zone-egress-statistics.md) - [Get Storage Zone Regions](https://bunny.net/docs/api-reference/core/storage-zone/get-storage-zone-regions.md) - [Get Storage Zone Statistics](https://bunny.net/docs/api-reference/core/storage-zone/get-storage-zone-statistics.md) #### Stream Video Library - [Add Allowed Referer](https://bunny.net/docs/api-reference/core/stream-video-library/add-allowed-referer.md) - [Add Blocked Referer](https://bunny.net/docs/api-reference/core/stream-video-library/add-blocked-referer.md) - [List Video Libraries](https://bunny.net/docs/api-reference/core/stream-video-library/list-video-libraries.md) - [Add Video Library](https://bunny.net/docs/api-reference/core/stream-video-library/add-video-library.md) - [Add Watermark](https://bunny.net/docs/api-reference/core/stream-video-library/add-watermark.md) - [Delete Watermark](https://bunny.net/docs/api-reference/core/stream-video-library/delete-watermark.md) - [Get Video Library](https://bunny.net/docs/api-reference/core/stream-video-library/get-video-library.md) - [Update Video Library](https://bunny.net/docs/api-reference/core/stream-video-library/update-video-library.md) - [Delete Video Library](https://bunny.net/docs/api-reference/core/stream-video-library/delete-video-library.md) - [Get Languages](https://bunny.net/docs/api-reference/core/stream-video-library/get-languages.md) - [Remove Allowed Referer](https://bunny.net/docs/api-reference/core/stream-video-library/remove-allowed-referer.md) - [Remove Blocked Referer](https://bunny.net/docs/api-reference/core/stream-video-library/remove-blocked-referer.md) - [Reset API Key](https://bunny.net/docs/api-reference/core/stream-video-library/reset-api-key.md) - [Reset Read Only API Key](https://bunny.net/docs/api-reference/core/stream-video-library/reset-read-only-api-key.md) - [Get Video Library Transcribing Statistics](https://bunny.net/docs/api-reference/core/stream-video-library/get-video-library-transcribing-statistics.md) - [Get Video Library DRM Statistics](https://bunny.net/docs/api-reference/core/stream-video-library/get-video-library-drm-statistics.md) #### User - [Close the account](https://bunny.net/docs/api-reference/core/user/close-the-account.md): Close the current user account #### AuditLog - [Get useraudit](https://bunny.net/docs/api-reference/core/auditlog/get-useraudit.md) #### Statistics - [Get optimizer statistics](https://bunny.net/docs/api-reference/core/statistics/get-optimizer-statistics.md) - [Get Origin Shield Queue Statistics](https://bunny.net/docs/api-reference/core/statistics/get-origin-shield-queue-statistics.md) - [Get SafeHop Statistics](https://bunny.net/docs/api-reference/core/statistics/get-safehop-statistics.md) - [Get Statistics](https://bunny.net/docs/api-reference/core/statistics/get-statistics.md) #### Search - [Global Search](https://bunny.net/docs/api-reference/core/search/global-search.md) #### Load Balancer - [Add a new origin to an origin group](https://bunny.net/docs/api-reference/core/load-balancer/add-a-new-origin-to-an-origin-group.md) - [Update an existing origin](https://bunny.net/docs/api-reference/core/load-balancer/update-an-existing-origin.md) - [Delete an origin from an origin group](https://bunny.net/docs/api-reference/core/load-balancer/delete-an-origin-from-an-origin-group.md) - [Add a new origin group to a Load Balancer profile](https://bunny.net/docs/api-reference/core/load-balancer/add-a-new-origin-group-to-a-load-balancer-profile.md) - [Update an origin group in a Load Balancer profile](https://bunny.net/docs/api-reference/core/load-balancer/update-an-origin-group-in-a-load-balancer-profile.md) - [Delete an origin group from a Load Balancer profile](https://bunny.net/docs/api-reference/core/load-balancer/delete-an-origin-group-from-a-load-balancer-profile.md) - [Get the list of Load Balancer profiles](https://bunny.net/docs/api-reference/core/load-balancer/get-the-list-of-load-balancer-profiles.md) - [Create a new Load Balancer profile](https://bunny.net/docs/api-reference/core/load-balancer/create-a-new-load-balancer-profile.md) - [Get a Load Balancer profile](https://bunny.net/docs/api-reference/core/load-balancer/get-a-load-balancer-profile.md) - [Update a Load Balancer profile](https://bunny.net/docs/api-reference/core/load-balancer/update-a-load-balancer-profile.md) - [Delete a Load Balancer profile](https://bunny.net/docs/api-reference/core/load-balancer/delete-a-load-balancer-profile.md) - [Get Load Balancer statistics](https://bunny.net/docs/api-reference/core/load-balancer/get-load-balancer-statistics.md) - [Get the pull zones attached to a Load Balancer](https://bunny.net/docs/api-reference/core/load-balancer/get-the-pull-zones-attached-to-a-load-balancer.md) - [Get statistics roll-ups for all Load Balancers on the account](https://bunny.net/docs/api-reference/core/load-balancer/get-statistics-roll-ups-for-all-load-balancers-on-the-account.md) - [Get current-period request usage and pricing for a Load Balancer](https://bunny.net/docs/api-reference/core/load-balancer/get-current-period-request-usage-and-pricing-for-a-load-balancer.md) #### Billing - [Get Billing Details](https://bunny.net/docs/api-reference/core/billing/get-billing-details.md): Get the billing status details - [Download Payment Request Invoice PDF](https://bunny.net/docs/api-reference/core/billing/download-payment-request-invoice-pdf.md) - [Get Pending Payment Requests](https://bunny.net/docs/api-reference/core/billing/get-pending-payment-requests.md) - [Get Billing Summary Document](https://bunny.net/docs/api-reference/core/billing/get-billing-summary-document.md) - [Get Billing Summary](https://bunny.net/docs/api-reference/core/billing/get-billing-summary.md) #### API Keys - [List API Keys](https://bunny.net/docs/api-reference/core/api-keys/list-api-keys.md) #### Affiliate - [Get affiliate details](https://bunny.net/docs/api-reference/core/affiliate/get-affiliate-details.md) ### Origin Errors API - [Origin Errors API Reference](https://bunny.net/docs/api-reference/origin-errors/index.md): Retrieve origin error logs for your pull zones via HTTP. #### API Reference - [Get origin error logs for a specific Pull Zone and date](https://bunny.net/docs/api-reference/origin-errors/get-origin-error-logs-for-a-specific-pull-zone-and-date.md): Retrieves origin error logs for the given Pull Zone and date. ### CDN Logging API - [Logging API Reference](https://bunny.net/docs/api-reference/cdn-logging/index.md): Access raw CDN request logs for your pull zones via HTTP. #### Logging v1 - [Query logs (legacy)](https://bunny.net/docs/api-reference/cdn-logging/logging-v1/query-logs-legacy.md) #### Logging v2 - [Query CDN access logs for a pull zone.](https://bunny.net/docs/api-reference/cdn-logging/logging-v2/query-cdn-access-logs-for-a-pull-zone.md): Authenticate with either an `Authorization` bearer JWT or an `AccessKey` header. Filter pushdown happens in ClickHouse where possible; `country` and free-text `search` are applied in-process after fetch. ### Storage API - [Storage API Reference](https://bunny.net/docs/api-reference/storage/index.md): Upload, download, and manage files in your storage zones via HTTP. #### Manage Files - [Download File](https://bunny.net/docs/api-reference/storage/manage-files/download-file.md): Returns the stored file at the given path. If the file does not exist, a 404 response will be returned. - [Upload File](https://bunny.net/docs/api-reference/storage/manage-files/upload-file.md): Upload a file to a storage zone based on the URL path. If the directory tree does not exist, it will be created automatically. **The file content should be sent as the body of the request without any type of encoding.** - [Delete File](https://bunny.net/docs/api-reference/storage/manage-files/delete-file.md): Delete an object from the storage zone. In case the object is a directory all the data in it will be recursively deleted as well. #### Browse Files - [List Files](https://bunny.net/docs/api-reference/storage/browse-files/list-files.md): Retrieve a list of files and directories located in the given directory. ### Stream API - [Stream API Reference](https://bunny.net/docs/api-reference/stream/index.md): Upload, manage, and deliver videos with the Stream API. #### Manage Collections - [Get Collection](https://bunny.net/docs/api-reference/stream/manage-collections/get-collection.md): Returns the details of a collection. Collections can group both videos and live streams, reflected separately in VideoCount and LiveStreamCount; PreviewImageUrls only reflects the videos in the collection. - [Update Collection](https://bunny.net/docs/api-reference/stream/manage-collections/update-collection.md) - [Delete Collection](https://bunny.net/docs/api-reference/stream/manage-collections/delete-collection.md): Permanently deletes the collection together with every video and live stream it contains — nothing is moved out of the collection first, it is deleted along with it. Fails with 400 if the collection contains a currently running live stream; stop it before deleting the collection. This cannot be undo… - [Get Collection List](https://bunny.net/docs/api-reference/stream/manage-collections/get-collection-list.md): Returns a paginated list of collections for the library. Collections can group both videos and live streams, reflected separately in VideoCount and LiveStreamCount; preview thumbnails only reflect the videos in each collection. When includeThumbnails is true, preview thumbnails are only populated fo… - [Create Collection](https://bunny.net/docs/api-reference/stream/manage-collections/create-collection.md) #### Encoding Statistics - [Get Encoding Statistics](https://bunny.net/docs/api-reference/stream/encoding-statistics/get-encoding-statistics.md): Returns video encoding seconds for the library, split into premium and free tier. Each includes billable (normalized) and output seconds over time, plus totals by video codec, resolution, and JIT vs standard encoding. Data is available starting 2026-06-15. #### Manage Videos - [Get Video](https://bunny.net/docs/api-reference/stream/manage-videos/get-video.md) - [Upload Video](https://bunny.net/docs/api-reference/stream/manage-videos/upload-video.md) - [Update Video](https://bunny.net/docs/api-reference/stream/manage-videos/update-video.md) - [Delete Video](https://bunny.net/docs/api-reference/stream/manage-videos/delete-video.md): Deletes the video. This cannot be undone. The video stops appearing in lookups right away, but playback may still be possible for some time afterward before access is fully revoked. - [Get Video Heatmap](https://bunny.net/docs/api-reference/stream/manage-videos/get-video-heatmap.md): Returns the attention heatmap for a specific video, showing relative viewer interest across the timeline. May be unavailable if the feature is disabled or there isn't enough viewing data. - [Get Video play data](https://bunny.net/docs/api-reference/stream/manage-videos/get-video-play-data.md): Returns playback URLs and metadata for the video. For libraries with token authentication enabled, token and expires must be a valid signed pair or the request is rejected. - [Get Video heatmap data](https://bunny.net/docs/api-reference/stream/manage-videos/get-video-heatmap-data.md): Returns raw heatmap data for the video, used to render the attention heatmap on the player timeline. Returns an empty string if the library has heatmaps disabled or no heatmap data exists yet. - [Get Video Statistics](https://bunny.net/docs/api-reference/stream/manage-videos/get-video-statistics.md): Returns time-series views and watch time, plus country-level aggregates, at the library level or for a specific video. Control the time window with dateFrom/dateTo and the granularity with hourly. Statistics are available for the last 1 year. Basic safeguards prevent spam and bot inflation by de-dup… - [Reencode Video](https://bunny.net/docs/api-reference/stream/manage-videos/reencode-video.md): Re-encodes the video from its stored original file. Requires the original file to still be present in storage. If the library has transcribing enabled, this also re-queues (and re-bills) transcription. - [Add output codec to video](https://bunny.net/docs/api-reference/stream/manage-videos/add-output-codec-to-video.md): Encodes and adds an additional output codec to an already-encoded video. Requires Premium Encoding to be enabled for the library and the codec to already be enabled for the library, and fails if the original source file is missing or the codec was already processed. - [Repackage Video](https://bunny.net/docs/api-reference/stream/manage-videos/repackage-video.md): Repackages the video from its existing .ts/.m4s segments without re-transcoding, primarily used to apply Enterprise DRM. - [List Videos](https://bunny.net/docs/api-reference/stream/manage-videos/list-videos.md) - [Create Video](https://bunny.net/docs/api-reference/stream/manage-videos/create-video.md) - [Set Thumbnail](https://bunny.net/docs/api-reference/stream/manage-videos/set-thumbnail.md): Sets the video's thumbnail. If thumbnailUrl is omitted, the thumbnail is read from the request body as a raw image upload. If thumbnailUrl is one of thumbnail_1.jpg…thumbnail_5.jpg, an existing auto-generated thumbnail for the video is used instead. Any other value is fetched by the server as a URL,… - [Fetch Video](https://bunny.net/docs/api-reference/stream/manage-videos/fetch-video.md) - [Add Caption](https://bunny.net/docs/api-reference/stream/manage-videos/add-caption.md) - [Delete Caption](https://bunny.net/docs/api-reference/stream/manage-videos/delete-caption.md) - [Transcribe video](https://bunny.net/docs/api-reference/stream/manage-videos/transcribe-video.md): Queues transcription for the video, generating captions. By default this is blocked if the video was already auto-transcribed; set force to true to re-queue (and re-bill) transcription anyway. - [Trigger Smart actions](https://bunny.net/docs/api-reference/stream/manage-videos/trigger-smart-actions.md): Queues Smart Actions (title, description, chapters and/or moments generation) for a video that already has captions. This endpoint does not check the video library's Smart Actions setting — requests are accepted, processed and billed for transcription usage even when Smart Actions is disabled for th… - [Video resolutions info](https://bunny.net/docs/api-reference/stream/manage-videos/video-resolutions-info.md) - [Get video storage size info](https://bunny.net/docs/api-reference/stream/manage-videos/get-video-storage-size-info.md) - [Cleanup unconfigured resolutions](https://bunny.net/docs/api-reference/stream/manage-videos/cleanup-unconfigured-resolutions.md): Deletes stored resolution files that are no longer configured for the library, or the specific resolutions passed in resolutionsToDelete/allResolutions. This cannot be undone. If the library has 'keep original files' turned off, the original source file is also deleted as part of this cleanup even w… #### OEmbed - [Get oEmbed data](https://bunny.net/docs/api-reference/stream/oembed/get-oembed-data.md): Implements the oEmbed specification (oembed.com) for bunny.net video embed URLs, allowing third-party sites and tools to auto-generate an embeddable player for a pasted video link. url must be a bunny.net player URL for an existing video — either the legacy player (e.g. "https://iframe.mediadelivery… ### Shield API - [Shield API Reference](https://bunny.net/docs/api-reference/shield/index.md): Configure WAF rules, rate limiting, and security settings via HTTP. #### Access Lists - [Get all Access Lists available for a Shield Zone](https://bunny.net/docs/api-reference/shield/access-lists/get-all-access-lists-available-for-a-shield-zone.md) - [Create a new Custom Access List associated with a Shield Zone](https://bunny.net/docs/api-reference/shield/access-lists/create-a-new-custom-access-list-associated-with-a-shield-zone.md) - [Update Access List Configuration for a Shield Zone](https://bunny.net/docs/api-reference/shield/access-lists/update-access-list-configuration-for-a-shield-zone.md) - [Get the specified Custom Access List associated with a Shield Zone](https://bunny.net/docs/api-reference/shield/access-lists/get-the-specified-custom-access-list-associated-with-a-shield-zone.md) - [Delete the specified Custom Access List associated with a Shield Zone](https://bunny.net/docs/api-reference/shield/access-lists/delete-the-specified-custom-access-list-associated-with-a-shield-zone.md) - [Update the specified Custom Access List associated with a Shield Zone](https://bunny.net/docs/api-reference/shield/access-lists/update-the-specified-custom-access-list-associated-with-a-shield-zone.md) - [Get all Access Lists API enumeration types and their values](https://bunny.net/docs/api-reference/shield/access-lists/get-all-access-lists-api-enumeration-types-and-their-values.md) #### API Guardian - [Get the API Guardian configuration and endpoints.](https://bunny.net/docs/api-reference/shield/api-guardian/get-the-api-guardian-configuration-and-endpoints.md) - [Update the API Guardian configuration (enabled, execution mode, body limit action)](https://bunny.net/docs/api-reference/shield/api-guardian/update-the-api-guardian-configuration-enabled-execution-mode-body-limit-action.md) - [Update your API Guardian Endpoint configuration](https://bunny.net/docs/api-reference/shield/api-guardian/update-your-api-guardian-endpoint-configuration.md) - [Upload your OpenAPI specification](https://bunny.net/docs/api-reference/shield/api-guardian/upload-your-openapi-specification.md) - [Update your OpenAPI specification](https://bunny.net/docs/api-reference/shield/api-guardian/update-your-openapi-specification.md) - [Get all API Guardian enumeration types and their values](https://bunny.net/docs/api-reference/shield/api-guardian/get-all-api-guardian-enumeration-types-and-their-values.md) #### Bot Categorization - [List bots available for explicit allow/block configuration on this Shield Zone, grouped by category.](https://bunny.net/docs/api-reference/shield/bot-categorization/list-bots-available-for-explicit-allowblock-configuration-on-this-shield-zone-grouped-by-category.md) - [Set or clear the action applied to a categorised bot for this Shield Zone.](https://bunny.net/docs/api-reference/shield/bot-categorization/set-or-clear-the-action-applied-to-a-categorised-bot-for-this-shield-zone.md) - [Set or clear the action applied to every bot in a category for this Shield Zone.](https://bunny.net/docs/api-reference/shield/bot-categorization/set-or-clear-the-action-applied-to-every-bot-in-a-category-for-this-shield-zone.md) #### Bot Detection - [Your current Bot Detection configuration](https://bunny.net/docs/api-reference/shield/bot-detection/your-current-bot-detection-configuration.md) - [Update your current Bot Detection configuration](https://bunny.net/docs/api-reference/shield/bot-detection/update-your-current-bot-detection-configuration.md) #### Custom Response Pages - [Get a custom HTML response page for a Shield Zone](https://bunny.net/docs/api-reference/shield/custom-response-pages/get-a-custom-html-response-page-for-a-shield-zone.md) - [Upload a custom HTML response page for a Shield Zone](https://bunny.net/docs/api-reference/shield/custom-response-pages/upload-a-custom-html-response-page-for-a-shield-zone.md) - [Delete a custom HTML response page for a Shield Zone](https://bunny.net/docs/api-reference/shield/custom-response-pages/delete-a-custom-html-response-page-for-a-shield-zone.md) #### DDoS - [List of all DDoS Enum Mappings](https://bunny.net/docs/api-reference/shield/ddos/list-of-all-ddos-enum-mappings.md) #### Event Logs - [Get Event Logs for Shield Zone](https://bunny.net/docs/api-reference/shield/event-logs/get-event-logs-for-shield-zone.md) - [Search, filter and group Event Logs for a Shield Zone](https://bunny.net/docs/api-reference/shield/event-logs/search-filter-and-group-event-logs-for-a-shield-zone.md) - [Export the full filtered Event Logs set for a Shield Zone as CSV](https://bunny.net/docs/api-reference/shield/event-logs/export-the-full-filtered-event-logs-set-for-a-shield-zone-as-csv.md) #### Metrics - [Get the overage breakdown for the specified Shield Zone for a given month, segmented by billing plan changes](https://bunny.net/docs/api-reference/shield/metrics/get-the-overage-breakdown-for-the-specified-shield-zone-for-a-given-month-segmented-by-billing-plan-changes.md) - [Get an overview of metrics for the specified Shield Zone](https://bunny.net/docs/api-reference/shield/metrics/get-an-overview-of-metrics-for-the-specified-shield-zone.md) - [Get a detailed metrics overview for the specified Shield Zone within the selected time range and resolution](https://bunny.net/docs/api-reference/shield/metrics/get-a-detailed-metrics-overview-for-the-specified-shield-zone-within-the-selected-time-range-and-resolution.md) - [Get aggregated rate limit metrics for the specified Shield Zone](https://bunny.net/docs/api-reference/shield/metrics/get-aggregated-rate-limit-metrics-for-the-specified-shield-zone.md) - [Get detailed metrics for the specified Rate Limit](https://bunny.net/docs/api-reference/shield/metrics/get-detailed-metrics-for-the-specified-rate-limit.md) - [Get metrics for a specific WAF Rule within the specified Shield Zone](https://bunny.net/docs/api-reference/shield/metrics/get-metrics-for-a-specific-waf-rule-within-the-specified-shield-zone.md) - [Get bot detection metrics for the specified Shield Zone](https://bunny.net/docs/api-reference/shield/metrics/get-bot-detection-metrics-for-the-specified-shield-zone.md) - [Get upload scanning metrics for the specified Shield Zone](https://bunny.net/docs/api-reference/shield/metrics/get-upload-scanning-metrics-for-the-specified-shield-zone.md) - [Get API Guardian metrics for the specified Shield Zone](https://bunny.net/docs/api-reference/shield/metrics/get-api-guardian-metrics-for-the-specified-shield-zone.md) - [Get metrics for a specific API Guardian endpoint within the specified Shield Zone](https://bunny.net/docs/api-reference/shield/metrics/get-metrics-for-a-specific-api-guardian-endpoint-within-the-specified-shield-zone.md) #### Promotions - [Get the current Promotion State for your Account](https://bunny.net/docs/api-reference/shield/promotions/get-the-current-promotion-state-for-your-account.md) #### Rate Limiting - [Get Rate Limits for your Shield Zone](https://bunny.net/docs/api-reference/shield/rate-limiting/get-rate-limits-for-your-shield-zone.md) - [Get Individual Rate Limit for your Shield Zone](https://bunny.net/docs/api-reference/shield/rate-limiting/get-individual-rate-limit-for-your-shield-zone.md) - [Delete a Rate Limit on your Shield Zone](https://bunny.net/docs/api-reference/shield/rate-limiting/delete-a-rate-limit-on-your-shield-zone.md) - [Update a Rate Limit configuration on your Shield Zone](https://bunny.net/docs/api-reference/shield/rate-limiting/update-a-rate-limit-configuration-on-your-shield-zone.md) - [Create a Rate Limit for your Shield Zone](https://bunny.net/docs/api-reference/shield/rate-limiting/create-a-rate-limit-for-your-shield-zone.md) #### Shield Zone - [Get all of your Shield Zone Configurations](https://bunny.net/docs/api-reference/shield/shield-zone/get-all-of-your-shield-zone-configurations.md) - [Get Active Shield Zones for Pullzone Mapping](https://bunny.net/docs/api-reference/shield/shield-zone/get-active-shield-zones-for-pullzone-mapping.md) - [Get Singular Shield Zone Configuration](https://bunny.net/docs/api-reference/shield/shield-zone/get-singular-shield-zone-configuration.md) - [Get Singular Shield Zone Configuration for PullZone](https://bunny.net/docs/api-reference/shield/shield-zone/get-singular-shield-zone-configuration-for-pullzone.md) - [Get the recommended defaults for creating a Shield Zone](https://bunny.net/docs/api-reference/shield/shield-zone/get-the-recommended-defaults-for-creating-a-shield-zone.md) - [Create a Shield Zone in under-attack mode for your PullZone](https://bunny.net/docs/api-reference/shield/shield-zone/create-a-shield-zone-in-under-attack-mode-for-your-pullzone.md) - [Create a Shield Zone for your PullZone](https://bunny.net/docs/api-reference/shield/shield-zone/create-a-shield-zone-for-your-pullzone.md) - [Update your Shield Zone configuration](https://bunny.net/docs/api-reference/shield/shield-zone/update-your-shield-zone-configuration.md) #### Upload Scanning - [Get your Current Upload Scanning Configuration](https://bunny.net/docs/api-reference/shield/upload-scanning/get-your-current-upload-scanning-configuration.md) - [Update your Upload Scanning Configuration](https://bunny.net/docs/api-reference/shield/upload-scanning/update-your-upload-scanning-configuration.md) #### WAF - [Retrieve all available WAF rules for a Shield Zone](https://bunny.net/docs/api-reference/shield/waf/retrieve-all-available-waf-rules-for-a-shield-zone.md) - [Retrieve WAF rules segmented by subscription plan](https://bunny.net/docs/api-reference/shield/waf/retrieve-waf-rules-segmented-by-subscription-plan.md) - [Review all triggered WAF rules for the specified Shield Zone](https://bunny.net/docs/api-reference/shield/waf/review-all-triggered-waf-rules-for-the-specified-shield-zone.md) - [Review and update the action of a triggered WAF rule](https://bunny.net/docs/api-reference/shield/waf/review-and-update-the-action-of-a-triggered-waf-rule.md) - [Retrieve an AI recommendation for a triggered WAF rule](https://bunny.net/docs/api-reference/shield/waf/retrieve-an-ai-recommendation-for-a-triggered-waf-rule.md) - [Retrieve custom WAF rules configured for the specified Shield Zone](https://bunny.net/docs/api-reference/shield/waf/retrieve-custom-waf-rules-configured-for-the-specified-shield-zone.md) - [Retrieve a specific custom WAF rule](https://bunny.net/docs/api-reference/shield/waf/retrieve-a-specific-custom-waf-rule.md) - [Update an existing custom WAF rule](https://bunny.net/docs/api-reference/shield/waf/update-an-existing-custom-waf-rule.md) - [Delete a custom WAF rule](https://bunny.net/docs/api-reference/shield/waf/delete-a-custom-waf-rule.md) - [Update an existing custom WAF rule](https://bunny.net/docs/api-reference/shield/waf/update-an-existing-custom-waf-rule-1.md) - [Create a new custom WAF rule](https://bunny.net/docs/api-reference/shield/waf/create-a-new-custom-waf-rule.md) - [Retrieve all available WAF profiles](https://bunny.net/docs/api-reference/shield/waf/retrieve-all-available-waf-profiles.md) - [Retrieve all available WAF enum mappings](https://bunny.net/docs/api-reference/shield/waf/retrieve-all-available-waf-enum-mappings.md) - [Retrieve the default WAF engine configuration](https://bunny.net/docs/api-reference/shield/waf/retrieve-the-default-waf-engine-configuration.md) ### Edge Scripting API - [Edge Scripting API Reference](https://bunny.net/docs/api-reference/scripting/index.md): Deploy, manage, and monitor edge scripts via HTTP. #### Code - [Get Code](https://bunny.net/docs/api-reference/scripting/code/get-code.md) - [Set Code](https://bunny.net/docs/api-reference/scripting/code/set-code.md) #### Edge Script - [Get Edge Script](https://bunny.net/docs/api-reference/scripting/edge-script/get-edge-script.md) - [Update Edge Script](https://bunny.net/docs/api-reference/scripting/edge-script/update-edge-script.md) - [Delete Edge Script](https://bunny.net/docs/api-reference/scripting/edge-script/delete-edge-script.md) - [Get Edge Script Statistics](https://bunny.net/docs/api-reference/scripting/edge-script/get-edge-script-statistics.md) - [List Edge Scripts](https://bunny.net/docs/api-reference/scripting/edge-script/list-edge-scripts.md) - [Add Edge Script](https://bunny.net/docs/api-reference/scripting/edge-script/add-edge-script.md) - [Rotate Deployment Key](https://bunny.net/docs/api-reference/scripting/edge-script/rotate-deployment-key.md) #### Variable - [Add Variable](https://bunny.net/docs/api-reference/scripting/variable/add-variable.md) - [Get Variable](https://bunny.net/docs/api-reference/scripting/variable/get-variable.md) - [Update Variable](https://bunny.net/docs/api-reference/scripting/variable/update-variable.md) - [Delete Variable](https://bunny.net/docs/api-reference/scripting/variable/delete-variable.md) - [Upsert Variable](https://bunny.net/docs/api-reference/scripting/variable/upsert-variable.md) #### Secret - [List Secrets](https://bunny.net/docs/api-reference/scripting/secret/list-secrets.md) - [Upsert Secret](https://bunny.net/docs/api-reference/scripting/secret/upsert-secret.md) - [Add Secret](https://bunny.net/docs/api-reference/scripting/secret/add-secret.md) - [Update Secret](https://bunny.net/docs/api-reference/scripting/secret/update-secret.md) - [Delete Secret](https://bunny.net/docs/api-reference/scripting/secret/delete-secret.md) #### Release - [Get Active Release](https://bunny.net/docs/api-reference/scripting/release/get-active-release.md) - [Get Releases](https://bunny.net/docs/api-reference/scripting/release/get-releases.md) - [Publish Release](https://bunny.net/docs/api-reference/scripting/release/publish-release.md) - [Publish Release](https://bunny.net/docs/api-reference/scripting/release/publish-release-1.md) ### Magic Containers API - [Magic Containers API Reference](https://bunny.net/docs/api-reference/magic-containers/overview.md): Create, modify or delete your Magic Containers applications configuration. #### Applications - [Deploy Application](https://bunny.net/docs/api-reference/magic-containers/applications/deploy-application.md): Deploys an application, making it active and running. - [Undeploy Application](https://bunny.net/docs/api-reference/magic-containers/applications/undeploy-application.md): Undeploys an application, stopping all running instances. - [Get Application Statistics](https://bunny.net/docs/api-reference/magic-containers/applications/get-application-statistics.md): Retrieves historical statistics for an application including CPU, RAM, traffic, latency, and volume usage over a specified time period. - [Get Application Usage Summary](https://bunny.net/docs/api-reference/magic-containers/applications/get-application-usage-summary.md): Retrieves usage summary for an application including latency, volume size, monthly cost, and status information. - [Get Application Overview](https://bunny.net/docs/api-reference/magic-containers/applications/get-application-overview.md): Retrieves comprehensive status overview for an application including latency, CPU/RAM usage, active instances, regions, and cost information. - [List Applications](https://bunny.net/docs/api-reference/magic-containers/applications/list-applications.md): Lists all applications for the authenticated user with their current status. - [Add Application](https://bunny.net/docs/api-reference/magic-containers/applications/add-application.md): Creates a new application with the specified configuration including containers, volumes, region settings, and autoscaling. - [Get application](https://bunny.net/docs/api-reference/magic-containers/applications/get-application.md) - [Update Application](https://bunny.net/docs/api-reference/magic-containers/applications/update-application.md): Updates an existing application with full replacement of all configuration fields. - [Delete Application](https://bunny.net/docs/api-reference/magic-containers/applications/delete-application.md): Marks the application for deletion and enqueues cleanup of all associated resources. Returns immediately; deletion is processed asynchronously. - [Patch Application](https://bunny.net/docs/api-reference/magic-containers/applications/patch-application.md): Partially updates an existing application using JSON Merge Patch semantics. Only provided fields will be updated; existing fields not included in the request will remain unchanged. For arrays (containers, volumes, endpoints), items with matching IDs will be updated, items without IDs will be added a… - [Restart Application](https://bunny.net/docs/api-reference/magic-containers/applications/restart-application.md): Triggers a restart of all pods for the specified application. #### AutoscalingSettings - [Get Application Autoscaling](https://bunny.net/docs/api-reference/magic-containers/autoscalingsettings/get-application-autoscaling.md): Retrieves the current autoscaling settings for an application, including minimum and maximum replica counts. - [Update Application Autoscaling](https://bunny.net/docs/api-reference/magic-containers/autoscalingsettings/update-application-autoscaling.md): Updates the autoscaling settings for an application, including minimum and maximum replica counts. #### ContainerRegistries - [List Container Registries](https://bunny.net/docs/api-reference/magic-containers/containerregistries/list-container-registries.md): Lists all container registries configured for the authenticated user. - [Add container registry](https://bunny.net/docs/api-reference/magic-containers/containerregistries/add-container-registry.md): Add a container registry for user. - [Search Public Container Images](https://bunny.net/docs/api-reference/magic-containers/containerregistries/search-public-container-images.md): Searches for public container images in a registry by prefix. - [List Container Images](https://bunny.net/docs/api-reference/magic-containers/containerregistries/list-container-images.md): Lists all container images available in a private registry. - [Get Container Registry](https://bunny.net/docs/api-reference/magic-containers/containerregistries/get-container-registry.md): Retrieves a specific container registry by its ID. - [Update Container Registry](https://bunny.net/docs/api-reference/magic-containers/containerregistries/update-container-registry.md): Updates an existing container registry configuration including credentials. - [Delete Container Registry](https://bunny.net/docs/api-reference/magic-containers/containerregistries/delete-container-registry.md): Deletes a container registry. Returns an error if the registry is currently in use by any applications. - [List Container Image Tags](https://bunny.net/docs/api-reference/magic-containers/containerregistries/list-container-image-tags.md): Lists all available tags for a specific container image. - [List Container Image Tags Page](https://bunny.net/docs/api-reference/magic-containers/containerregistries/list-container-image-tags-page.md): Lists one page of the tags of a container image, in the order the registry returns them (newest first for Docker Hub images whose tags the registry can't list in time). The response cursor is the cursor of the next page; it is empty on the last page. - [Get Image Config](https://bunny.net/docs/api-reference/magic-containers/containerregistries/get-image-config.md): Retrieves endpoint and volume suggestions for a container image from a registry. - [Get Container Image Digest](https://bunny.net/docs/api-reference/magic-containers/containerregistries/get-container-image-digest.md): Retrieves the digest information for a specific container image tag. - [Get Container Config Suggestions](https://bunny.net/docs/api-reference/magic-containers/containerregistries/get-container-config-suggestions.md): Gets recommended configuration for a container image including endpoint configurations and environment variables. - [Find Container Image](https://bunny.net/docs/api-reference/magic-containers/containerregistries/find-container-image.md): Parses an image reference like "ghcr.io/owner/app:v1" or "owner/app" and checks whether the image tag exists in the selected registries of the user (only those of the reference's host when it has one). Returns every registry that has the image tag with its id, hostname, the image namespace, name, ta… #### Containers - [Set Container Environment Variables](https://bunny.net/docs/api-reference/magic-containers/containers/set-container-environment-variables.md): Replaces all environment variables for a container template. All existing environment variables will be removed and replaced with the provided set. - [Get Container Template](https://bunny.net/docs/api-reference/magic-containers/containers/get-container-template.md): Gets a container template within an application. - [Delete Container Template](https://bunny.net/docs/api-reference/magic-containers/containers/delete-container-template.md): Deletes a container template from an application. - [Patch Container Template](https://bunny.net/docs/api-reference/magic-containers/containers/patch-container-template.md): Partially updates a container template within an application. Only provided fields will be updated; existing fields not included in the request will remain unchanged. - [Add Container Template](https://bunny.net/docs/api-reference/magic-containers/containers/add-container-template.md): Adds a new container template to an application. #### Endpoints - [Update Application Endpoint](https://bunny.net/docs/api-reference/magic-containers/endpoints/update-application-endpoint.md): Update an existing endpoint for given application - [Delete application endpoint](https://bunny.net/docs/api-reference/magic-containers/endpoints/delete-application-endpoint.md): Delete endpoint of a container for given application. - [List application endpoints](https://bunny.net/docs/api-reference/magic-containers/endpoints/list-application-endpoints.md): List endpoints from all containers for given application - [Add application endpoint](https://bunny.net/docs/api-reference/magic-containers/endpoints/add-application-endpoint.md): Add CDN or Anycast endpoint to a container of given application. #### Limits - [Get User Limits](https://bunny.net/docs/api-reference/magic-containers/limits/get-user-limits.md): Retrieves the current resource limits and usage for the authenticated user, including application counts and instance limits. #### Nodes - [List Nodes](https://bunny.net/docs/api-reference/magic-containers/nodes/list-nodes.md): Lists all node IP addresses in the Magic Containers network. - [List Node IPs (Plain)](https://bunny.net/docs/api-reference/magic-containers/nodes/list-node-ips-plain.md): Lists all node IP addresses in the Magic Containers network as a flat list. #### Pods - [Recreate Pod](https://bunny.net/docs/api-reference/magic-containers/pods/recreate-pod.md): Recreate a pod, deleting previous one. #### Regions - [List Regions](https://bunny.net/docs/api-reference/magic-containers/regions/list-regions.md): Lists all available regions where applications can be deployed, including their anycast support and capacity status. - [Get Optimal Base Region](https://bunny.net/docs/api-reference/magic-containers/regions/get-optimal-base-region.md): Returns the optimal base region for deployment based on the user's CDN server token location. #### RegionSettings - [Get Application Region Settings](https://bunny.net/docs/api-reference/magic-containers/regionsettings/get-application-region-settings.md): Retrieves the current region settings for an application, including allowed regions, required regions, and maximum allowed regions. - [Update Application Region Settings](https://bunny.net/docs/api-reference/magic-containers/regionsettings/update-application-region-settings.md): Updates the region settings for an application, including allowed regions, required regions, and maximum allowed regions. #### Volumes - [Delete All Volume Instances](https://bunny.net/docs/api-reference/magic-containers/volumes/delete-all-volume-instances.md): Deletes all volume instances for a volume template. All instances must be detached before deletion. - [Update Volume](https://bunny.net/docs/api-reference/magic-containers/volumes/update-volume.md): Partially updates a volume template's configuration including name and size. Only provided fields will be updated. - [List Volumes](https://bunny.net/docs/api-reference/magic-containers/volumes/list-volumes.md): Lists all volume templates and their instances for an application, including usage statistics. - [Detach Volume](https://bunny.net/docs/api-reference/magic-containers/volumes/detach-volume.md): Detaches a volume template from all application containers. - [Delete Volume Instance](https://bunny.net/docs/api-reference/magic-containers/volumes/delete-volume-instance.md): Deletes a specific volume instance. The volume must be detached before deletion. #### Log Forwarding - [List log-forwarding configurations](https://bunny.net/docs/api-reference/magic-containers/log-forwarding/list-log-forwarding-configurations.md): Get a list of all log-forwarding configurations for the authenticated user. - [Create log forwarding configuration](https://bunny.net/docs/api-reference/magic-containers/log-forwarding/create-log-forwarding-configuration.md): Create a new log forwarding configuration. - [Get log-forwarding configuration](https://bunny.net/docs/api-reference/magic-containers/log-forwarding/get-log-forwarding-configuration.md): Get a specific log-forwarding configuration by ID. - [Update log-forwarding configuration](https://bunny.net/docs/api-reference/magic-containers/log-forwarding/update-log-forwarding-configuration.md): Update an existing log-forwarding configuration. - [Delete log-forwarding configuration](https://bunny.net/docs/api-reference/magic-containers/log-forwarding/delete-log-forwarding-configuration.md): Delete a log-forwarding configuration. ## OpenAPI Specs - [public](https://core-api-public-docs.b-cdn.net/docs/v3/public.json) - [openapi](/docs/api-reference/origin-errors/openapi.json) - [swagger](https://logging.bunnycdn.com/docs/all/swagger.json) - [openapi](/docs/api-reference/storage/openapi.json) - [bunnynet-video-api.public](https://video.bunnycdn.com/openapi/bunnynet-video-api.public.json) - [swagger](https://api.bunny.net/shield/docs/v1/swagger.json) - [compute](https://core-api-public-docs.b-cdn.net/docs/v3/compute.json) - [swagger](https://api-mc.opsbunny.net/docs/public/swagger.json)