Перейти к содержанию

Почта

Получить информацию о пользователе

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

Коды ответов

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

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

Пользователь

  • id: int – Идентификатор пользователя.
  • login: str – Логин пользователя.
  • state: int – Статус пользователя.:
    • 0 – Пользователь активен
    • 2 – Отключен за неуплату
    • 4 – Отключен за превышение дисковой квоты
  • created: datetime – Дата создания пользователя.
  • updated: datetime – Дата изменения пользователя.

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

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

Обновление параметров платной квоты

URL: /api/v2/mail/
Метод: PUT
Результат: JSON

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

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

  • paid_quota_enabled: bool – Наличие платной почтовой квоты

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

  • paid_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/v2/mail/' \
    --header "Authorization: Bearer EhFf68LM0Mot7jmvdxMp64Ua0Bd4iCzIVLMcuhxUC1Ox7.8UrjAkXmguoYDQBPnliwZUOWedf3Z21BNHYetkph7XwdSHLapAfDYAwfqWmYUtAY.2ZfFJid0s7bmyVOoLdjClW8wh13AWmvLuNfY" \
    --header "Content-Type: application/json" \
    --data '{
          "paid_quota_enabled": true 
    }'