Aliases

Retrieve domain alias

Retrieve a specific alias for a domain.

get/v1/domains/{domain_id}/aliases/{alias_id}

Request

  • Base URL: https://api.forwardemail.net
  • URL: https://api.forwardemail.net/v1/domains/{domain_id}/aliases/{alias_id}
  • Auth: HTTP basic

Response

Domain alias retrieved successfully

namestring required
labelsstring[] required
is_enabledboolean required
has_recipient_verificationboolean required
verified_recipientsstring[] required
pending_recipientsstring[] required
recipientsstring[] required
idstring required
object'alias' required
created_atstring date-time required
updated_atstring date-time required
storage_locationstring required
has_imapboolean required
retentioninteger required

Retention period in days (0-365) for Trash and Junk mailbox cleanup. 0 means automatic storage-based scaling.

smtp_limitinteger

Per-alias daily SMTP outbound message limit. Set to 0 to use the domain-level limit.

is_smtp_suspendedboolean

Whether this alias is currently suspended from outbound SMTP access.

smtp_suspended_sent_atstring date-time nullable

The date and time when the alias was suspended from outbound SMTP.

Example response

{
  "user": {
    "email": "test@test.com",
    "display_name": "test@test.com",
    "id": "5efabd39xxxxxxx4512890b8"
  },
  "domain": {
    "name": "mailsire.com",
    "id": "5e3c0550xxxxxxx09b7ba023"
  },
  "name": "abc123",
  "labels": [],
  "is_enabled": true,
  "has_recipient_verification": false,
  "verified_recipients": [],
  "pending_recipients": [],
  "recipients": [
    "abc@test1.com"
  ],
  "id": "62fa3dcxxxxxxx79dda83ff2",
  "object": "alias",
  "created_at": "2022-08-15T12:36:26.593Z",
  "updated_at": "2022-08-15T12:36:26.593Z",
  "storage_location": "storage_loc",
  "has_imap": false,
  "retention": 0
}

Changes

No recorded changes to this operation across all 1 revision of this API.