{ }
API Documentation
Authorize
Gateway API
1.4.2
REST API documentation for Gateway services. This interface describes available endpoints, request parameters, response schemas and service status.
Servers
https://api.example.com/v1
https://gateway.example.com/api
system
GET
/api/v1/status
Returns current service status
⌄
Responses
200
— Service operational
{ "status": "ok", "service": "gateway", "version": "1.4.2", "uptime": 184442 }
GET
/api/v1/health
Health check endpoint
⌄
Responses
200
{ "database": "healthy", "cache": "healthy", "gateway": "healthy" }
users
GET
/api/v1/users
Returns users collection
⌄
Responses
200
{ "items": [], "total": 0, "limit": 50, "offset": 0 }
POST
/api/v1/users
Create new user
⌄
Request body
{ "username": "string", "email": "user@example.com" }
sessions
POST
/api/v1/session
Create session
⌄
Responses
503
{ "error": "service_unavailable", "message": "Authentication backend is temporarily unavailable" }
DELETE
/api/v1/session/{id}
Delete session
⌄
Parameters
id
— Session identifier
Schemas
User {
id: integer
username: string
email: string
created_at: string
}
Error {
code: integer
message: string
}