Source
ServiceRadar
ServiceRadar API
API V2
ServiceRadar API Reference
Browse the current ServiceRadar API reference and download the OpenAPI document.
OpenAPI
3.0.0
API version 2
Operations
59
11 tags
Schemas
227
Cached 2026-04-05 18:45 UTC
API
Reference downloads
Open the JSON artifact or use the upstream API reference tools.
agent
9 operations
GET
/api/v2/agents
GET /api/v2/agents
/api/v2/agents
/agents operation on agent resource
Parameters
filter
query
agent-filter
Filters the query to results with attributes matching the given filter object
sort
query
string
Sort order to apply to the results
page
query
object
Paginates the response with the limit and offset or keyset pagination.
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
POST
/api/v2/agents
POST /api/v2/agents
/api/v2/agents
Register a new agent (starts in connecting state)
application/vnd.api+json
Parameters
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
201: Success
default: No description
GET
/api/v2/agents/by-gateway/{gateway_id}
GET /api/v2/agents/by-gateway/{gateway_id}
/api/v2/agents/by-gateway/{gateway_id}
/agents/by-gateway/:gateway_id operation on agent resource
Parameters
gateway_id
path
required
string
filter
query
agent-filter
Filters the query to results with attributes matching the given filter object
sort
query
string
Sort order to apply to the results
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
GET
/api/v2/agents/{id}
GET /api/v2/agents/{id}
/api/v2/agents/{id}
/agents/:id operation on agent resource
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
uid
query
required
string
Responses
200: Success
default: No description
PATCH
/api/v2/agents/{id}
PATCH /api/v2/agents/{id}
/api/v2/agents/{id}
/agents/:id operation on agent resource
application/vnd.api+json
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
PATCH
/api/v2/agents/{id}/connect
PATCH /api/v2/agents/{id}/connect
/api/v2/agents/{id}/connect
Mark agent as connected (from connecting state)
application/vnd.api+json
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
PATCH
/api/v2/agents/{id}/degrade
PATCH /api/v2/agents/{id}/degrade
/api/v2/agents/{id}/degrade
Mark agent as degraded (connected but unhealthy)
application/vnd.api+json
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
PATCH
/api/v2/agents/{id}/disconnect
PATCH /api/v2/agents/{id}/disconnect
/api/v2/agents/{id}/disconnect
Mark agent as disconnected (connection lost)
application/vnd.api+json
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
PATCH
/api/v2/agents/{id}/heartbeat
PATCH /api/v2/agents/{id}/heartbeat
/api/v2/agents/{id}/heartbeat
Update last_seen_time and health status (for connected agents)
application/vnd.api+json
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
alert
7 operations
GET
/api/v2/alerts
GET /api/v2/alerts
/api/v2/alerts
/alerts operation on alert resource
Parameters
filter
query
alert-filter
Filters the query to results with attributes matching the given filter object
sort
query
string
Sort order to apply to the results
page
query
object
Paginates the response with the limit and offset or keyset pagination.
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
POST
/api/v2/alerts
POST /api/v2/alerts
/api/v2/alerts
Trigger a new alert
application/vnd.api+json
Parameters
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
201: Success
default: No description
GET
/api/v2/alerts/active
GET /api/v2/alerts/active
/api/v2/alerts/active
All active (non-resolved) alerts
Parameters
filter
query
alert-filter
Filters the query to results with attributes matching the given filter object
sort
query
string
Sort order to apply to the results
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
GET
/api/v2/alerts/pending
GET /api/v2/alerts/pending
/api/v2/alerts/pending
Alerts awaiting acknowledgement
Parameters
filter
query
alert-filter
Filters the query to results with attributes matching the given filter object
sort
query
string
Sort order to apply to the results
page
query
object
Paginates the response with the limit and offset or keyset pagination.
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
GET
/api/v2/alerts/{id}
GET /api/v2/alerts/{id}
/api/v2/alerts/{id}
/alerts/:id operation on alert resource
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
PATCH
/api/v2/alerts/{id}/acknowledge
PATCH /api/v2/alerts/{id}/acknowledge
/api/v2/alerts/{id}/acknowledge
Acknowledge an alert
application/vnd.api+json
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
PATCH
/api/v2/alerts/{id}/resolve
PATCH /api/v2/alerts/{id}/resolve
/api/v2/alerts/{id}/resolve
Resolve an alert
application/vnd.api+json
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
device
2 operations
GET
/api/v2/devices
GET /api/v2/devices
/api/v2/devices
/devices operation on device resource
Parameters
filter
query
device-filter
Filters the query to results with attributes matching the given filter object
sort
query
string
Sort order to apply to the results
page
query
object
Paginates the response with the limit and offset or keyset pagination.
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
include_deleted
query
boolean
Responses
200: Success
default: No description
GET
/api/v2/devices/{id}
GET /api/v2/devices/{id}
/api/v2/devices/{id}
/devices/:id operation on device resource
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
uid
query
required
string
include_deleted
query
boolean
Responses
200: Success
default: No description
device-group
5 operations
GET
/api/v2/device-groups
GET /api/v2/device-groups
/api/v2/device-groups
/device-groups operation on device-group resource
Parameters
filter
query
device-group-filter
Filters the query to results with attributes matching the given filter object
sort
query
string
Sort order to apply to the results
page
query
object
Paginates the response with the limit and offset or keyset pagination.
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
POST
/api/v2/device-groups
POST /api/v2/device-groups
/api/v2/device-groups
/device-groups operation on device-group resource
application/vnd.api+json
Parameters
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
201: Success
default: No description
GET
/api/v2/device-groups/{id}
GET /api/v2/device-groups/{id}
/api/v2/device-groups/{id}
/device-groups/:id operation on device-group resource
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
PATCH
/api/v2/device-groups/{id}
PATCH /api/v2/device-groups/{id}
/api/v2/device-groups/{id}
/device-groups/:id operation on device-group resource
application/vnd.api+json
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
DELETE
/api/v2/device-groups/{id}
DELETE /api/v2/device-groups/{id}
/api/v2/device-groups/{id}
/device-groups/:id operation on device-group resource
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Deleted successfully
default: No description
device_cleanup_settings
3 operations
GET
/api/v2/device-cleanup-settings
GET /api/v2/device-cleanup-settings
/api/v2/device-cleanup-settings
Get the singleton cleanup settings
Parameters
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
POST
/api/v2/device-cleanup-settings
POST /api/v2/device-cleanup-settings
/api/v2/device-cleanup-settings
Create device cleanup settings
application/vnd.api+json
Parameters
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
201: Success
default: No description
PATCH
/api/v2/device-cleanup-settings/{id}
PATCH /api/v2/device-cleanup-settings/{id}
/api/v2/device-cleanup-settings/{id}
Update device cleanup settings
application/vnd.api+json
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
gateway
15 operations
GET
/api/v2/gateways
GET /api/v2/gateways
/api/v2/gateways
/gateways operation on gateway resource
Parameters
filter
query
gateway-filter
Filters the query to results with attributes matching the given filter object
sort
query
string
Sort order to apply to the results
page
query
object
Paginates the response with the limit and offset or keyset pagination.
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
POST
/api/v2/gateways
POST /api/v2/gateways
/api/v2/gateways
Register a new gateway (starts in healthy state)
application/vnd.api+json
Parameters
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
201: Success
default: No description
GET
/api/v2/gateways/active
GET /api/v2/gateways/active
/api/v2/gateways/active
All active gateways
Parameters
filter
query
gateway-filter
Filters the query to results with attributes matching the given filter object
sort
query
string
Sort order to apply to the results
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
GET
/api/v2/gateways/{id}
GET /api/v2/gateways/{id}
/api/v2/gateways/{id}
/gateways/:id operation on gateway resource
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
PATCH
/api/v2/gateways/{id}/activate
PATCH /api/v2/gateways/{id}/activate
/api/v2/gateways/{id}/activate
Activate an inactive gateway
application/vnd.api+json
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
PATCH
/api/v2/gateways/{id}/deactivate
PATCH /api/v2/gateways/{id}/deactivate
/api/v2/gateways/{id}/deactivate
Deactivate a gateway (admin action)
application/vnd.api+json
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
PATCH
/api/v2/gateways/{id}/degrade
PATCH /api/v2/gateways/{id}/degrade
/api/v2/gateways/{id}/degrade
Mark gateway as degraded (having issues)
application/vnd.api+json
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
PATCH
/api/v2/gateways/{id}/drain/finish
PATCH /api/v2/gateways/{id}/drain/finish
/api/v2/gateways/{id}/drain/finish
Finish draining, go offline
application/vnd.api+json
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
PATCH
/api/v2/gateways/{id}/drain/start
PATCH /api/v2/gateways/{id}/drain/start
/api/v2/gateways/{id}/drain/start
Start graceful shutdown (draining)
application/vnd.api+json
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
PATCH
/api/v2/gateways/{id}/heartbeat
PATCH /api/v2/gateways/{id}/heartbeat
/api/v2/gateways/{id}/heartbeat
Update last_seen and health status
application/vnd.api+json
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
PATCH
/api/v2/gateways/{id}/maintenance/end
PATCH /api/v2/gateways/{id}/maintenance/end
/api/v2/gateways/{id}/maintenance/end
End maintenance mode, return to healthy
application/vnd.api+json
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
PATCH
/api/v2/gateways/{id}/maintenance/start
PATCH /api/v2/gateways/{id}/maintenance/start
/api/v2/gateways/{id}/maintenance/start
Put gateway into maintenance mode
application/vnd.api+json
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
PATCH
/api/v2/gateways/{id}/offline
PATCH /api/v2/gateways/{id}/offline
/api/v2/gateways/{id}/offline
Mark gateway as offline
application/vnd.api+json
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
PATCH
/api/v2/gateways/{id}/recover
PATCH /api/v2/gateways/{id}/recover
/api/v2/gateways/{id}/recover
Start recovery process for degraded/offline gateway
application/vnd.api+json
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
PATCH
/api/v2/gateways/{id}/restore
PATCH /api/v2/gateways/{id}/restore
/api/v2/gateways/{id}/restore
Restore gateway to healthy state
application/vnd.api+json
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
interface
1 operations
GET
/api/v2/interfaces
GET /api/v2/interfaces
/api/v2/interfaces
/interfaces operation on interface resource
Parameters
filter
query
interface-filter
Filters the query to results with attributes matching the given filter object
sort
query
string
Sort order to apply to the results
page
query
object
Paginates the response with the limit and offset or keyset pagination.
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
interface_classification_rule
2 operations
GET
/api/v2/interface-classification-rules
GET /api/v2/interface-classification-rules
/api/v2/interface-classification-rules
/interface-classification-rules operation on interface_classification_rule resource
Parameters
filter
query
interface_classification_rule-filter
Filters the query to results with attributes matching the given filter object
sort
query
string
Sort order to apply to the results
page
query
object
Paginates the response with the limit and offset or keyset pagination.
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
GET
/api/v2/interface-classification-rules/{id}
GET /api/v2/interface-classification-rules/{id}
/api/v2/interface-classification-rules/{id}
/interface-classification-rules/:id operation on interface_classification_rule resource
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
interface_setting
4 operations
GET
/api/v2/interface-settings
GET /api/v2/interface-settings
/api/v2/interface-settings
/interface-settings operation on interface_setting resource
Parameters
filter
query
interface_setting-filter
Filters the query to results with attributes matching the given filter object
sort
query
string
Sort order to apply to the results
page
query
object
Paginates the response with the limit and offset or keyset pagination.
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
POST
/api/v2/interface-settings
POST /api/v2/interface-settings
/api/v2/interface-settings
Create or update interface settings
application/vnd.api+json
Parameters
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
201: Success
default: No description
GET
/api/v2/interface-settings/by-interface/{device_id}/{interface_uid}
GET /api/v2/interface-settings/by-interface/{device_id}/{interface_uid}
/api/v2/interface-settings/by-interface/{device_id}/{interface_uid}
Get settings for a specific interface
Parameters
device_id
path
required
string
interface_uid
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
PATCH
/api/v2/interface-settings/{id}
PATCH /api/v2/interface-settings/{id}
/api/v2/interface-settings/{id}
/interface-settings/:id operation on interface_setting resource
application/vnd.api+json
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
poll-job
5 operations
GET
/api/v2/poll-jobs
GET /api/v2/poll-jobs
/api/v2/poll-jobs
/poll-jobs operation on poll-job resource
Parameters
filter
query
poll-job-filter
Filters the query to results with attributes matching the given filter object
sort
query
string
Sort order to apply to the results
page
query
object
Paginates the response with the limit and offset or keyset pagination.
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
GET
/api/v2/poll-jobs/by-schedule/{schedule_id}
GET /api/v2/poll-jobs/by-schedule/{schedule_id}
/api/v2/poll-jobs/by-schedule/{schedule_id}
/poll-jobs/by-schedule/:schedule_id operation on poll-job resource
Parameters
schedule_id
path
required
string
filter
query
poll-job-filter
Filters the query to results with attributes matching the given filter object
sort
query
string
Sort order to apply to the results
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
GET
/api/v2/poll-jobs/pending
GET /api/v2/poll-jobs/pending
/api/v2/poll-jobs/pending
All pending jobs
Parameters
filter
query
poll-job-filter
Filters the query to results with attributes matching the given filter object
sort
query
string
Sort order to apply to the results
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
GET
/api/v2/poll-jobs/running
GET /api/v2/poll-jobs/running
/api/v2/poll-jobs/running
All running jobs
Parameters
filter
query
poll-job-filter
Filters the query to results with attributes matching the given filter object
sort
query
string
Sort order to apply to the results
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
GET
/api/v2/poll-jobs/{id}
GET /api/v2/poll-jobs/{id}
/api/v2/poll-jobs/{id}
/poll-jobs/:id operation on poll-job resource
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
service-check
6 operations
GET
/api/v2/service-checks
GET /api/v2/service-checks
/api/v2/service-checks
/service-checks operation on service-check resource
Parameters
filter
query
service-check-filter
Filters the query to results with attributes matching the given filter object
sort
query
string
Sort order to apply to the results
page
query
object
Paginates the response with the limit and offset or keyset pagination.
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
POST
/api/v2/service-checks
POST /api/v2/service-checks
/api/v2/service-checks
/service-checks operation on service-check resource
application/vnd.api+json
Parameters
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
201: Success
default: No description
GET
/api/v2/service-checks/enabled
GET /api/v2/service-checks/enabled
/api/v2/service-checks/enabled
All enabled checks
Parameters
filter
query
service-check-filter
Filters the query to results with attributes matching the given filter object
sort
query
string
Sort order to apply to the results
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
GET
/api/v2/service-checks/failing
GET /api/v2/service-checks/failing
/api/v2/service-checks/failing
Checks with consecutive failures
Parameters
filter
query
service-check-filter
Filters the query to results with attributes matching the given filter object
sort
query
string
Sort order to apply to the results
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
GET
/api/v2/service-checks/{id}
GET /api/v2/service-checks/{id}
/api/v2/service-checks/{id}
/service-checks/:id operation on service-check resource
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description
PATCH
/api/v2/service-checks/{id}
PATCH /api/v2/service-checks/{id}
/api/v2/service-checks/{id}
/service-checks/:id operation on service-check resource
application/vnd.api+json
Parameters
id
path
required
string
include
query
string
Relationship paths to include in the response
fields
query
object
Limits the response fields to only those listed for each type
Responses
200: Success
default: No description