Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
  • Blog
  • Pricing
  • Documentation
Yandex project
© 2025 Yandex.Cloud LLC
Yandex Cloud Postbox
  • Getting started
  • Access management
  • Pricing policy
    • Authentication with the API
    • How to use the API
    • Signing requests
      • All methods
      • Sending emails
        • ListDomainIdentities method
        • GetDomainIdentity method
        • CreateDomainIdentity method
        • PutDomainIdentityDkimAttributes method
        • DeleteDomainIdentity method
      • Request headers
  • Audit Trails events
  • Release notes

In this article:

  • Request
  • Query parameters
  • Request headers
  • Responses
  • 200 OK
  • Errors
  1. API reference
  2. REST
  3. Addresses
  4. ListDomainIdentities method

ListDomainIdentities method

Written by
Yandex Cloud
Updated at October 22, 2024
  • Request
    • Query parameters
    • Request headers
  • Responses
    • 200 OK
    • Errors

Returns a list of addresses in a folder. The folder is selected based on the service account the request originates from.

RequestRequest

GET /v2/email/identities HTTP/2

Query parametersQuery parameters

Parameter

Description

PageSize

Type: Integer.

Maximum number of results you can get on one page in response to your request. If the number of results exceeds the PageSize value, the response returns the NextToken token to request the next results page.

The maximum permissible value for the parameter is 1000.

NextToken

Type: String.

Token to get the next results page in response to a request. To do this, provide the NextToken value you get in response to your previous request.

The maximum string length for the parameter is 100 characters.

Request headersRequest headers

Use common request headers in your requests.

ResponsesResponses

200 OK200 OK

{
  "EmailIdentities": [
    {
      "IdentityType": "<address_type>",
      "IdentityName": "<address>",
      "SendingEnabled": <address_state>,
      "VerificationStatus": "<verification_status>"
    }
  ],
  "NextToken": "<token>"
}

Parameter

Description

EmailIdentities

Type: Array.

Array of addresses.

IdentityType

Type: String.

Type of address. Possible value: DOMAIN.

IdentityName

Type: String.

Address.

SendingEnabled

Type: Boolean.

Indicates whether you can send emails from this address. Possible values: true or false.

Before sending emails from this address, you must pass a verification as its owner.

VerificationStatus

Type: String.

Verification status:

  • PENDING: Verification is ongoing, but so far Yandex Cloud Postbox has not verified the address.
  • SUCCESS: Address successfully verified.
  • FAILED: Verification failed.
  • TEMPORARY_FAILURE: Yandex Cloud Postbox cannot detect the verification status due to a temporary issue.
  • NOT_STARTED: Verification was not started.

NextToken

Type: String.

Token to get the next results page in response to a request. If the number of results exceeds the PageSize value, the response returns the NextToken token to request the next results page. Each page gets its own token for pagination.

The 200 OK response may contain additional parameters. Its format may vary slightly from the above.

ErrorsErrors

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

400 BadRequestException

The request contains invalid headers or parameters.

429 TooManyRequestsException

The request quota was exceeded.

Was the article helpful?

Previous
Sending emails
Next
GetDomainIdentity method
Yandex project
© 2025 Yandex.Cloud LLC