API Usage
Learn how to use the 2GC CloudBridge API for automation, integration, and custom workflows.
Подход к автоматизации
cbctl (CLI)
Командная утилита для скриптов и CI. Поддерживает создание/управление туннелями, диагностику соединений и экспорт метрик.
cbctl tunnel --transport grpc --local-port 2222 --remote-host example --remote-port 22
Клиентские профили
Готовые YAML-профили, централизованное распределение, горячая перезагрузка конфигурации на рабочих станциях.
Authentication
Header Format
Authorization: Bearer YOUR_API_TOKENТиповые сценарии без публичного API
Управление подключениями
Создание и остановка туннелей через cbctl и профили политики доступа.
cbctl tunnel stop --id current
Диагностика и мониторинг
Проверка статуса соединения, экспорт метрик в Pushgateway, интеграция с существующими системами мониторинга.
cbctl status && cbctl metrics push
Управление политиками
Назначение групп доступа и правил через админ-панель; автоматизация — через конфигурационные профили.
Rate Limiting
1000
Requests per hour
100
Requests per minute
10
Requests per second
Rate Limit Headers
Check the X-RateLimit-* headers in API responses to monitor your rate limit usage.
Error Handling
Common Error Codes
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
429 Rate Limited
500 Server Error
Error Response Format
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid email format",
"details": {
"field": "email",
"value": "invalid-email"
}
}
}Best Practices
Security
- Always use HTTPS
- Store tokens securely
- Validate all input data
- Implement proper error handling
Performance
- Use pagination for large datasets
- Implement caching strategies
- Monitor rate limits
- Use appropriate HTTP methods