Справочник API публикуется на английском языке.

Test organization-scoped plugin config

POST/api/plugins/{pluginId}/config/test
Personal API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

Test organization-scoped plugin config.

Авторизация

Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. Как работают ключи.

Параметры пути

pluginIdstringОбязательныйThe plugin's id.

Тело запроса

application/json · обязательно

companyIdstringОбязательный
configJsonobjectОбязательный

Ответы

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Plugins