Configuration - Khanh Docs

This guide covers how to configure the Bunny provider for Pulumi.

Overview#

The Bunny provider requires an API key for authentication. You can manage CDN pull zones, storage zones, and edge compute scripts.

Provider Configuration#

Basic Setup#

import * as bunnynet from "pulumi-bunnynet";// Configure the provider with API keyconst config = new pulumi.Config("bunnynet");const apiKey = config.requireSecret("apiKey");

Configuration Methods#

1. Provider Block (Recommended)#

import * as bunnynet from "pulumi-bunnynet";import * as pulumi from "@pulumi/pulumi";const config = new pulumi.Config("bunnynet");// API key from Pulumi configconst provider = new bunnynet.Provider("bunnynet", {    apiKey: config.requireSecret("apiKey"),});

2. Environment Variables#

export BUNNY_API_KEY="your-api-key-here"

3. Pulumi Configuration#

# Set API key (encrypted)pulumi config set bunnynet:apiKey --secret <your-api-key># Verify configurationpulumi config get bunnynet:apiKey

Getting API Credentials#

Create API Key#

Log in to Bunny.net dashboard
Navigate to Account → API
Click Add API Key
Name your key (e.g., "Pulumi Integration")
Set appropriate permissions
Copy the generated API key

Required Permissions#

For full management capabilities:

Pull Zones: Read, Write
Storage Zones: Read, Write
Billing: Read (for usage monitoring)
Statistics: Read (for analytics)

Configuration Options#

Property	Type	Required	Description
`apiKey`	string	Yes	Bunny.net API key

Best Practices#

Security#

// ✅ DO: Use Pulumi secrets for API keysconst config = new pulumi.Config("bunnynet");const apiKey = config.requireSecret("apiKey");// ❌ DON'T: Hardcode API keysconst provider = new bunnynet.Provider("bad", {    apiKey: "abc123...",  // Never do this!});

Multi-Account Setup#

// Production accountconst prodProvider = new bunnynet.Provider("prod", {    apiKey: prodConfig.requireSecret("apiKey"),});// Development accountconst devProvider = new bunnynet.Provider("dev", {    apiKey: devConfig.requireSecret("apiKey"),});

Integration Examples#

With Pull Zone#

import * as bunnynet from "pulumi-bunnynet";// Create a CDN pull zone with a URL originconst pullZone = new bunnynet.Pullzone("website-cdn", {    name: "example-cdn",    origin: {        type: "OriginUrl",        url: "https://origin.example.com",    },});

With Storage Zone#

// Create a storage zoneconst storageZone = new bunnynet.StorageZone("assets", {    name: "example-assets",    region: "NY",    zoneTier: "Standard",    replicationRegions: ["LA", "SG"],});

Linking Storage Zone to Pull Zone#

To use a Bunny Storage Zone as the CDN origin, set origin.type to "StorageZone" and pass the storage zone ID via origin.storagezone. The storageZoneId property on StorageZone is output-only — create the storage zone first, then reference its ID from the pull zone.

import * as bunnynet from "pulumi-bunnynet";const storageZone = new bunnynet.StorageZone("assets", {    name: "example-assets",    region: "NY",    zoneTier: "Standard",});const pullZone = new bunnynet.Pullzone("website-cdn", {    name: "example-cdn",    origin: {        type: "StorageZone",        storagezone: storageZone.storageZoneId,    },}, { dependsOn: [storageZone] });

Do not confuse origin.storagezone with other pull zone storage fields:

logStorageZone — storage zone used for access log storage
permacacheStoragezone — storage zone used for Perma-Cache

Troubleshooting#

Invalid API Key#

Error: "Authentication failed: Invalid API key"

Solution:

Verify API key is correct
Check key hasn't been revoked
Ensure key has required permissions

# Test API keycurl -H "AccessKey: $BUNNY_API_KEY" \     https://api.bunny.net/pullzone

Rate Limiting#

Error: "Rate limit exceeded"

Solution:

Bunny.net has rate limits (varies by plan)
Add delays between resource creations
Use resource dependsOn to sequence operations

Permission Errors#

Error: "Insufficient permissions"

Solution:

Verify API key has correct permissions
Check account plan supports the feature
Ensure you're accessing resources you own

Overview#

Provider Configuration#

Basic Setup#

Configuration Methods#

1. Provider Block (Recommended)#

2. Environment Variables#

3. Pulumi Configuration#

Getting API Credentials#

Create API Key#

Required Permissions#

Configuration Options#

Best Practices#

Security#

Multi-Account Setup#

Integration Examples#

With Pull Zone#

With Storage Zone#

Linking Storage Zone to Pull Zone#

Troubleshooting#

Invalid API Key#

Rate Limiting#

Permission Errors#

Additional Resources#