It seems like your browser didn't download the required fonts. Please revise your security settings and try again.

Attention

As of March 1, 2022, the legacy Barracuda Essentials Security, Compliance, and Complete editions are no longer available for purchase. Only existing customers can renew or add users to these plans. The documentation and trainings related to these plans will no longer be available after October 30, 2022. For more information on the latest Email Protection plans, see Barracuda Email Protection.

To update your bookmarks, see the following for the latest documentation and trainings:

Note that MSP customers should continue to follow Barracuda Essentials for MSPs.

Getting Started with the API

  • Last updated on

Prerequisites

The following are required before you can access the API:

  1. A Barracuda Cloud Control (BCC) account user credentials. If you do not already have a Barracuda Cloud Control account, see Create a Barracuda Cloud Control Account.
  2. A Client ID and Client Secret from a registered application in the Barracuda Token Service at https://login.bts.barracudanetworks.com/register
    For instructions, see Registering your Application in the Barracuda Token Service.
  3. An access token to make API requests. To create an access token, see Obtaining an Access Token.

Tools for interacting with the API

cURL

cURL is a command line tool for transferring data from or to a remote server via URLs. cURL is pre-installed on many UNIX/Linux platforms and newer Windows platforms. Type curl -V in your favorite shell to see if the tool is installed.

Examples in the endpoint references use cURL commands to send HTTP requests to access, create, and manipulate REST resources. 

Postman

Postman is a tool that you can use to build and test requests using the Barracuda Email Security Service APIs. You can download Postman at: https://www.getpostman.com/

Python

For an example of using the Barracuda Email Security Service API written in Python, see  Example - API Client in Python.

Make API Requests

After you have registered your application with an active Client ID and Client Secret and obtained an access token, you are ready to start creating requests.

Include the URL to the API service for the environment: https://api.barracudanetworks.com/

This sample request retrieves a list of accounts for ESS. You must include your access token in the authorization request header.

curl -X GET "https://api.barracudanetworks.com/beta/accounts/ess" \
--header "Authorization: Bearer {access_token}"

The sample response shows the details for the list of accounts available:

{
    "resultsCount": 1,
    "pageNum": 0,
    "itemsTotal": 1,
    "pagesTotal": 1,
    "results": [
        {
            "accountName": "Barracuda Networks Co",
            "accountId": "5584599",
            "region": "US"
        }
    ]
}

Next Step

See the API Reference to get details of all the HTTP requests available through the ESS REST API.

Last updated on