API Overview

The Email Gateway Defense REST API provides the ability to interact with Email Gateway Defense. This article gives a brief description of REST API and the API methods you can use to access Email Gateway Defense. 

Representational State Transfer (REST) is a stateless architecture that runs over HTTP. REST API is a simple web service API you can use to interact with Email Gateway Defense. For more information on REST API, visit http://en.wikipedia.org/wiki/Representational_state_transfer.

Getting Started

You will need an active Barracuda Cloud Control account and your application registered in the Barracuda Token Service in order to receive the required Client ID and Client Secret. The Client Secret is used to sign and validate access tokens for authentication and to gain access to API endpoints.

For more details, review our Getting Started with the API information. 

Authorization Requirements

All endpoints will require an access token. Access tokens are generated from the token endpoint.

Use the API

Use the following URL based on your region:

The following endpoints are available:

Accounts

• List accounts 
• Get account  

Domains

• List domains
• Get domain

Statistics

• Get statistics

Paging

Sometimes API requests will return a large number of results. Rather than retrieve them all at once, which may affect your application’s performance, you can use paging to retrieve the results in batches. For more information, see Paging.

Scopes

The scope constrains the endpoints to which a client has access, and whether a client has read or write access to an endpoint. 

As a general rule, choose the most restrictive scope possible and avoid requesting scopes that your application does not need. 

Available scopes:

HTTP response codes