ServiceRadar API (1.0)
Download OpenAPI specification:Download
API for monitoring and managing service pollers in the ServiceRadar system
Response samples
- 200
- 500
[- {
- "first_seen": "string",
- "is_healthy": true,
- "last_update": "string",
- "metrics": [
- {
- "response_time": 42,
- "service_name": "postgres",
- "timestamp": "2025-04-24T14:15:22Z"
}
], - "poller_id": "string",
- "services": [
- {
- "available": true,
- "details": [
- 0
], - "message": "string",
- "name": "string",
- "type": "string"
}
], - "uptime": "string"
}
]Get poller details
Retrieves detailed information about a specific poller
Authorizations:
path Parameters
| id required | string Poller ID |
Responses
Response samples
- 200
- 404
- 500
{- "first_seen": "string",
- "is_healthy": true,
- "last_update": "string",
- "metrics": [
- {
- "response_time": 42,
- "service_name": "postgres",
- "timestamp": "2025-04-24T14:15:22Z"
}
], - "poller_id": "string",
- "services": [
- {
- "available": true,
- "details": [
- 0
], - "message": "string",
- "name": "string",
- "type": "string"
}
], - "uptime": "string"
}Get service details
Retrieves detailed information about a specific service monitored by a poller
Authorizations:
path Parameters
| id required | string Poller ID |
| service required | string Service name |
Responses
Response samples
- 200
- 404
- 500
{- "available": true,
- "details": [
- 0
], - "message": "string",
- "name": "string",
- "type": "string"
}Get SNMP data
Retrieves SNMP metrics data for a specific poller within the given time range
Authorizations:
path Parameters
| id required | string Poller ID |
query Parameters
| start required | string Start time in RFC3339 format |
| end required | string End time in RFC3339 format |
Responses
Response samples
- 200
- 400
- 500
[- {
- "is_delta": true,
- "oid_name": "string",
- "scale": 0,
- "timestamp": "string",
- "value": null,
- "value_type": "string"
}
]Execute SRQL query
Executes a ServiceRadar Query Language (SRQL) query against the database
Authorizations:
Request Body schema: application/jsonrequired
SRQL query string
| query | string |
Responses
Request samples
- Payload
{- "query": "show devices where ip = '192.168.1.1'"
}Response samples
- 200
- 400
- 401
- 500
{- "error": "string",
- "results": [
- { }
]
}Authenticate with username and password
Logs in a user with username and password and returns authentication tokens
Request Body schema: application/jsonrequired
User credentials
| password | string Password for authentication |
| username | string Username for authentication |
Responses
Request samples
- Payload
{- "password": "password123",
- "username": "admin"
}Response samples
- 200
- 400
- 401
- 500
{- "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
- "expires_at": "2025-04-25T12:00:00Z",
- "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}Refresh authentication token
Refreshes an expired authentication token
Request Body schema: application/jsonrequired
Refresh token
| refresh_token | string Refresh token from previous authentication |
Responses
Request samples
- Payload
{- "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}Response samples
- 200
- 400
- 401
- 500
{- "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
- "expires_at": "2025-04-25T12:00:00Z",
- "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}Complete OAuth authentication.
Completes OAuth authentication flow and returns authentication tokens
path Parameters
| provider required | string OAuth provider (e.g., 'google', 'github') |
Responses
Response samples
- 200
- 400
- 500
{- "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
- "expires_at": "2025-04-25T12:00:00Z",
- "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}Get rperf metrics
Retrieves network performance metrics measured by rperf for a specific poller within a time range
Authorizations:
path Parameters
| id required | string Poller ID |
query Parameters
| start | string Start time in RFC3339 format (default: 24h ago) |
| end | string End time in RFC3339 format (default: now) |
Responses
Response samples
- 200
- 400
- 404
- 500
[- {
- "bits_per_second": 943215000,
- "bytes_received": 12582912,
- "bytes_sent": 12582912,
- "duration": 10.05,
- "error": "connection refused",
- "jitter_ms": 0.85,
- "loss_percent": 0.02,
- "name": "rperf_tcp_test",
- "packets_lost": 2,
- "packets_received": 9998,
- "packets_sent": 10000,
- "success": true,
- "target": "192.168.1.1",
- "timestamp": "2025-04-24T14:15:22Z"
}
]Get CPU metrics
Retrieves CPU usage metrics for a specific poller within a time range
Authorizations:
path Parameters
| id required | string Poller ID |
query Parameters
| start | string Start time in RFC3339 format (default: 24h ago) |
| end | string End time in RFC3339 format (default: now) |
Responses
Response samples
- 200
- 400
- 404
- 500
- 501
[- {
- "core_id": 0,
- "timestamp": "2025-04-24T14:15:22Z",
- "usage_percent": 45.2
}
]Get disk metrics
Retrieves disk usage metrics for a specific poller within a time range
Authorizations:
path Parameters
| id required | string Poller ID |
query Parameters
| mount_point | string Filter by specific mount point |
| start | string Start time in RFC3339 format (default: 24h ago) |
| end | string End time in RFC3339 format (default: now) |
Responses
Response samples
- 200
- 400
- 404
- 500
- 501
[- {
- "disks": [
- {
- "mount_point": "/var",
- "timestamp": "2025-04-24T14:15:22Z",
- "total_bytes": 107374182400,
- "used_bytes": 10737418240
}
], - "timestamp": "string"
}
]Get memory metrics
Retrieves memory usage metrics for a specific poller within a time range
Authorizations:
path Parameters
| id required | string Poller ID |
query Parameters
| start | string Start time in RFC3339 format (default: 24h ago) |
| end | string End time in RFC3339 format (default: now) |
Responses
Response samples
- 200
- 400
- 404
- 500
- 501
[- {
- "memory": {
- "timestamp": "2025-04-24T14:15:22Z",
- "total_bytes": 17179869184,
- "used_bytes": 4294967296
}, - "timestamp": "string"
}
]