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

Create a tool access profile

POST/api/companies/{companyId}/tools/profiles
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

Create a tool access profile.

Autorización

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Cómo funcionan las claves.

Parámetros de ruta

companyIdstringObligatorioThe organization's id.

Cuerpo de la solicitud

application/json · obligatorio

profileKeystringObligatorio1–160 characterspattern: ^[a-z0-9][a-z0-9._:-]*$
namestringObligatorio1–160 characters
descriptionstring | nullOpcionalat most 4000 characters
statusstringOpcionalone of: "draft", "active", "disabled", "archived"
defaultActionstringOpcionalone of: "deny", "allow"
metadataobject | nullOpcional
entriesarray<object>Opcional
entries[].selectorTypestringObligatorioone of: "application", "connection", "catalog_entry", "tool_name", "risk_level"
entries[].effectstringOpcionalone of: "include", "exclude"
entries[].applicationIdstring (uuid) | nullOpcional
entries[].connectionIdstring (uuid) | nullOpcional
entries[].catalogEntryIdstring (uuid) | nullOpcional
entries[].toolNamestring | nullOpcional1–240 characters
entries[].riskLevelstring | nullOpcionalone of: "low", "medium", "high", "critical", "read", "write", "destructive"
entries[].conditionsobject | nullOpcional

Respuestas

201SuccessCreated; the body holds the new resource.
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.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).

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

Connectors