You may want to first check out my article on Getting Started with the SiteScope REST API and this MicroFocus PDF.

A GET request can be made to endpoint /api/monitors to return the full list of monitors. For example, here is how you could submit the GET request using curl on Linux.

curl --request GET --user <username>:<password> --url http://<SiteScope hostname or IP address>:<port>/SiteScope/api/monitors

And here is a practical example.

curl --request GET --user john.doe:itsasecret --url http://sitescope.example.com:8080/SiteScope/api/monitors

Something like this should be returned.

• sis_path_delimiter often maps to a forward slash, which means the foo monitor is at production/foo/https://foo.example.com/

{
    "production": "Group",
    "production_sis_path_delimiter_foo_sis_path_delimiter_https://foo.example.com/": "Monitor",
    "production_sis_path_delimiter_bar_sis_path_delimiter_https://bar.example.com/": "Monitor"
}

Here is how you can get the snapshot for the monitor.

• whitespace must be replaced with %20

• long dash (em dash) must be replaced with TBD

curl --request GET --user john.doe:itsasecret --url http://sitescope.example.com:8080/SiteScope/api/monitors/snapshots?fullPathsToMonitors=<monitor name from prior command>

Which should return something like this.

{
    "production_sis_path_delimiter_foo_sis_path_delimiter_https://foo.example.com/": {
        "configuration_snapshot": {
            "acknowledgment_comment": "",
            "associated_alerts_disable_description": "",
            "associated_alerts_disable_end_time": "",
            "associated_alerts_disable_start_time": "",
            "description": "",
            "disable_description": "",
            "disable_end_Time": "",
            "disable_start_time": "",
            "full_path": "production_sis_path_delimiter_foo_sis_path_delimiter_https://foo.example.com/",
            "is_associated_alerts_disabled": "false",
            "is_disabled_permanently": "false",
            "name": "TEST Captcha",
            "target_display_name": "foo.example.com",
            "target_ip": "",
            "target_name": "foo.example.com",
            "type": "URL Monitor",
            "updated_date": "1677150601291"
        },
        "runtime_snapshot": {
            "availability": "false",
            "availability_description": "No Data",
            "status": "Error",
            "summary": "not found"
        }
    }
}