CreateDomainIdentity method
This method creates an address in a folder. The folder is selected based on the service account the request originates from.
Request
POST /v2/email/identities HTTP/2
Request headers
Use common request headers in your requests.
Request body
{
"EmailIdentity": "<address>",
"Tags": [
{
"Key": "<label_key>",
"Value": "<label_value>"
}
],
"DkimSigningAttributes": {
"DomainSigningSelector": "<selector_name>",
"DomainSigningPrivateKey": "<private_key>"
},
"ConfigurationSetName": "<configuration_name>"
}
|
Parameter |
Description |
|
|
Type: String. Address. |
|
|
Type: Array. Address label array. The maximum number of labels is 50. |
|
|
Type: String. Label key. The keyword may be from 1 to 63 characters long. |
|
|
Type: String. Label value. It may be from 0 (no value) to 256 characters long. |
|
|
Type: Object. Object containing parameters for creating a DKIM signature. |
|
|
Type: String. Name of the selector used to identify the public key in the domain’s DNS configuration. The selector name may be from 1 to 63 characters long. |
|
|
Type: String. Private key used to generate a DKIM signature. The private key must use 1,024-bit or 2,048-bit RSA encryption and base64 encoding. It may be from 1 to 20,480 characters long. |
|
|
Type: String. Name of the configuration you want to link to the address. The configuration must reside in the same folder as the address. |
Responses
200 OK
{
"IdentityType": "<address_type>",
"VerifiedForSendingStatus": <verification_status_for_sending_emails>,
"DkimAttributes": {
"SigningEnabled": <use_DKIM>,
"Status": "<DKIM_search_status>",
"Tokens": [
"<public_key_selector>"
],
"SigningAttributesOrigin": "<DKIM_configuration_method>",
"NextSigningKeyLength": "<next_key_length>",
"CurrentSigningKeyLength": "<current_key_length>"
}
}
|
Parameter |
Description |
|
|
Type: String. Address type. The possible value is |
|
|
Type: Boolean. Indicates whether address ownership is verified. The possible values are You can send emails only from verified addresses. |
|
|
Type: Object. Object containing the DKIM signature parameters. |
|
|
Type: Boolean. Indicates whether a given address uses DKIM signing for sending emails. 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 DKIM signing was configured. |
|
|
Type: String. Used exclusively for compatibility with AWS. |
|
|
Type: String. Used exclusively for compatibility with AWS. |
The 200 OK response may contain additional parameters. Its format may vary slightly from the above.
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. |
|
|
A configuration with this name already exists. Specify a different name. |
|
|
There are conflicting operations. Wait for the previous operation to complete and repeat your request. |
|
|
The request quota was exceeded. |
|
|
The request limit was exceeded. |