Skip to main content

Data Source

The Bunny.net connector enables you to ingest data from the Bunny.net Core API, including pull zone configurations, storage zone details, DNS records, billing information, and usage statistics. Follow the instructions below to create a new data flow that ingests data from a Bunny.net source in Nexla.
bunny_inc_api.png

Bunny.net

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Bunny.net connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Bunny.net instance, and click Next; or, create a new Bunny.net credential for use in this flow.

  3. In Nexla, Bunny.net data sources can be created using pre-built endpoint templates, which expedite source setup for common Bunny.net endpoints. Each template is designed specifically for the corresponding Bunny.net endpoint, making data source setup easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Bunny.net sources can also be configured manually, allowing you to ingest data from Bunny.net endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Bunny.net endpoints. Each template is designed specifically for the corresponding Bunny.net endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    List Accounts

    Returns a paginated list of all accounts in the Bunny organization. Use this endpoint to retrieve account-level records from your Bunny.net instance via the GraphQL API.

    • Issues a POST request to https://{subdomain}.bunny.com/graphql using a GraphQL query.
    • Response data is located at $.data.accounts.nodes[*]; use this path in the Path to Data field to extract individual account records.

    Your Bunny.net subdomain is configured in your Bunny.net credential. This endpoint uses GraphQL — the POST body contains the query, which is pre-configured in the template.

    List Account Balances

    Returns a paginated list of account balance records. Use this endpoint to track financial balances across accounts in your Bunny.net organization.

    • Issues a POST request to https://{subdomain}.bunny.com/graphql using a GraphQL query.
    • Response data is located at $.data.accountBalances.nodes[*]; use this path in the Path to Data field.

    This endpoint returns balance history records. Use pagination parameters in the GraphQL query to retrieve large datasets incrementally.

    List Contacts

    Returns a paginated list of contacts. Use this endpoint to retrieve contact records stored in your Bunny.net organization.

    • Issues a POST request to https://{subdomain}.bunny.com/graphql using a GraphQL query.
    • Response data is located at $.data.contacts.nodes[*]; use this path in the Path to Data field.

    Contact records include customer and business contact details. Pagination is handled via GraphQL cursor-based pagination in the query.

    List Entities

    Returns a paginated list of legal entities. Use this endpoint to retrieve entity records representing the legal structures within your Bunny.net organization.

    • Issues a POST request to https://{subdomain}.bunny.com/graphql using a GraphQL query.
    • Response data is located at $.data.entities.nodes[*]; use this path in the Path to Data field.

    Legal entity records typically include name, registration details, and associated accounts.

    List Invoices

    Returns a paginated list of invoices. Use this endpoint to retrieve invoice records for billing and financial reporting purposes.

    • Issues a POST request to https://{subdomain}.bunny.com/graphql using a GraphQL query.
    • Response data is located at $.data.invoices.nodes[*]; use this path in the Path to Data field.

    Invoice records include amounts, dates, line items, and payment status. For large invoice histories, use GraphQL pagination to retrieve data incrementally.

    List Invoice Items

    Returns a paginated list of invoice line items. Use this endpoint to retrieve granular line-item detail from invoices for detailed billing analysis.

    • Issues a POST request to https://{subdomain}.bunny.com/graphql using a GraphQL query.
    • Response data is located at $.data.invoiceItems.nodes[*]; use this path in the Path to Data field.

    Invoice items represent individual charges within an invoice and may include product, quantity, unit price, and tax information.

    List Payments

    Returns a paginated list of payment records. Use this endpoint to track payments received and reconcile payment activity in your Bunny.net organization.

    • Issues a POST request to https://{subdomain}.bunny.com/graphql using a GraphQL query.
    • Response data is located at $.data.payments.nodes[*]; use this path in the Path to Data field.

    Payment records include amount, date, method, and associated invoice references.

    List Products

    Returns a paginated list of products. Use this endpoint to retrieve the product catalog defined in your Bunny.net organization.

    • Issues a POST request to https://{subdomain}.bunny.com/graphql using a GraphQL query.
    • Response data is located at $.data.products.nodes[*]; use this path in the Path to Data field.

    Product records include name, description, pricing, and availability details.

    List Plans

    Returns a paginated list of subscription plans. Use this endpoint to retrieve the subscription plan catalog configured in your Bunny.net organization.

    • Issues a POST request to https://{subdomain}.bunny.com/graphql using a GraphQL query.
    • Response data is located at $.data.plans.nodes[*]; use this path in the Path to Data field.

    Plan records include pricing tiers, billing cycles, and included features.

    List Quotes

    Returns a paginated list of sales quotes. Use this endpoint to retrieve quote records for sales pipeline reporting and revenue forecasting.

    • Issues a POST request to https://{subdomain}.bunny.com/graphql using a GraphQL query.
    • Response data is located at $.data.quotes.nodes[*]; use this path in the Path to Data field.

    Quote records include status, expiration date, line items, and associated contact and account information.

    List Quote Charges

    Returns a paginated list of quote charge line items. Use this endpoint to retrieve the individual charges associated with sales quotes.

    • Issues a POST request to https://{subdomain}.bunny.com/graphql using a GraphQL query.
    • Response data is located at $.data.quoteCharges.nodes[*]; use this path in the Path to Data field.

    Quote charge records detail the pricing breakdown within a quote, including quantity, unit price, and discount information.

    List Subscriptions

    Returns a paginated list of customer subscriptions. Use this endpoint to retrieve active and historical subscription records for revenue reporting and churn analysis.

    • Issues a POST request to https://{subdomain}.bunny.com/graphql using a GraphQL query.
    • Response data is located at $.data.subscriptions.nodes[*]; use this path in the Path to Data field.

    Subscription records include plan details, billing cycle, start and end dates, and associated account information.

    List Subscription Charges

    Returns a paginated list of subscription charge records. Use this endpoint to retrieve individual billing charges generated from customer subscriptions.

    • Issues a POST request to https://{subdomain}.bunny.com/graphql using a GraphQL query.
    • Response data is located at $.data.subscriptionCharges.nodes[*]; use this path in the Path to Data field.

    Subscription charge records include amount, billing date, status, and links to the originating subscription.

    List Transactions

    Returns a paginated list of financial transactions. Use this endpoint to retrieve a comprehensive record of all financial transactions within your Bunny.net organization.

    • Issues a POST request to https://{subdomain}.bunny.com/graphql using a GraphQL query.
    • Response data is located at $.data.transactions.nodes[*]; use this path in the Path to Data field.

    Transaction records include type, amount, date, and references to related invoices or payments.

    List Tenants

    Returns a paginated list of tenants. Use this endpoint to retrieve tenant records in multi-tenant Bunny.net deployments.

    • Issues a POST request to https://{subdomain}.bunny.com/graphql using a GraphQL query.
    • Response data is located at $.data.tenants.nodes[*]; use this path in the Path to Data field.

    Tenant records include tenant identification and configuration details. This endpoint is relevant for Bunny.net instances operating in a multi-tenant architecture.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Bunny.net sources can also be configured manually, allowing you to ingest data from any valid Bunny.net API endpoint. Configuration options available for Bunny.net sources allow them to be fully customized to suit any use case—including using chained API calls to fetch data from multiple endpoints or sources that require custom request parameters.

First, select the method that will be used for calls to the Bunny.net API from the Method pulldown menu. The most common method for data retrieval is:

  • GET: For retrieving data from the API (pull zones, statistics, storage zones, DNS records, etc.)
  • POST: For sending data to the API or triggering actions
  • PUT: For updating existing data
  • PATCH: For partial updates to existing data
  • DELETE: For removing data

API Endpoint URL​

  1. Enter the URL of the Bunny.net API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters.

    Common Bunny.net Core API base URLs include:

    • Pull zones: https://api.bunny.net/pullzone
    • Storage zones: https://api.bunny.net/storagezone
    • DNS zones: https://api.bunny.net/dnszone
    • Statistics: https://api.bunny.net/statistics
    • Billing: https://api.bunny.net/billing
    • Video libraries (Stream): https://api.bunny.net/videolibrary

The bunny.net Core API base URL is https://api.bunny.net. Append the specific resource path to target the desired endpoint. Additional information about available endpoints is available in the bunny.net Core API reference.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

Date/time macros are particularly useful for the Bunny.net statistics endpoint, which accepts dateFrom and dateTo query parameters to specify the reporting period. Using macros allows you to automatically retrieve statistics for rolling time windows without manually updating the URL.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful for Bunny.net integrations when you need to retrieve data for specific pull zones or storage zones identified in another Nexla source. For example, you can use a lookup of pull zone IDs to retrieve per-zone statistics dynamically.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data that will be returned by the API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful when Bunny.net API responses contain metadata, pagination information, or other data that you don't need for your analysis.

For example, when a request call is used to fetch a list of pull zones, the Bunny.net API returns a JSON object that contains an Items array with the pull zone records, along with pagination metadata such as TotalItems and CurrentPage. By entering the path to the Items array, you can configure Nexla to treat each element of the returned array as a record.

Path to Data is essential when Bunny.net API responses have nested structures. Many Bunny.net list endpoints wrap results in an Items property — use $.Items[*] as the path to extract individual records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.Items[*] to access the items array within a Bunny.net list response).

    • For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g., /response/data/item to access item elements within a data element).

    Path to Data Example:

    For the Bunny.net pull zone list endpoint (https://api.bunny.net/pullzone), the API returns a JSON object where pull zone records are in the Items array. Enter $.Items[*] as the path to extract individual pull zone records.

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.

For example, the Bunny.net list endpoints return pagination metadata such as TotalItems, CurrentPage, and HasMoreItems outside of the Items array. If you have set the path to data as $.Items[*], you can specify a metadata path to preserve these pagination details with each record.

Metadata paths are particularly useful when ingesting paginated Bunny.net API responses, as they allow you to capture total record counts, page numbers, and other summary information alongside individual records.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata, and for responses in XML format, enter the XPath.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers are often required for API versioning, content type specifications, or custom authentication requirements.

    You do not need to include the AccessKey authentication header here — it is automatically included by Nexla based on your Bunny.net credential configuration. Common headers like Authorization, Content-Type, and Accept are typically handled automatically by Nexla.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Bunny.net data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.