Домены

Домены

Описание методов

Метод list позволяет получить список доменов

Запрос:

{site_path}/{lang}/api/domain/list

Список GET параметров:

filter array Позволяет фильтровать данные по всем доступным полям
fields string Позволяет выбрать из всех доступных только указанные поля
sort string Позволяет сортировать по возрастанию и по убыванию сущности по всем доступным полям
page int Позволяет передать порядковый номер страницы списка сущностей

Список всех доступных полей

id int ID домена
name string Название
lastDay string Последнее ипользование

Ответ

Ответ передается в формате JSON. Список полей ответа:

result array Список с учетом параметров запроса
_links array Список ссылок навигации. Может содержать элементы:
  • self - содержит ссылку на текущую страницу списка
  • first - содержит ссылку на первую страницу списка
  • last - содержит ссылку на последнюю страницу списка
  • prev - содержит ссылку на предыдущую страницу списка
  • next - содержит ссылку на следующую страницу списка
_meta array Информация по навигации списка. Содержит элементы:
  • totalCount - общееколичество доступных сущностей учитывая все выбранные параметры
  • pageCount - порядковый номер сущности в полученном списке, с которого начинается текущая страница
  • currentPage - порядковый номер текущей страницы
  • perPage - количество сущностей отображаемых на одной странице

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

{site_path}/{lang}/api/domain/list?filter[id][in][]=298790598&filter[id][in][]=526628817&sort=name

Пример ответа:

{
  "result": [
    {
      "id": 298790598,
      "name": "hghltd.yandex.net",
      "lastDay": 20200508
    },
    {
      "id": 526628817,
      "name": "www.google.com",
      "lastDay": 20201118
    }
  ],
  "_links": {
    "self": {
      "href": "{site_path}/{lang}/api/domain/list?filter%5Bid%5D%5Bin%5D%5B0%5D=298790598&filter%5Bid%5D%5Bin%5D%5B1%5D=526628817&sort=name&page=1"
    }
  },
  "_meta": {
    "totalCount": 2,
    "pageCount": 1,
    "currentPage": 1,
    "perPage": 20
  }
}