Справочник API
В разделе описаны методы для работы со статическими API-ключами.
Перед началом работы
Для работы с API потребуется:
эндпоинт для запросов — https://iam.api.cloud.ru/api/v1;
Набор методов для управления API-ключами
List - возвращает список API-ключей.
Delete - удаляет API-ключ.
keyId (string) – KeyID - идентификатор ключа.
serviceAccountId (string) – ServiceAccountID - идентификатор сервисного аккаунта.
200 OK – Успешное выполнение запроса.
Add - добавляет API-ключ.
description (string) – Description - описание ключа. Может содержать буквы unicode в разных регистрах, цифры, знаки пунктуации unicode и пробелы.
enabled (boolean) – Enabled - флаг активности ключа.
expiresAt (string) – ExpiresAt - дата истечения срока действия ключа. Если не указана, то выставляется значение по умолчанию (1 год). Максимальный срок действия ключа - 1 год.
name (string) – Name - имя ключа: от 1 до 256 символов, может содержать латинские буквы в нижнем и верхнем регистрах, цифры, дефис, подчеркивание, точка, пробел.
products (array) – Products - список названий продуктов, для которых будет использоваться ключ. До 100 продуктов.
products[] (string) –
restrictions (object) – Restrictions - ограничения ключа.
restrictions.ipAddresses (object) – IPAddresses - список IP-адресов.
restrictions.ipAddresses.ipAddresses (array) – IP-адреса и подсети в формате CIDR.
restrictions.ipAddresses.ipAddresses[] (string) –
restrictions.timeRange (object) –
restrictions.timeRange.timeSlots (array) – TimeSlots - список промежутков времени.
restrictions.timeRange.timeSlots[].end (integer) – End - конец диапазона в часах.
restrictions.timeRange.timeSlots[].start (integer) – Start - начало диапазона в часах.
restrictions.timeRange.timezone (integer) – Timezone - временная зона. Число от -12 до 12.
serviceAccountId (string) – ServiceAccountID - идентификатор сервисного аккаунта.
200 OK – Успешное выполнение запроса.
createdAt (string) – CreatedAt - дата создания ключа.
description (string) – Description - описание ключа.
enabled (boolean) – Enabled - флаг активности ключа.
expiresAt (string) – ExpiresAt - дата окончания срока действия ключа.
id (string) – ID - идентификатор ключа.
name (string) – Name - имя ключа.
products (array) – Products - список названий продуктов, с которыми может работать ключ.
products[] (string) –
restrictions (object) – Restrictions - ограничения ключа.
restrictions.ipAddresses (object) – IPAddresses - список IP-адресов.
restrictions.ipAddresses.ipAddresses (array) – IP-адреса и подсети в формате CIDR.
restrictions.ipAddresses.ipAddresses[] (string) –
restrictions.timeRange (object) –
restrictions.timeRange.timeSlots (array) – TimeSlots - список промежутков времени.
restrictions.timeRange.timeSlots[].end (integer) – End - конец диапазона в часах.
restrictions.timeRange.timeSlots[].start (integer) – Start - начало диапазона в часах.
restrictions.timeRange.timezone (integer) – Timezone - временная зона. Число от -12 до 12.
secret (string) – @gotags: secret:»true»
serviceAccountId (string) – ServiceAccountID - идентификатор сервисного аккаунта.
updatedAt (string) – UpdatedAt - дата обновления ключа.
Update - обновляет API-ключ.
key (object) – UpdateAPIKeyEntity - модель для обновления API-ключа.
key.description (string) – Description - описание ключа. Может содержать буквы unicode в разных регистрах, цифры, знаки пунктуации unicode и пробелы.
key.enabled (boolean) – Enabled - флаг активности ключа.
key.id (string) – ID - идентификатор ключа.
key.name (string) – Name - имя ключа. От 1 до 256 символов. Может содержать латинские буквы в нижнем и верхнем регистрах, цифры, дефис, подчеркивание, точка, пробел.
key.products (array) – Products - список названий продуктов, для которых будет использоваться ключ. До 100 продуктов.
key.products[] (string) –
key.restrictions (object) – Restrictions - ограничения ключа.
key.restrictions.ipAddresses (object) – IPAddresses - список IP-адресов.
key.restrictions.ipAddresses.ipAddresses (array) – IP-адреса и подсети в формате CIDR.
key.restrictions.ipAddresses.ipAddresses[] (string) –
key.restrictions.timeRange (object) –
key.restrictions.timeRange.timeSlots (array) – TimeSlots - список промежутков времени.
key.restrictions.timeRange.timeSlots[].end (integer) – End - конец диапазона в часах.
key.restrictions.timeRange.timeSlots[].start (integer) – Start - начало диапазона в часах.
key.restrictions.timeRange.timezone (integer) – Timezone - временная зона. Число от -12 до 12.
paths (string) – Paths - список свойств API-ключа, которые необходимо обновить. Возможные значения: name description restrictions enabled products.
200 OK – Успешное выполнение запроса.
createdAt (string) – CreatedAt - дата создания ключа.
description (string) – Description - описание ключа.
enabled (boolean) – Enabled - флаг активности ключа.
expiresAt (string) – ExpiresAt - дата окончания срока действия ключа.
id (string) – ID - идентификатор ключа.
name (string) – Name - имя ключа.
products (array) – Products - список названий продуктов, с которыми может работать ключ.
products[] (string) –
restrictions (object) – Restrictions - ограничения ключа.
restrictions.ipAddresses (object) – IPAddresses - список IP-адресов.
restrictions.ipAddresses.ipAddresses (array) – IP-адреса и подсети в формате CIDR.
restrictions.ipAddresses.ipAddresses[] (string) –
restrictions.timeRange (object) –
restrictions.timeRange.timeSlots (array) – TimeSlots - список промежутков времени.
restrictions.timeRange.timeSlots[].end (integer) – End - конец диапазона в часах.
restrictions.timeRange.timeSlots[].start (integer) – Start - начало диапазона в часах.
restrictions.timeRange.timezone (integer) – Timezone - временная зона. Число от -12 до 12.
secret (string) – @gotags: secret:»true»
serviceAccountId (string) – ServiceAccountID - идентификатор сервисного аккаунта.
updatedAt (string) – UpdatedAt - дата обновления ключа.
ListProducts - возвращает список доступных продуктов.
200 OK – Успешное выполнение запроса.
products (array) – Products - список доступных продуктов.
products[] (string) –
Get - возвращает API-ключ.
id (string) – ID - идентификатор ключа.
200 OK – Успешное выполнение запроса.
createdAt (string) – CreatedAt - дата создания ключа.
description (string) – Description - описание ключа.
enabled (boolean) – Enabled - флаг активности ключа.
expiresAt (string) – ExpiresAt - дата окончания срока действия ключа.
id (string) – ID - идентификатор ключа.
name (string) – Name - имя ключа.
products (array) – Products - список названий продуктов, с которыми может работать ключ.
products[] (string) –
restrictions (object) – Restrictions - ограничения ключа.
restrictions.ipAddresses (object) – IPAddresses - список IP-адресов.
restrictions.ipAddresses.ipAddresses (array) – IP-адреса и подсети в формате CIDR.
restrictions.ipAddresses.ipAddresses[] (string) –
restrictions.timeRange (object) –
restrictions.timeRange.timeSlots (array) – TimeSlots - список промежутков времени.
restrictions.timeRange.timeSlots[].end (integer) – End - конец диапазона в часах.
restrictions.timeRange.timeSlots[].start (integer) – Start - начало диапазона в часах.
restrictions.timeRange.timezone (integer) – Timezone - временная зона. Число от -12 до 12.
secret (string) – @gotags: secret:»true»
serviceAccountId (string) – ServiceAccountID - идентификатор сервисного аккаунта.
updatedAt (string) – UpdatedAt - дата обновления ключа.
Reissue - перевыпускает API-ключ.
id (string) – ID - идентификатор ключа
expiresAt (string) – ExpiresAt - дата окончания срока действия нового ключа.
200 OK – Успешное выполнение запроса.
createdAt (string) – CreatedAt - дата создания ключа.
description (string) – Description - описание ключа.
enabled (boolean) – Enabled - флаг активности ключа.
expiresAt (string) – ExpiresAt - дата окончания срока действия ключа.
id (string) – ID - идентификатор ключа.
name (string) – Name - имя ключа.
products (array) – Products - список названий продуктов, с которыми может работать ключ.
products[] (string) –
restrictions (object) – Restrictions - ограничения ключа.
restrictions.ipAddresses (object) – IPAddresses - список IP-адресов.
restrictions.ipAddresses.ipAddresses (array) – IP-адреса и подсети в формате CIDR.
restrictions.ipAddresses.ipAddresses[] (string) –
restrictions.timeRange (object) –
restrictions.timeRange.timeSlots (array) – TimeSlots - список промежутков времени.
restrictions.timeRange.timeSlots[].end (integer) – End - конец диапазона в часах.
restrictions.timeRange.timeSlots[].start (integer) – Start - начало диапазона в часах.
restrictions.timeRange.timezone (integer) – Timezone - временная зона. Число от -12 до 12.
secret (string) – @gotags: secret:»true»
serviceAccountId (string) – ServiceAccountID - идентификатор сервисного аккаунта.
updatedAt (string) – UpdatedAt - дата обновления ключа.
- Перед началом работы
- Набор методов для управления API-ключами