Нет описания правки |
Нет описания правки |
||
| Строка 1: | Строка 1: | ||
'''''[[API АппОптима]] / [[API АппОптима|Эндпойнты среды]] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=DELETE%20%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-,%D0%A0%D0%B0%D0%B7%D0%B2%D1%91%D1%80%D1%82%D1%8B%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5,-%D0%BF%D1%80%D0%B0%D0%B2%D0%B8%D1%82%D1%8C Развёртывание] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=PUT%20%D0%BA%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D1%8F-,%D0%A2%D0%BE%D0%BA%D0%B5%D0%BD%D1%8B%20v2,-%D0%A2%D0%BE%D0%BA%D0%B5%D0%BD%D1%8B%20%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0 Токены v2] / [https://docs.expert-apm.ru/index.php/API_%D0%90%D0%BF%D0%BF%D0%9E%D0%BF%D1%82%D0%B8%D0%BC%D0%B0#:~:text=%D0%A2%D0%BE%D0%BA%D0%B5%D0%BD%D1%8B%20v2-,%D0%A2%D0%BE%D0%BA%D0%B5%D0%BD%D1%8B%20%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0,-GET%20%D0%B2%D1%81%D0%B5%20%D1%82%D0%BE%D0%BA%D0%B5%D0%BD%D1%8B Токены доступа] / PUT токен''''' | |||
Обновляет указанный токен API. Вы можете: | Обновляет указанный токен API. Вы можете: | ||
Текущая версия от 17:27, 2 января 2025
API АппОптима / Эндпойнты среды / Развёртывание / Токены v2 / Токены доступа / PUT токен
Обновляет указанный токен API. Вы можете:
- Изменить имя и область действия токена.
- Отозвать токен. Отозванный токен все еще существует в среде, но его нельзя использовать.
Запрос использует в качестве полезной нагрузки application/json формат.
| PUT | АппОптима | https://{your-domain}/e/{your-environment-id}/api/v2/apiTokens/{id}
|
| Среда АктивногоШлюза | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/apiTokens/{id}
|
Аутентификация
Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Write API tokens ( apiTokens.write) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .
Параметры
| Параметр | Тип | Описание | In | Необходимость |
|---|---|---|---|---|
| id | string | Идентификатор токена, который необходимо обновить.
Вы не можете отключить токен, который вы используете для аутентификации запроса. |
path | требуется |
| body | ApiTokenUpdate | Тело JSON запроса. Содержит обновленные параметры токена API. | body | требуется |
Объекты тела запроса
Объект ApiTokenUpdate
Обновление токена API.
| Элемент | Тип | Описание | Необходимость |
|---|---|---|---|
| enabled | boolean | Маркер включен ( true) или отключен ( false)
|
по желанию |
| scopes | string[] | Список областей, назначенных маркеру.
Помимо новых областей, вам также необходимо отправить существующие области, которые вы хотите сохранить. Любая существующая область, отсутствующая в полезной нагрузке, удаляется.
Элемент может содержать эти значения
|
по желанию |
| name | string | Имя токена. | по желанию |
JSON-модель тела запроса
Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.
<{
"enabled": true,
"scopes": [
"InstallerDownload"
],
"name": "myToken"
}
Ответ
Коды ответов
| Код | Тип | Описание |
|---|---|---|
| 204 | Успех. Ответ не имеет тела. | |
| 400 | ErrorEnvelope | Не удалось. Ввод недействителен. |