StealthSurf VPNStealthSurf VPN
Доступные методыПрофиль

API ключи

Методы для управления API ключами: создание, просмотр и удаление.

Обзор

Модуль для управления API ключами пользователя. Позволяет создавать, просматривать и удалять ключи для доступа к API.


GET /profile/api-keys

Получить список API ключей.

Rate Limit: глобальный (200 req/min)

Пример запроса

curl -X GET "https://api.stealthsurf.app/profile/api-keys" \
  -H "Authorization: Bearer stlth_XXXXXXXX_YYYYYYYYYYYYYYYYYYYYYYYY"

Ответ

{
  status: true,
  statusCode: 200,
  data: Array<{
    id: number
    name: string              // Название ключа
    key_prefix: string        // Префикс ключа (stlth_XXXXXXXX)
    created_at: number        // Unix timestamp
  }>
}

Пример ответа

{
  "status": true,
  "statusCode": 200,
  "data": [
    {
      "id": 1,
      "name": "My API Key",
      "key_prefix": "stlth_a1b2c3d4",
      "created_at": 1707000000
    }
  ]
}

POST /profile/api-keys

Создать новый API ключ.

Rate Limit: 5 req / 10 sec

Request Body

FieldTypeRequiredDescription
namestringДаНазвание ключа (1-64 символа)

Пример запроса

curl -X POST "https://api.stealthsurf.app/profile/api-keys" \
  -H "Authorization: Bearer stlth_XXXXXXXX_YYYYYYYYYYYYYYYYYYYYYYYY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My API Key"
  }'

Ответ

{
  status: true,
  statusCode: 201,
  data: {
    id: number
    name: string
    key: string               // Полный ключ (stlth_XXXXXXXX_YYYYYYYYYYYYYYYYYYYYYYYY)
    created_at: number
  }
}

Полный ключ (key) показывается только один раз при создании. Сохраните его сразу — повторно получить ключ невозможно.

Ошибки

errorCodemessageКогда
34API_KEY_LIMIT_REACHEDДостигнут лимит (максимум 5 ключей)

DELETE /profile/api-keys/:id

Удалить API ключ.

Rate Limit: 5 req / 60 sec

URL Parameters

ParameterTypeRequiredDescription
idnumberДаID ключа

Пример запроса

curl -X DELETE "https://api.stealthsurf.app/profile/api-keys/123" \
  -H "Authorization: Bearer stlth_XXXXXXXX_YYYYYYYYYYYYYYYYYYYYYYYY"

Ответ

{
  status: true,
  statusCode: 200,
  data: true
}

Ошибки

errorCodemessageКогда
33API_KEY_NOT_FOUNDAPI ключ не найден

Помогла ли вам эта статья?

Содержание