Описание API

Геном предоставляет публичный API, позволяющий интегрировать его с другими системами.

API принимает запросы и отдаёт ответы в формате JSON.

Сообщения об ошибках возвращаются в формате RFC 7807.

Пагинация

Все запросы на получение списков поддерживают параметры limit и offset.

Параметр limit ограничивает количество возвращаемых записей. Его значение не может быть больше 10000 и по умолчанию равно 100. Если есть ещё данные, в поле meta.next возвращается ссылка на следующую страницу.

Сортировка

Параметр sort принимает название поля, по значению которого нужно упорядочить возвращаемые записи. Префикс - позволяет отсортировать записи в обратном порядке.

Примеры использования:

  • ?sort=name — по названию, в алфавитном порядке.

  • ?sort=-objectCount — по убыванию количества объектов.

  • ?sort=props.hostname — по полю hostname, в алфавитном порядке.

Выбор полей

Параметр fields позволяет получить значения только нужных полей. Названия полей указываются одной строкой через запятую.

Примеры использования:

  • ?fields=id,type — только поля id и type.

  • ?fields=id,objectCount — только поля id и objectCount.

  • ?fields=id,props.hostname — только поля id и свойство hostname.

Фильтрация по свойствам

Любые нестандартные query-параметры запроса трактуются как фильтры по свойствам объекта.

Примеры использования:

  • ?hostname=srv1.example.com — выбрать только те объекты, у которых значение свойства hostname равно srv1.example.com.

  • ?status=active — выбрать только те объекты, у которых значение свойства status равно active.