La referencia de la API se publica en inglés.

Read masked organization agent export settings; board connection managers only

GET/api/companies/{companyId}/observability
Personal API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

Read masked organization agent export settings; board connection managers only.

Autorización

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. Cómo funcionan las claves.

Parámetros de ruta

companyIdstringObligatorioThe organization's id.

Respuestas

200SuccessThe request worked; the body holds the result.
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.

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Agent observability