Перейти к основному содержимому
API docs by Redocly

Email Service API (v1.0.0)

Managing resources: viewing a list of resources, creating and deleting resources, and changing resource names. Managing domains: adding and deleting domains from a resource, viewing a list of domains in a resource, and checking domain verification status. Viewing resource mailing statistics. Removing emails from a stop list. The maximum number of requests to SMTP is 10,000 per minute. If the limit is exceeded, the method will return error 429. The average execution time for one request is 500 ms.

Quotas

Get project quotas

Get quotas for project

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "ses_resources": {
    }
}

Get resource quotas

Returns quotas for resource.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "domains": {
    }
}

Resources

Get a list of resources

Get a list of resources in the project

Authorizations:
iam_token_project_scoped
query Parameters
limit
integer <integer>
Default: 100

Limit

offset
integer <integer>
Default: 0

Offset

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "next_offset": 0,
  • "resources": [
    ]
}

Create resource

Create resource

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required

The scheme for creating a resource

name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "2024-05-26T15:16:53+00:00",
  • "dedicated_sender": true,
  • "dns_key": "xncFjGLFGkeq",
  • "id": "448355c9-8c3a-4706-8ca4-ed2970fce631",
  • "login": "1010",
  • "name": "My SES Resource",
  • "password": "NtV4FQscV5BQ",
  • "project_id": "5c4272d6c6274435ae913cff6eceaf22",
  • "status": "active",
  • "updated_at": "2024-05-27T15:16:53+00:00"
}

Delete resource

Delete the resource by its identifier

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource ID

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "message": "string"
}

Get resource

Get the resource by its identifier

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource ID

Responses

Response samples

Content type
application/json
{
  • "resource": {
    }
}

Change resource name

Change the name of the created resource by its identifier

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource ID

Request Body schema: application/json
required

The scheme for updating a resource

name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "2024-05-26T15:16:53+00:00",
  • "dedicated_sender": true,
  • "dns_key": "xncFjGLFGkeq",
  • "id": "448355c9-8c3a-4706-8ca4-ed2970fce631",
  • "login": "1010",
  • "name": "My SES Resource",
  • "password": "NtV4FQscV5BQ",
  • "project_id": "5c4272d6c6274435ae913cff6eceaf22",
  • "status": "active",
  • "updated_at": "2024-05-27T15:16:53+00:00"
}

Generate new resource password

Generate new password for the created resource by its identifier

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource ID

Responses

Response samples

Content type
application/json
{
  • "created_at": "2024-05-26T15:16:53+00:00",
  • "dedicated_sender": true,
  • "dns_key": "xncFjGLFGkeq",
  • "id": "448355c9-8c3a-4706-8ca4-ed2970fce631",
  • "login": "1010",
  • "name": "My SES Resource",
  • "password": "NtV4FQscV5BQ",
  • "project_id": "5c4272d6c6274435ae913cff6eceaf22",
  • "status": "active",
  • "updated_at": "2024-05-27T15:16:53+00:00"
}

Transfer resource to other project

Transfer created resource to other project by resource identifier

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource ID

Request Body schema: application/json
required

The scheme for transfering a resource

project_id
required
string

Responses

Request samples

Content type
application/json
{
  • "project_id": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "2024-05-26T15:16:53+00:00",
  • "dedicated_sender": true,
  • "dns_key": "xncFjGLFGkeq",
  • "id": "448355c9-8c3a-4706-8ca4-ed2970fce631",
  • "login": "1010",
  • "name": "My SES Resource",
  • "password": "NtV4FQscV5BQ",
  • "project_id": "5c4272d6c6274435ae913cff6eceaf22",
  • "status": "active",
  • "updated_at": "2024-05-27T15:16:53+00:00"
}

Statistics

Get complaints on messages

Get complaints on messages by period

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource ID

query Parameters
date_from
required
string <date>
Example: date_from=2024-05-25

Start date

date_to
required
string <date>
Example: date_to=2024-05-26

End date

limit
integer
Default: 100
Example: limit=5

Limit

cursor_next
integer
Default: 0
Example: cursor_next=20

Offset

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "report": [
    ],
  • "status": "ok"
}

Get undelivered messages

Get undelivered messages by period

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource ID

query Parameters
date_from
required
string <date>
Example: date_from=2024-05-25

Start date

date_to
required
string <date>
Example: date_to=2024-05-26

End date

limit
integer
Default: 100
Example: limit=5

Limit

cursor_next
integer
Default: 0
Example: cursor_next=20

Offset

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "report": [
    ],
  • "status": "ok"
}

Get the delivered message status

Get the delivered message status by message_id or x_track_id

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource ID

query Parameters
message_id
string <string>

Message ID

x_track_id
string <string>

X-Track-ID

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "status": "ok"
}

View resource statistics

View the statistics of sent messages of the resource

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource ID

query Parameters
date_from
required
string <date>
Example: date_from=2024-05-25

Date start

date_to
required
string <date>
Example: date_to=2024-05-26

Date end

Responses

Response samples

Content type
application/json
{
  • "limit": 0,
  • "next_offset": 0,
  • "statistics": {
    }
}

Domains

Unlink the domain

Unlink domain from the resource

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource ID

query Parameters
name
required
string

Domain name

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "message": "string"
}

Get a list of resource domains

Get a list of domains of the resource

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource ID

query Parameters
limit
integer <integer>
Default: 16

Limit

offset
integer <integer>
Default: 0

Offset

Responses

Response samples

Content type
application/json
{
  • "domains": [
    ],
  • "limit": 0,
  • "next_offset": 0
}

Link a domain to the resource

Link a domain to the resource

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource ID

Request Body schema: application/json
required

The scheme for adding a domain

name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "domain": "string"
}

Check domain verification status

Check the correctness of SPF, DKIM, and DMARC domain record

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource ID

query Parameters
name
required
string <string>

Domain name

Responses

Response samples

Content type
application/json
{
  • "verification": {
    }
}

Stop-lists

Remove email from the stop list

Remove email from the stop list

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource ID

query Parameters
mail_from
required
string <email>

Sender's email address

email
required
string <email>

Email address to be removed from the stop list

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "message": "string"
}

Search email in the stop list

Search email in the stop list

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource ID

query Parameters
email
required
string <email>

Email address to be searched in the stop list

Responses

Response samples

Content type
application/json
{
  • "bounces": [
    ],
  • "domains": [
    ],
  • "fbl_report": [
    ],
  • "status": "string",
  • "user_unsubscribe": [
    ]
}

Add email to the stop list

Add email to the stop list

Authorizations:
iam_token_project_scoped
path Parameters
ses_id
required
string <uuid>

Resource ID

query Parameters
mail_from
required
string <email>

Sender's email address

email
required
string <email>

Email address to be added to the stop list

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "message": "string"
}