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

# API Overview

> StartMyVPN REST API — build mobile and desktop VPN clients on top of your installation.

## Base URL

All API endpoints are prefixed with `/v1`:

```
https://yourdomain.com/v1
```

## Authentication

The API uses **Bearer token authentication** (Laravel Sanctum). Include the token in every protected request:

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

Tokens are obtained via the [login endpoint](/api-reference/endpoints/auth).

## Rate limits

| Endpoint group            | Limit                |
| ------------------------- | -------------------- |
| Login                     | 5 requests / minute  |
| Registration              | 10 requests / minute |
| Password reset            | 3 requests / minute  |
| Promo validation          | 10 requests / minute |
| Ticket creation / replies | 10 requests / minute |
| Email re-verification     | 6 requests / minute  |
| All other endpoints       | 60 requests / minute |

When a rate limit is exceeded, the API returns `429 Too Many Requests`.

## Versioning

The current API version is **v1**. The version prefix is part of the URL path. Breaking changes will increment the version number.