> ## Documentation Index
> Fetch the complete documentation index at: https://support.configview.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Eraser setup

Configview reads your Eraser workspace through the Eraser REST API (`https://app.eraser.io/api`), using an **API token** that a team admin (or an organization admin) creates in Eraser. Configview sends only `GET` requests. It never calls the render, create, update, archive or delete endpoints.

You will end up with **1 required secret** (`ERASER_API_TOKEN`) and 2 optional ones (`ERASER_TEAM_IDS`, `ERASER_AUDIT_API_KEY`) in Configview when setup is complete.

> **Scope of this integration today.** Configview reads the teams, the folders, metadata of every file (id, team, author id, folder, dates and the link-access setting), and on the Enterprise plan the members with their last 30 days of use, per-team usage totals and the audit log. It never reads or stores file content, diagrams, file links, AI prompts or generated output. A file title is kept only for files that anyone with the link can open, so a public file can be found and turned off.

***

## Read this first: the token cannot be read-only

Eraser API tokens have no scopes. A team token can read, create, change and archive files in its team, and generate diagrams (which uses AI credits). Configview only sends read calls, but Eraser cannot enforce that. An **organization API token** covers every team. Tokens do not expire; delete the token in Eraser to cut access at once.

API tokens exist on **paid plans only**.

## What the Eraser API does not tell Configview

There is **no member list, role, admin flag, seat count, pending invite, 2FA or SSO status** in the REST API. SCIM exists for Enterprise customers, but its token is the one your identity provider uses to provision accounts, so Configview does not use it. Roster questions are answered from the Enterprise usage report, which lists members with their email and activity. On other plans the roster tables stay empty.

File authors, folder creators and audit actors are Eraser **user ids**, not email addresses, and no endpoint maps an id to an email. Configview therefore cannot say whose email owns a file; it can say which author ids have stopped updating files.

***

## What you need

* A paid Eraser plan (Enterprise for members, usage and the audit log)
* A team admin to create a team token, or an organization admin to create an organization token

***

## Step 1: Open the Eraser page in Configview

`https://{companyname}.configview.com/admin/integrations/eraser`

## Step 2: Create the token

1. In Eraser open **Team settings**, then **API Token**, and click **Generate Token**. For several teams, an organization admin can instead open the **Organization Dashboard**, then **API tokens**, and create one organization token.
2. In Configview paste it into `ERASER_API_TOKEN` under **Credentials** and click the save icon.
3. Optional: set `ERASER_TEAM_IDS` to a comma separated list of team ids to read only those teams. Leave it empty to read every team the token can act on.
4. Optional, Enterprise only: ask Eraser support for the tenant level **audit API key** and paste it into `ERASER_AUDIT_API_KEY`. It is different from the team token. Without it the audit log is skipped.

## Step 3: Connect and verify

1. Click **Connect**. Configview creates its tables and schedules every collector at your default run time:

| Script | Notes |
| - | - |
| **Teams** | Team id, name, created date and organization. |
| **Folders** | Folder names (admin chosen labels), parents and dates. |
| **Files** | Metadata of every file with its link-access setting. Title only for publicly linked files. |
| **Members** | Enterprise. People per team with 30 day usage and last active. |
| **Team usage** | Enterprise. Per team totals for 30 days. |
| **Audit logs** | Enterprise plus audit key. Last 30 days of events. |

2. Click **Verify now**. The health check reads the secret and calls `GET /api/teams`.

If a check fails: **401** means the token was deleted or mistyped. **403** means the token is disabled or the plan has no API access. **429** means the rate limit was hit; the collectors retry after the `Retry-After` header.

***

## Data Tables

Each table has a `run_at` column. Files and audit logs keep only the newest run; the others keep history.

| Table | Source | Key Columns |
| - | - | - |
| `eraser_teams` | `GET /api/teams` | team\_id, name, created\_at\_src, organization\_id |
| `eraser_folders` | `GET /api/folders` | folder\_id, team\_id, name, parent\_folder\_id, created\_by |
| `eraser_files` | `GET /api/files` | file\_id, team\_id, author, folder\_id, link\_access, is\_public, title (public only), created\_at\_src, updated\_at\_src |
| `eraser_members` | `GET /api/reports/usage` | team\_id, email, display\_name, files\_created, file\_views, ai\_credits\_used, last\_active |
| `eraser_team_usage` | `GET /api/reports/usage` | team\_id, total\_members, active\_members, total\_files, file\_views, ai\_credits\_used |
| `eraser_audit_logs` | `GET /api/audit-logs` | event\_id, occurred\_at, action, outcome, actor\_id, target\_user\_id, team\_id, file\_id |

***

## Rate limits

Eraser publishes no rate limit. Configview paces at 60 requests per minute, reads files 500 per page and retries a 429 after the `Retry-After` header (30 seconds if absent). A team with 50,000 files needs about 100 file requests.

## Known gaps and things to check on the first run

These come from Eraser's published API docs; no live tenant has been tested yet.

* **Team id on every call.** Configview passes `teamId` on every call, discovered from `GET /api/teams`. Whether a team token accepts its own `teamId` is assumed.
* **Author format.** The docs say `author` is a user id. If Eraser returns an email, the same column holds it.
* **Link access values.** `publicly-viewable`, `publicly-editable` and `anyone-with-link-can-edit` count as public. `sso-readable` and `sso-editable` need a sign-in and are not counted as public.
* **Folders.** `recursive=true` is sent so nested folders are included; the response is read as a plain array.
* **Usage report.** Only on the Enterprise plan; `lastActive` is empty for anyone with no file view in the 30 day window, so it is not a true last sign-in. An organization token is asked once per team.
* **Audit log.** Needs the separate audit key. Event metadata (it holds file names) is not stored. Configview reads the last 30 days, up to 300 pages of 1000 events.
* **Page size and ordering.** Files are requested newest-updated first, 500 per page, until `nextCursor` is null.

## Things worth knowing

**Public links.** A file that is publicly viewable can be opened by anyone with the URL, and one that is publicly editable can be changed by them. Review those first, starting with the oldest.

**Leavers.** Files keep their link settings when their author leaves. The catalog lists author ids whose files have not changed in 180 days so someone can take ownership.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.