Retrieves a list of domains under an account for Email Gateway Defense.
Endpoint
GET /beta/accounts/{account_id}/ess/domains
Request header
| Name | Required | Description | Type |
|---|
| access_token | Required | The access token issued by the authorization server. | String |
Path parameter
| Name | Required | Description | Type |
|---|
| account_id | Required | The Barracuda Cloud Control account ID. | String |
Response
| Entry | Description | Type |
|---|
| resultsCount | The number of items on the current page. | Integer |
| pageNum | The current page number. | Integer |
| itemsTotal | The total number of items. | Integer |
| pagesTotal | The total number of pages. | Integer |
| results | The list of objects that each represent a domain. | Entry | Description | Type |
|---|
| domainId | The domain ID. | Integer | | domainName | The domain name. | String | | status | The domain status. VERIFIED (Domain has been verified)
UNVERIFIED (Domain needs to be verified)
DISABLED (Domain has expired or has not been renewed)
| Enumeration | | type | The domain type. ESS (Domain is an Email Gateway Defense type domain)
CPL (Domain is a Cloud Protection Layer type domain)
| Enumeration |
| Array |
See Paging for more information on how to navigate through sets of paged results from this API call.
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",
}
]
}
