Operations

API keys, exports, imports, backups, data purge, maintenance and the organization usage — of the platform, of AI and of the rate limits.

Families on this page

Family	Tools	read	write	destructive
`api-keys` — API keys	7	2	2	3
`exports` — Exports	4	3	1	0
`imports` — Imports	3	2	0	1
`backups` — Backups	7	3	1	3
`data-purges` — Data purge	2	2	0	0
`maintenance` — Maintenance	1	0	0	1
`usage` — Usage	1	1	0	0
`ai-usage` — AI usage	1	1	0	0
`rate-limits` — Rate limits	1	1	0	0

Tool	Kind	Permission	Endpoint	What it does
`dashboards_api_keys_list`	read	`api-keys.list`	`GET /v1/api_keys`	List the organization API keys (`kb_…`) with their status, prefix, expiry and who created/enabled/revoked them.
`dashboards_api_keys_get`	read	`api-keys.show`	`GET /v1/api_keys/:id`	Fetch one organization API key by id — metadata and lifecycle stamps, never the secret.
`dashboards_api_keys_create`	write	`api-keys.create`	`POST /v1/api_keys`	Create an organization API key (active, valid for one year unless `expires_at` says otherwise).
`dashboards_api_keys_update`	write	`api-keys.update`	`PATCH /v1/api_keys/:id`	Edit an API key (name, description, source, notification e-mails, expiry) and/or enable or disable it with `enabled`.
`dashboards_api_keys_revoke`	destructive	`api-keys.delete`	`POST /v1/api_keys/:id/revoke`	Permanently revoke an API key.
`dashboards_api_keys_rotate`	destructive	`api-keys.update`	`POST /v1/api_keys/:id/rotate`	Rotate an active API key: issues a successor (plaintext `key` returned ONCE) and keeps the old one working for `grace_days` (default 7, max 30).
`dashboards_api_keys_delete`	destructive	`api-keys.delete`	`DELETE /v1/api_keys/:id`	Remove a REVOKED API key from the list (soft delete; history kept).

Tool	Kind	Permission	Endpoint	What it does
`dashboards_exports_list`	read	`exports.list`	`GET /v1/exports`	List the export requests of the workspace (status, format, row count, expiry).
`dashboards_exports_get`	read	`exports.list`	`GET /v1/exports/:id`	Fetch one export request — poll it until `status` is `completed` (or `failed`).
`dashboards_exports_create`	write	`exports.create`	`POST /v1/exports`	Request an export of the workspace portal users as CSV, XLSX or JSON.
`dashboards_exports_download`	read	`exports.list`	`GET /v1/exports/:id/download`	Download the file of a completed export (CSV, XLSX or JSON bytes).

Tool	Kind	Permission	Endpoint	What it does
`dashboards_imports_list`	read	`imports.list`	`GET /v1/imports`	List the import requests of the workspace with their status and success/error counters.
`dashboards_imports_get`	read	`imports.list`	`GET /v1/imports/:id`	Fetch one import — status, processed/success/error counters and the per-row errors.
`dashboards_imports_create`	destructive	`imports.create`	`POST /v1/imports`	Import portal users into the workspace from a CSV sent as base64.

Tool	Kind	Permission	Endpoint	What it does
`dashboards_backups_list`	read	`settings.view`	`GET /v1/backups`	List the organization backups and restores (metadata only) plus `backup_allowed` / `next_backup_at` (one backup per 12 hours).
`dashboards_backups_get`	read	`settings.view`	`GET /v1/backups/:id`	Fetch one backup or restore — status, progress, resource counts.
`dashboards_backups_create`	write	`settings.update`	`POST /v1/backups`	Request a full backup (ZIP) of the organization, every workspace included.
`dashboards_backups_download`	read	`backups.export`	`GET /v1/backups/:id/download`	Download the ZIP of a backup.
`dashboards_backups_restore`	destructive	`settings.update`	`POST /v1/backups/restore`	Restore a backup into the workspace — rewrites portal users matched by e-mail/public id.
`dashboards_backups_cancel`	destructive	`settings.update`	`POST /v1/backups/:id/cancel`	Cancel a pending or running restore.
`dashboards_backups_delete`	destructive	`settings.update`	`DELETE /v1/backups/:id`	Delete a backup or restore record and its file from storage.

Tool	Kind	Permission	Endpoint	What it does
`dashboards_data_purges_counts`	read	`data.purge`	`GET /v1/data_purges`	Count the rows each purgeable resource (portal_users, people, usage_history) holds across every workspace — what a purge would wipe.
`dashboards_data_purges_get`	read	`data.purge`	`GET /v1/data_purges/:id`	Progress and result of a data purge job, by the `job_id` the purge returned.

Tool	Kind	Permission	Endpoint	What it does
`dashboards_maintenance_uppercase_names`	destructive	`settings.update`	`POST /v1/maintenance/uppercase_names`	Upper-case the name of every contact linked to a portal user of the workspace.

Tool	Kind	Permission	Endpoint	What it does
`dashboards_usage_get`	read	`usage.view`	`GET /v1/usage`	Platform usage of the organization ("Consumo"): per metric, the daily series in the range, the latest value and the peak.

Tool	Kind	Permission	Endpoint	What it does
`dashboards_ai_usage_get`	read	`portal-config.view`	`GET /v1/ai_usage`	AI consumption (price only) of the workspace for a period — totals, per day, latest turns — plus the organization month to date, limits, credit balance and whether the next turn is allowed.

Tool	Kind	Permission	Endpoint	What it does
`dashboards_rate_limits_get`	read	`settings.view`	`GET /v1/rate_limits`	Read the API rate limits in force for the organization (per minute/hour, burst), whether they are custom, and the platform defaults.

The fields of each resource are in the API reference and in dashboards_schemas_get.

A tool you cannot run is not listed by tools/list at all. If one from this page is missing, see Authentication.