It seems like your browser didn't download the required fonts. Please revise your security settings and try again.
Barracuda Email Gateway Defense
formerly Email Security

Get Domain

  • Last updated on

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

NameRequiredDescriptionType
access_tokenRequiredThe access token issued by the authorization server.String

Path parameters

NameRequiredDescriptionType
account_idRequiredThe Barracuda Cloud Control account ID.String
domain_idRequiredThe domain ID obtained from the List Domains API.Integer
domain_nameOptionalThe domain name. This can be used in place of the domain_id.String

Response

EntryDescriptionType
domainIdThe domain ID.Integer
domainNameThe 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

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",
}