API on RealLoad - Documentation & Blog

Public API

Mon, 01 Jan 0001 00:00:00 +0000

The public API can be accessed without authentication.

Don’t stress this API. If you make more than 8 calls per minute, the corresponding remote IP address will be blocked for 15 minutes.

API Functions

The API supports the following functions (so-called “actions”):

getPortalServerInfo (Get public information about the portal server)
getAllExternalHelpLinks (Get an array of all external help links)
getExternalHelpLink (Get a specific external help link, addressed by a ‘helpKey’)

URL	HTTP Method
https://portal.realload.com/PublicAPI	POST
All data are sent and received in JSON data format. The “action” must always be sent when an API call is made.

Example

API HTTP/S Request

curl -v --request POST --header "Content-Type: application/json" --data "@getPortalServerInfo.json"  https://portal.realload.com/PublicAPI

API Request Data

{
  "action": "getPortalServerInfo"
}

API Response Data

{
  "portalServerInfo": {
    "portalServerVersion": "4.8.39",
    "minRequiredMeasuringAgentVersion": "4.5.12",
    "minRequiredClusterControllerVersion": "4.5.12",
    "minRequiredRemoteProxyRecorderVersion": "1.1.3",
    "currentTimestamp": 1714509839204
  },
  "isError": false
}

If the API call is successful, then the response field “isError” is false. If a numeric field has a value of -1 (minus one), this means “no data” or “unlimited” depending on the context.

Remote Admin API

Mon, 01 Jan 0001 00:00:00 +0000

Generating an Authentication Token

To perform a Remote Admin API call, you must first generate an “Admin API Auth Token” in the Administrator Menu of the portal. When generating the token you can enter a purpose (only used as information) and also restrict the remote IP addresses for which the token is valid. You can also specify whether the token has read/write access or read/only access.

Remote User API

Mon, 01 Jan 0001 00:00:00 +0000

Generating an Authentication Token

To perform a Remote User API call, you must first sign in into the portal and generate an “API Authentication Token”. When generating the token you can enter a purpose (only used as information) and also restrict the remote IP addresses for which the token is valid.

API Functions

The API supports the following functions (so-called “actions”):

Remote User Monitoring API

Mon, 01 Jan 0001 00:00:00 +0000

Abstract

The “Remote User Monitoring API” is a WebSocket API that supports developers to implement their own version of a Synthetic Monitoring “Real Time Dashboard”.

Similar to the Remote User API there is also an “API Authentication Token” required to access the API.

API Functions

The API supports the following functions (so-called “actions”):

pingPortalServer : Ping the Portal Server at API level.
getAllDashboardDisplayProfiles : Get all dashboard display profiles.
subscribeToHeartbeat : Subscribe to a periodic timestamp which is received every second.
unsubscribeFromHeartbeat : Cancel subscription to ‘subscribeToHeartbeat’.
subscribeToPeriodicAliveThread: Same functionality as ‘subscribeToHeartbeat’, but the time interval (in seconds) can be specified arbitrarily.
unsubscribeFromPeriodicAliveThread: Cancel subscription to ‘subscribeToPeriodicAliveThread’.
subscribeToRealtimeMonitor : Subscribe to events when a Monitoring Group or a Monitoring Job is created, modified or deleted, and subscribe to be notified each time when a Monitoring Group or a Monitoring Job is executed.
unsubscribeFromRealtimeMonitor : Cancel subscription to ‘subscribeToRealtimeMonitor’.
subscribeToMonitoringAlerts : Subscribe to monitoring alerts.
unsubscribeFromMonitoringAlerts : Cancel subscription to ‘subscribeToMonitoringAlerts’.
subscribeToGroupExecutionHistoryCache : Subscribe to a monitoring group’s execution history cache, which contains the measured data over the last 24 hours. The received data can be used to draw a chart or sparkline of the corresponding monitoring group.
unsubscribeFromAllGroupExecutionHistoryCaches : Cancel subscription to ‘subscribeToGroupExecutionHistoryCache’ for all monitoring groups.
subscribeToJobExecutionHistoryCache : Subscribe to a monitoring job’s execution history cache, which contains the measured data over the last 24 hours. The received data can be used to draw a chart or sparkline of the corresponding monitoring job.
unsubscribeFromAllJobExecutionHistoryCaches : Cancel subscription to ‘subscribeToJobExecutionHistoryCache’ for all monitoring jobs.

WebSocket URL
wss://portal.realload.com/RemoteUserMonitoringAPI

HTTP Request Header Fields
x-api-key: <API Authentication Token>	required
subscribeToHeartbeat: true	optional
subscribeToRealtimeMonitor: true	optional

The subscribed data are received in JSON format. The received JSON values are never null.