La référence de l'API est publiée en anglais.

Test organization-scoped plugin config

POST/api/plugins/{pluginId}/config/test
Personal API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

Test organization-scoped plugin config.

Autorisation

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. Fonctionnement des clés.

Paramètres de chemin

pluginIdstringObligatoireThe plugin's id.

Corps de la requête

application/json · obligatoire

companyIdstringObligatoire
configJsonobjectObligatoire

Réponses

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.

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Plugins