Public API
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.
getPortalServerInfo
Specific Request Fields:
- [none]
Specific Error Flags:
- [none]
JSON Request Example:
{
"action":"getPortalServerInfo"
}
JSON Response Example (Success Case):
{
"portalServerInfo": {
"portalServerVersion": "4.8.39",
"minRequiredMeasuringAgentVersion": "4.5.12",
"minRequiredClusterControllerVersion": "4.5.12",
"minRequiredRemoteProxyRecorderVersion": "1.1.3",
"currentTimestamp": 1714509839204
},
"isError": false
}
getAllExternalHelpLinks
Specific Request Fields:
- [none]
Specific Error Flags:
- [none]
JSON Request Example:
{
"action":"getAllExternalHelpLinks"
}
JSON Response Example (Success Case):
{
"externalHelpLinksArray": [
{
"helpKey": "HelpKey_DesktopCompanionAwsAvailableAmisList",
"keyEnabled": true,
"hrefTitle": "Available AWS AMIs",
"href": "https://kb.realload.com/docs/desktop-companion/measuring_agents/",
"targetBlank": true
},
{
"helpKey": "HelpKey_DesktopCompanionAwsInstancesInMyRegionsList",
"keyEnabled": true,
"hrefTitle": "Running AWS Images in \"My Regions\"",
"href": "https://kb.realload.com/docs/desktop-companion/measuring_agents/#listing-running-ec2-instances",
"targetBlank": true
},
{
"helpKey": "HelpKey_DesktopCompanionAwsPortalAgentsList",
"keyEnabled": true,
"hrefTitle": "Portal Agents De-register",
"href": "https://kb.realload.com/docs/desktop-companion/measuring_agents/#de-register-an-instance",
"targetBlank": true
},
{
"helpKey": "HelpKey_DesktopCompanionEditorRequestDetails",
"keyEnabled": true,
"hrefTitle": "Request Details",
"href": "https://kb.realload.com/docs/desktop-companion/editor/",
"targetBlank": true
},
{
"helpKey": "HelpKey_DesktopCompanionEditorSession",
"keyEnabled": true,
"hrefTitle": "HTTP Requests",
"href": "https://kb.realload.com/docs/desktop-companion/editor/",
"targetBlank": true
},
{
"helpKey": "HelpKey_DesktopCompanionEditorUniqueDomainsList",
"keyEnabled": true,
"hrefTitle": "Unique Domains",
"href": "https://kb.realload.com/docs/desktop-companion/editor/#domain-based-selection",
"targetBlank": true
},
{
"helpKey": "HelpKey_DesktopCompanionPreferencesAWS",
"keyEnabled": true,
"hrefTitle": "AWS Settings",
"href": "https://kb.realload.com/docs/desktop-companion/settings/#aws-settings",
"targetBlank": true
},
{
"helpKey": "HelpKey_DesktopCompanionPreferencesGeneral",
"keyEnabled": true,
"hrefTitle": "General Settings",
"href": "https://kb.realload.com/docs/desktop-companion/settings/#general-settings",
"targetBlank": true
},
{
"helpKey": "HelpKey_DesktopCompanionPreferencesProxyRecorder",
"keyEnabled": true,
"hrefTitle": "Proxy Recorder Settings",
"href": "https://kb.realload.com/docs/desktop-companion/settings/#proxy-recorder-settings",
"targetBlank": true
},
{
"helpKey": "HelpKey_HttpsRemoteProxyRecorderImportRootCertificate",
"keyEnabled": true,
"hrefTitle": "Import Proxy Recorder Root Certificate",
"href": "https://kb.realload.com/docs/userguide/remoteproxyrecorder/#importing-the-proxy-recorder-ca-root-certificate-into-the-web-browser",
"targetBlank": true
},
{
"helpKey": "HelpKey_HttpsRemoteProxyRecorderRecordingSession",
"keyEnabled": true,
"hrefTitle": "Recording a Web Surfing Session",
"href": "https://kb.realload.com/docs/userguide/recordingwebsurfingsession/",
"targetBlank": true
},
{
"helpKey": "HelpKey_HttpsRemoteProxyRecordersMenu",
"keyEnabled": true,
"hrefTitle": "HTTP/S Remote Proxy Recorder",
"href": "https://kb.realload.com/docs/userguide/remoteproxyrecorder/",
"targetBlank": true
},
{
"helpKey": "HelpKey_HTTPTestWizard_Debugger",
"keyEnabled": true,
"hrefTitle": "HTTP Test Wizard Debugger",
"href": "https://kb.realload.com/docs/userguide/httptestwizard/#debugger",
"targetBlank": true
},
{
"helpKey": "HelpKey_HTTPTestWizard_Main",
"keyEnabled": true,
"hrefTitle": "HTTP Test Wizard",
"href": "https://kb.realload.com/docs/userguide/httptestwizard/",
"targetBlank": true
},
{
"helpKey": "HelpKey_HTTPTestWizard_Plugins",
"keyEnabled": true,
"hrefTitle": "HTTP Test Wizard Plug-Ins",
"href": "https://kb.realload.com/docs/userguide/httptestwizard/#plug-ins",
"targetBlank": true
},
{
"helpKey": "HelpKey_LaunchedCloudInstancesByCloudCredits",
"keyEnabled": true,
"hrefTitle": "Launched Cloud Instances",
"href": "https://kb.realload.com/docs/userguide/#launched-cloud-instances-by-cloud-credits",
"targetBlank": true
},
{
"helpKey": "HelpKey_LoadTestJobsMenu",
"keyEnabled": true,
"hrefTitle": "Load Test Jobs",
"href": "https://kb.realload.com/docs/userguide/#load-test-jobs-menu",
"targetBlank": true
},
{
"helpKey": "HelpKey_MeasuringAgentsAndClusterControllersMenu",
"keyEnabled": true,
"hrefTitle": "Measuring Agents and Cluster Controllers",
"href": "https://kb.realload.com/docs/userguide/#measuring-agents--cluster-controllers",
"targetBlank": true
},
{
"helpKey": "HelpKey_MobileCompanionApp",
"keyEnabled": true,
"hrefTitle": "Mobile Companion App",
"href": "https://kb.realload.com/docs/mobile-companion/",
"targetBlank": true
},
{
"helpKey": "HelpKey_ProjectsMenu",
"keyEnabled": true,
"hrefTitle": "Projects Menu",
"href": "https://kb.realload.com/docs/userguide/#projects-menu",
"targetBlank": true
},
{
"helpKey": "HelpKey_RealTimeViewMenu",
"keyEnabled": true,
"hrefTitle": "Real Time View",
"href": "https://kb.realload.com/docs/userguide/#real-time-view-menu",
"targetBlank": true
},
{
"helpKey": "HelpKey_SyntheticMonitoring",
"keyEnabled": true,
"hrefTitle": "Synthetic Monitoring",
"href": "https://kb.realload.com/docs/synthetic-monitoring/",
"targetBlank": true
},
{
"helpKey": "HelpKey_TestResultsMenu",
"keyEnabled": true,
"hrefTitle": "Test Results",
"href": "https://kb.realload.com/docs/userguide/#test-results-menu",
"targetBlank": true
},
{
"helpKey": "HelpKey_TestsMenu",
"keyEnabled": true,
"hrefTitle": "RealLoad Tests",
"href": "https://kb.realload.com/docs/userguide/#tests-menu",
"targetBlank": true
},
{
"helpKey": "HelpKey_UserInputFieldsWizard",
"keyEnabled": true,
"hrefTitle": "User Input Fields Wizard",
"href": "https://kb.realload.com/docs/userguide/#user-input-fields-wizard",
"targetBlank": true
}
],
"isError": false
}
getExternalHelpLink
Specific Request Fields:
- helpKey
Specific Error Flags:
- helpKeyError
JSON Request Example:
{
"action":"getExternalHelpLink",
"helpKey": "HelpKey_ProjectsMenu"
}
JSON Response Example (Success Case):
{
"externalHelpLink": {
"helpKey": "HelpKey_ProjectsMenu",
"keyEnabled": true,
"hrefTitle": "Projects Menu",
"href": "https://kb.realload.com/docs/userguide/#projects-menu",
"targetBlank": true
},
"isError": false
}
JSON Response Example (Error Case):
{
"isError": true,
"genericErrorText": "",
"helpKeyError": true
}