Почта

Получение списка почтовых доменов

URL: /api/v1/mail/domains/
Метод: GET
Результат: JSON

Параметры запроса

Необязательные параметры:

  • offset: int - Индекс первой строки выборки, начиная с 0
  • limit: int - Количество элементов в выборке в диапазоне от 10 до 100

Коды ответов

Код Описание
200 Успешный запрос

Возвращаемое значение

  • count: int - Количество элементов
  • entities - Список доменов
    • id: int - Идентификатор домена
    • name: str - Имя почтового домена
    • dkim: str - DKIM-запись
    • quota: int - Максимальный объем дискового пространства для почтовых ящиков домена (МБ)
    • created: datetime - Дата создания почтового домена
    • ip: str - IP-адрес сервера, на котором расположен почтовый домен
    • state: str - Состояние почтового домена
    • updated: datetime - Дата изменения почтового домена
    • used: int - Занятое дисковое пространство (МБ)
    • validated: str - Статус валидации почтового домена

Пример запроса

curl --request GET 'https://api-ms.netangels.ru/api/v1/mail/domains/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"

Создание почтового домена

URL: /api/v1/mail/domains/
Метод: POST
Результат: JSON

Параметры тела запроса

Обязательные параметры:

  • name: str - Имя почтового домена

Коды ответов

Код Описание
201 Успешный запрос
400 Данные в запросе имеют неверный формат или отсутствуют обязательные параметры

Возвращаемое значение

Домен

  • id: int - Идентификатор домена
  • name: str - Имя почтового домена
  • dkim: str - DKIM-запись
  • quota: int - Максимальный объем дискового пространства для почтовых ящиков домена (МБ)
  • created: datetime - Дата создания почтового домена
  • ip: str - IP-адрес сервера, на котором расположен почтовый домен
  • state: str - Состояние почтового домена
  • updated: datetime - Дата изменения почтового домена
  • used: int - Занятое дисковое пространство (МБ)
  • validated: str - Статус валидации почтового домена

Пример запроса

curl --request POST 'https://api-ms.netangels.ru/api/v1/mail/domains/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "name": "my-domain.com" 
    }'

Информация о домене

URL: /api/v1/mail/domains/{id}/
Метод: GET
Результат: JSON

Параметры запроса

Обязательные параметры:

  • id: int - ID почтового домена

Коды ответов

Код Описание
200 Успешный запрос

Возвращаемое значение

Домен

  • id: int - Идентификатор домена
  • name: str - Имя почтового домена
  • dkim: str - DKIM-запись
  • quota: int - Максимальный объем дискового пространства для почтовых ящиков домена (МБ)
  • created: datetime - Дата создания почтового домена
  • ip: str - IP-адрес сервера, на котором расположен почтовый домен
  • state: str - Состояние почтового домена
  • updated: datetime - Дата изменения почтового домена
  • used: int - Занятое дисковое пространство (МБ)
  • validated: str - Статус валидации почтового домена

Пример запроса

curl --request GET 'https://api-ms.netangels.ru/api/v1/mail/domains/{id}/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"

Удаление домена

URL: /api/v1/mail/domains/{id}/
Метод: DELETE

Параметры запроса

Обязательные параметры:

  • id: int - ID почтового домена

Коды ответов

Код Описание
200 Успешный запрос

Пример запроса

curl --request DELETE 'https://api-ms.netangels.ru/api/v1/mail/domains/{id}/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY"

Изменение состояния DKIM

URL: /api/v1/mail/domains/{id}/dkim/
Метод: PUT
Результат: JSON

Параметры запроса

Обязательные параметры:

  • id: int - ID почтового домена

Параметры тела запроса

Обязательные параметры:

  • dkim: bool - Подключение/отключение DKIM

Коды ответов

Код Описание
201 Успешный запрос
400 Данные в запросе имеют неверный формат или отсутствуют обязательные параметры

Возвращаемое значение

Домен

  • id: int - Идентификатор домена
  • name: str - Имя почтового домена
  • dkim: str - DKIM-запись
  • quota: int - Максимальный объем дискового пространства для почтовых ящиков домена (МБ)
  • created: datetime - Дата создания почтового домена
  • ip: str - IP-адрес сервера, на котором расположен почтовый домен
  • state: str - Состояние почтового домена
  • updated: datetime - Дата изменения почтового домена
  • used: int - Занятое дисковое пространство (МБ)
  • validated: str - Статус валидации почтового домена

Пример запроса

curl --request PUT 'https://api-ms.netangels.ru/api/v1/mail/domains/{id}/dkim/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "dkim": true 
    }'

Изменение квоты домена

URL: /api/v1/mail/domains/{id}/quota/
Метод: PUT
Результат: JSON

Параметры запроса

Обязательные параметры:

  • id: int - ID почтового домена

Параметры тела запроса

Обязательные параметры:

  • quota: int - Максимальный объем дискового пространства для почтовых ящиков домена (МБ)

Коды ответов

Код Описание
201 Успешный запрос
400 Данные в запросе имеют неверный формат или отсутствуют обязательные параметры

Возвращаемое значение

Домен

  • id: int - Идентификатор домена
  • name: str - Имя почтового домена
  • dkim: str - DKIM-запись
  • quota: int - Максимальный объем дискового пространства для почтовых ящиков домена (МБ)
  • created: datetime - Дата создания почтового домена
  • ip: str - IP-адрес сервера, на котором расположен почтовый домен
  • state: str - Состояние почтового домена
  • updated: datetime - Дата изменения почтового домена
  • used: int - Занятое дисковое пространство (МБ)
  • validated: str - Статус валидации почтового домена

Пример запроса

curl --request PUT 'https://api-ms.netangels.ru/api/v1/mail/domains/{id}/quota/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "quota": 1000 
    }'