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
        • GetConfigurationSetEventDestinations method
        • CreateConfigurationSetEventDestination method
        • UpdateConfigurationSetEventDestination method
        • DeleteConfigurationSetEventDestination method
      • Request headers
  • Audit Trails events
  • Release notes

In this article:

  • Request
  • Path parameters
  • Request headers
  • Responses
  • 200 OK
  • Errors
  1. API reference
  2. REST
  3. Subscriptions
  4. GetConfigurationSetEventDestinations method

GetConfigurationSetEventDestinations method

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

Returns information about subscriptions for a configuration in a folder. The folder is selected based on the service account the request originates from.

RequestRequest

GET /v2/email/configuration-sets/{ConfigurationSetName}/event-destinations HTTP/2

Path parametersPath parameters

Parameter

Description

ConfigurationSetName

Type: String.

Configuration name.

Request headersRequest headers

Use common request headers in your requests.

ResponsesResponses

200 OK200 OK

{
  "EventDestinations": [
    {
      "Name": "<subscription_name>",
      "Enabled": <subscription_state>,
      "KinesisFirehoseDestination": {
        "DeliveryStreamArn": "<data_stream>"
      }
    }
  ]
}

Parameter

Description

EventDestinations

Type: Array.

Array of subscriptions.

Name

Type: String.

Subscription name.

Enabled

Type: Boolean.

Subscription state: true for enabled, false for disabled. If the subscription is enabled, email delivery notifications are sent to the specified stream.

KinesisFirehoseDestination

Type: Object.

Object that specifies the destination for notifications.

DeliveryStreamArn

Type: String.

Yandex Data Streams data stream notifications will go to.

Format: arn:yc:yds:<region>::<endpoint>:<stream name>.

Example

arn:yc:yds:ru-central1::https://yds.serverless.yandexcloud.net/ru-central1/b1gkgm9daf9605nj****/etn5nuveugdr18ak****:postbox

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.

404 NotFoundException

The requested resource was not found.

429 TooManyRequestsException

The request quota was exceeded.

Was the article helpful?

Previous
DeleteConfigurationSet method
Next
CreateConfigurationSetEventDestination method
Yandex project
© 2025 Yandex.Cloud LLC