Retrieves a domain under an account using domain_id
or domain_name
for Email Gateway Defense.
Endpoint
GET /beta/accounts/{account_id}/ess/domains/{domain_id | domain_name}
Request header
Name | Required | Description | Type |
---|---|---|---|
access_token | Required | The access token issued by the authorization server. | String |
Path parameters
Name | Required | Description | Type |
---|---|---|---|
account_id | Required | The Barracuda Cloud Control account ID. | String |
domain_id | Required | The domain ID obtained from the List Domains API. | Integer |
domain_name | Optional | The domain name. This can be used in place of the domain_id . | String |
Response
Entry | Description | Type |
---|---|---|
domainId | The domain ID. | Integer |
domainName | The domain name. | String |
status | The domain status.
| Enumeration |
type | The domain type.
| Enumeration |
Example Using domain_id
Sample Request
curl -X GET "https://api.barracudanetworks.com/beta/accounts/{account_id}/ess/domains/4" \
--header "Authorization: Bearer {access_token}"
Sample Response
{
"domainId": 4,
"domainName": "address.com",
"status": "VERIFIED",
"type": "ESS",
}
Example Using domain_name
Sample Request
curl -X GET "https://api.barracudanetworks.com/beta/accounts/{account_id}/ess/domains/addresstest.com" \
--header "Authorization: Bearer {access_token}"
Sample Response
{
"domainId": 491,
"domainName": "addresstest.com",
"status": "VERIFIED",
"type": "ESS",
}