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

# Introduction

> Create scans and read scan history over REST.

The Revex API lets your own tools create scans and read scan history without opening the panel. A common use is a Discord bot that creates a scan and posts the PIN in a ticket.

## Base URL

```text theme={null}
https://revexscanner.com
```

## Authentication

Every request needs a **developer key** in the `Authorization` header.

```http theme={null}
Authorization: Bearer rvx_YOUR_KEY
```

**1. Create a key**

Open the panel, go to **Developer keys** and create a key. Give it a name (1-40 characters).

**2. Copy it once**

The full key is shown **only once**, when you create it. Only a hash is stored, so a lost key cannot be recovered. Create a new one instead.

**3. Use it in requests**

Send it as a Bearer token. Keys start with `rvx_`.

> [!WARNING]
>
> Keep keys secret and never put them in client-side code. If a key leaks, revoke it in the panel right away.

### Key rules

* Keys start with `rvx_` followed by 43 characters.
* An organization can have at most **5 active keys**.
* A key stops working if the person who created it leaves the team.
* Requests use the key owner's organization and permissions. No cookies or CSRF tokens are needed.

## Rate limits

| Limit | Value |
| - | - |
| Requests per key | 30 per minute |
| Failed key attempts | 20 per minute per IP address |

Exceeding a limit returns `429 RATE_LIMITED`. Wait a minute and retry.

## Endpoints

> [card] [Create a scan](https://docs.revexscanner.com/api-reference/create-scan.md)
>
> `POST /api/v1/scans`

> [card] [List scans](https://docs.revexscanner.com/api-reference/list-scans.md)
>
> `GET /api/v1/scans`

See [Errors](https://docs.revexscanner.com/api-reference/errors.md) for all error codes.


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