GetDomainIdentity method
This method returns information on an address in a folder. The folder is selected based on the service account the request originates from.
Request
GET /v2/email/identities/{DomainIdentity} HTTP/2
Path parameters
|
Parameter |
Description |
|
|
Type: String. Address you are requesting info on. The minimum length is one character. |
Request headers
Use common request headers in your requests.
Responses
200 OK
{
"IdentityType": "<address_type>",
"FeedbackForwardingStatus": <issue_notification_status>,
"VerifiedForSendingStatus": <verification_status_for_sending_emails>,
"DkimAttributes": {
"SigningEnabled": <DKIM_usage>,
"Status": "<DKIM_search_status>",
"Tokens": [
"<public_key_selector>"
],
"SigningAttributesOrigin": "<DKIM_configuration_method>",
"NextSigningKeyLength": "<compatibility_parameter>",
"CurrentSigningKeyLength": "<compatibility_parameter>"
},
"Tags": [
{
"Key": "<label_key>",
"Value": "<label_value>"
}
],
"ConfigurationSetName": "<configuration_name>",
"VerificationStatus": "<address_verification_status>"
}
|
Parameter |
Description |
|
|
Type: String. Address type. Value: |
|
|
Type: Boolean. The possible values are |
|
|
Type: Boolean. Indicates whether the address can be used to send emails. The possible values are |
|
|
Type: Object. Object that contains the DKIM signature parameters. |
|
|
Type: Boolean. Indicates whether a DKIM signature is used when sending from this address. The possible values are |
|
|
Type: String. Indicates whether Yandex Cloud Postbox was able to detect a DKIM signature in the DNS configuration of the address. The possible values are:
|
|
|
Type: Array. List of selectors for public key identification. Selector type: String. |
|
|
Type: String. Indicates how the DKIM signature was configured. |
|
|
Type: String. Only used to ensure compatibility with AWS. |
|
|
Type: String. Only used to ensure compatibility with AWS. |
|
|
Type: Array. Address label array. |
|
|
Type: String. Configuration name. |
|
|
Type: String. Verification status:
|
Errors
For all errors, the response body has the same format:
{
"Code": "<error_name>",
"message": "<error_description>"
}
The name of the error is taken from its code, e.g., BadRequestException.
Possible errors:
|
Error code |
Description |
|
|
The request contains invalid headers or parameters. |
|
|
The requested resource was not found. |
|
|
The request quota was exceeded. |