Skip to main content
API docs by Redocly

ServiceRadar API (1.0)

Download OpenAPI specification:Download

API Support: [email protected] URL: https://serviceradar.cloud/support License: Apache 2.0 Terms of Service

API for monitoring and managing service pollers in the ServiceRadar system

Pollers

Get all pollers

Retrieves a list of all known pollers

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get poller details

Retrieves detailed information about a specific poller

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Poller ID

Responses

Response samples

Content type
application/json
{
  • "first_seen": "string",
  • "is_healthy": true,
  • "last_update": "string",
  • "metrics": [
    ],
  • "poller_id": "string",
  • "services": [
    ],
  • "uptime": "string"
}

Get poller history

Retrieves historical status information for a specific poller

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Poller ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Metrics

Get poller metrics

Retrieves performance metrics for a specific poller

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Poller ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Services

Get poller services

Retrieves all services monitored by a specific poller

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Poller ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get service details

Retrieves detailed information about a specific service monitored by a poller

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Poller ID

service
required
string

Service name

Responses

Response samples

Content type
application/json
{
  • "available": true,
  • "details": [
    ],
  • "message": "string",
  • "name": "string",
  • "type": "string"
}

SNMP

Get SNMP data

Retrieves SNMP metrics data for a specific poller within the given time range

Authorizations:
ApiKeyAuth
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

Content type
application/json
[
  • {
    }
]

SRQL

Execute SRQL query

Executes a ServiceRadar Query Language (SRQL) query against the database

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

SRQL query string

query
string

Responses

Request samples

Content type
application/json
{
  • "query": "show devices where ip = '192.168.1.1'"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "results": [
    ]
}

System

Get system status

Retrieves overall system status including counts of total and healthy pollers

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "healthy_pollers": 0,
  • "last_update": "string",
  • "total_pollers": 0
}

Authentication

Authenticate with username and password

Logs in a user with username and password and returns authentication tokens

Request Body schema: application/json
required

User credentials

password
string

Password for authentication

username
string

Username for authentication

Responses

Request samples

Content type
application/json
{
  • "password": "password123",
  • "username": "admin"
}

Response samples

Content type
application/json
{
  • "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/json
required

Refresh token

refresh_token
string

Refresh token from previous authentication

Responses

Request samples

Content type
application/json
{
  • "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Response samples

Content type
application/json
{
  • "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "expires_at": "2025-04-25T12:00:00Z",
  • "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Begin OAuth authentication.

Initiates OAuth authentication flow with the specified provider.

path Parameters
provider
required
string

OAuth provider (e.g., 'google', 'github')

Responses

Response samples

Content type
application/json
"string"

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

Content type
application/json
{
  • "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  • "expires_at": "2025-04-25T12:00:00Z",
  • "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Rperf

Get rperf metrics

Retrieves network performance metrics measured by rperf for a specific poller within a time range

Authorizations:
ApiKeyAuth
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

Content type
application/json
[
  • {
    }
]

Sysmon

Get CPU metrics

Retrieves CPU usage metrics for a specific poller within a time range

Authorizations:
ApiKeyAuth
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

Content type
application/json
[
  • {
    }
]

Get disk metrics

Retrieves disk usage metrics for a specific poller within a time range

Authorizations:
ApiKeyAuth
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

Content type
application/json
[
  • {
    }
]

Get memory metrics

Retrieves memory usage metrics for a specific poller within a time range

Authorizations:
ApiKeyAuth
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

Content type
application/json
[
  • {
    }
]