Create a tool access profile

POST/api/companies/{companyId}/tools/profiles
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Create a tool access profile.

Authorization

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. How keys work.

Path parameters

companyIdstringRequiredThe organization's id.

Request body

application/json · required

profileKeystringRequired1–160 characterspattern: ^[a-z0-9][a-z0-9._:-]*$
namestringRequired1–160 characters
descriptionstring | nullOptionalat most 4000 characters
statusstringOptionalone of: "draft", "active", "disabled", "archived"
defaultActionstringOptionalone of: "deny", "allow"
metadataobject | nullOptional
entriesarray<object>Optional
entries[].selectorTypestringRequiredone of: "application", "connection", "catalog_entry", "tool_name", "risk_level"
entries[].effectstringOptionalone of: "include", "exclude"
entries[].applicationIdstring (uuid) | nullOptional
entries[].connectionIdstring (uuid) | nullOptional
entries[].catalogEntryIdstring (uuid) | nullOptional
entries[].toolNamestring | nullOptional1–240 characters
entries[].riskLevelstring | nullOptionalone of: "low", "medium", "high", "critical", "read", "write", "destructive"
entries[].conditionsobject | nullOptional

Responses

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).

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Connectors