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.

Paging

  • Last updated on

API calls that return a large number of results can be broken up into pages that contain multiple groups of results. In order to retrieve all of your data, you can make multiple API calls with varied paging parameters to collect and group all of the data together.

Paging is accomplished through two query parameters: page and size. Note that using paging is optional. If you do not specify the page and size parameters, then the defaults will be used.

Query ParameterDescriptionDefault ValueMinimum ValueMaximum Value
pageThe current page to return.00100
sizeThe number of results to return.101100

Example

The following example returns all the domains under an account for ESS.

Sample Request

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

Sample Response

{
    "resultsCount": 4,
    "pageNum": 0,
    "itemsTotal": 4,
    "pagesTotal": 1,
    "results": [
        {
            "domainId": 4,
            "domainName": "address.com",
            "status": "VERIFIED",
            "type": "ESS",
        },
        {
            "domainId": 491,
            "domainName": "addresstest.com",
            "status": "VERIFIED",
            "type": "ESS",
        },
        {
            "domainId": 2346,
            "domainName": "barracudaemailsecurity.com",
            "status": "VERIFIED",
            "type": "ESS",
        },
        {
            "domainId": 1000,
            "domainName": "spamqa.net",
            "status": "VERIFIED",
            "type": "ESS",
        }
    ]
}
The following example returns 2 (size) results from page 0 (page) for the list of domains under an account for ESS.

Sample Request

 curl -X GET "https://api.barracudanetworks.com/beta/accounts/{account_id}/ess/domains?page=0&size=2" \
--header "Authorization: Bearer {access_token}"

Sample Response

{
    "resultsCount": 2,
    "pageNum": 0,
    "itemsTotal": 4,
    "pagesTotal": 2,
    "results": [
        {
            "domainId": 4,
            "domainName": "address.com",
            "status": "VERIFIED",
            "type": "ESS"
        },
        {
            "domainId": 491,
            "domainName": "addresstest.com",
            "status": "VERIFIED",
            "type": "ESS"
        }
    ]
}
Last updated on