REST API

VK Registry использует REST API для программного управления репозиториями, артефактами и настройками.

Ознакомьтесь со спецификацией Swagger одним из способов:

• По ссылке https://<FQDN_VK_REGISTRY>/service/rest/swagger.json, где <FQDN_VK_REGISTRY> — полное доменное имя, которое однозначно определяет расположение узла вашего экземпляра VK Registry.

• Через интерфейс VK Registry:

  1. Авторизуйтесь в VK Registry с помощью учетной записи администратора.
  2. Перейдите в раздел Система → API.
  3. (Опционально) Скачайте спецификацию по ссылке Download OpenAPI Document.

Эндпоинты API доступны по базовым путям:

• <FQDN_VK_REGISTRY>/service/rest/v1,
• <FQDN_VK_REGISTRY>/service/rest/v2.

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

 
$ curl 'https://<FQDN_VK_REGISTRY>/service/rest/v1/components/{<ИДЕНТИФИКАТОР>}'

 
$ curl 'https://<FQDN_VK_REGISTRY>/service/rest/v2/admin/repositories'

Здесь:

• <FQDN_VK_REGISTRY> — полное доменное имя, которое однозначно определяет расположение узла вашего экземпляра VK Registry.
• <ИДЕНТИФИКАТОР> — идентификатор запрашиваемого компонента.

Чтобы работать с API, используйте один из способов:

• Через браузер в VK Registry: используйте авторизационный файл cookie. Дополнительных действий для аутентификации выполнять не нужно.

• Через curl, Postman или другие внешние клиенты: выполните базовую (basic) аутентификацию.

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

   
  $ curl --location \  'https://<FQDN_VK_REGISTRY>/service/rest/v2/admin/repositories' \  --header 'Accept: application/json' \  --user '<ЛОГИН>:<ПАРОЛЬ>'

  Здесь:

  • <FQDN_VK_REGISTRY> — полное доменное имя, которое однозначно определяет расположение узла вашего экземпляра VK Registry.
  • <ЛОГИН> и <ПАРОЛЬ> — учетные данные администратора.

В таблице 1 описаны возможные ошибки при обращении к API VK Registry. Ошибки могут содержать внутренний код, указывающий на конкретную причину, или только общий HTTP-код.