🔗Rest API

Overview

The RMF Web API provides an authenticated REST interface that allows third-party software, such as analytics tools, to access XProtect dual-recording redundancy information. Such information enables third-party software to retrieve video from redundant sources if the primary source fails.

Where does it live?

The WebAPI is installed on the same system as the RMF Services and the Configuration UI. Installation locations vary based on the redundancy architecture, the number of cameras, and other parameters. By default, it is installed along with these components.

For more detail, refer the pageWhat to Install Where.

Configuration

Refer the linkWeb APIfor the configuration of the API port number.

Operation

1

Normal Operation

The third-party component sources video from the primary recorder.

2

Failure Event

The primary recorder fails.

3

API Query

The third-party component queries the RMF API.

4

Connect to the Redundant Source

Based on information provided by the API, the component connects to the redundant source and restores its functionality.

API

Fetch the Redundant Camera Map

Query

XML

Copy

POST http://<management_server_IP>:<rmf_api_port_num>/VegaSystems/RMF/Mapping?type=xml

JSON

Copy

POST http://<management_server_IP>:<rmf_api_port_num>/VegaSystems/RMF/Mapping?type=json

Here:

<management_server_IP> → IP address of the System that hosts the API <rmf_api_port_num> → RMF Port number. The default is 2020.

Body

Copy

{
    "username": <Xprotect credentials>, 
    "password": <XProtect credentials>, 
    "search":[<string1>,<string2>,...]
}

Parameters

Parameter

Info

username

Must be an Active Directly user or a Windows user of Milestone XProtect. Do not use a basic user.

password

The user's password

search

Omitting the search field causes the API to return the complete list of RMF managed cameras. However, if the search field is present, the API returns all cameras whose names partially or completely match any specified search strings. The API will return an empty list when the search strings do not match any camera names or portions of camera names.

Status Code

HTTP Code

appStatusCode

Response Message

200

NA

Login successful

400

Bad request ACCT_AUTH_001

Username or password cannot be null or empty.

401 Unauthorized

ACC_AUTH_022

Login failed. Invalid credentials.

401 Unauthorized

ACC_AUTH_006

Login failed. Invalid credentials.

Example Response

XML Response

JSON Response

API Help Page

From a web browser, access the URL:

http://<management_server_IP>:<rmf_api_port_num>/VegaSystems/Help

to be directed to the RMF API help page as below.

Demo Video