Gateway RPCMethods Reference
services.*
Internal service management RPC methods
Service methods manage Aleph's internal services — background processes that handle specific subsystems like indexing, synchronization, and maintenance tasks.
Methods
services.list
List all internal services and their status.
Request:
{
"jsonrpc": "2.0",
"id": 1,
"method": "services.list",
"params": {}
}Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": {
"services": [
{
"id": "indexer",
"name": "Document Indexer",
"status": "running",
"healthy": true,
"uptime_seconds": 3600
},
{
"id": "sync",
"name": "Sync Service",
"status": "stopped",
"healthy": false
}
]
}
}services.status
Get detailed status of a specific service.
Request:
{
"jsonrpc": "2.0",
"id": 2,
"method": "services.status",
"params": {
"service_id": "indexer"
}
}Response:
{
"jsonrpc": "2.0",
"id": 2,
"result": {
"id": "indexer",
"name": "Document Indexer",
"status": "running",
"pid": 12345,
"uptime_seconds": 3600,
"last_run": "2024-01-15T10:30:00Z",
"next_run": "2024-01-15T11:30:00Z"
}
}services.start
Start a stopped service.
Request:
{
"jsonrpc": "2.0",
"id": 3,
"method": "services.start",
"params": {
"service_id": "sync"
}
}services.stop
Stop a running service.
Request:
{
"jsonrpc": "2.0",
"id": 4,
"method": "services.stop",
"params": {
"service_id": "indexer"
}
}services.restart
Restart a service.
Request:
{
"jsonrpc": "2.0",
"id": 5,
"method": "services.restart",
"params": {
"service_id": "indexer"
}
}Service States
| State | Description |
|---|---|
running | Service is active and healthy |
stopped | Service is stopped |
degraded | Service is running but unhealthy |
starting | Service is initializing |
stopping | Service is shutting down |
See Also
- Methods Reference -- All method namespaces
- Architecture: Services -- Service architecture