API keys and scopes

An API key lets a script or another system call the xEvolve API without a console sign-in. Each key carries scopes that limit what it can do.

Create a key

Open API keys and choose New key.
Enter a name, tick the scopes the key needs and optionally set an expiry in days.
Copy the key. It starts with xev_ and is shown once. xEvolve stores only a hash.

Send the key as a bearer token to your workspace:

curl https://<workspace>.xevolve.io/api/v1/connections \
  -H "Authorization: Bearer xev_<key>"

Revoking a key takes effect immediately. Key creation and revocation are written to the audit log.

A key can only create keys with scopes it holds itself. Asking for more answers 403.
A call without the needed scope answers 403 with API key missing required scope.
A console session is not limited by scopes; it follows the user's role.
Multi-factor settings, session management, login events, service principal registration, avatars, retention policy and trial status accept console sessions only. API keys get 403.

Scope	Allows
`files:read`	List, search and download files.
`files:write`	Upload files.
`transfers:read`	List and view transfers.
`transfers:write`	Create, execute and cancel transfers.
`connections:read`	List and view connections.
`connections:write`	Create, update, delete and test connections.
`data-rooms:read`	List and view data rooms.
`data-rooms:write`	Create, update and manage data rooms.
`schedules:read`	List schedules and run history.
`schedules:write`	Create, update, delete and run schedules.
`watchers:read`	List folder watchers.
`watchers:write`	Create, update and delete watchers.
`workflows:read`	List workflows and run history.
`workflows:write`	Create, update, delete and run workflows.
`parameters:read`	List and view global parameters.
`parameters:write`	Create, update and delete global parameters.
`users:read`	List and view users.
`users:write`	Update and delete users.
`agents:read`	List and view managed agents.
`agents:write`	Create, update, delete and test managed agents.
`webhooks:read`	List webhooks and deliveries.
`webhooks:write`	Create, update and delete webhooks.
`activity:read`	Read the activity log and dashboard counts.
`notifications:read`	Read notification settings and the notification log.
`notifications:write`	Change or test notification settings.
`api-keys:read`	List API keys.
`api-keys:write`	Create and revoke API keys, within the scopes the calling key holds.

API keys and webhooks need the Team plan or higher. Plans and limits lists the API requests allowed per month.