Protocols overview

The Protocols section helps you get an overview of supported services, protocols, and APIs.

To view the topics in this section, look under Protocols in the menu to the left.

Management Server supported protocols and access points

The Management Server supported protocols are all accessed on the same port - default port 80.

Server SOAP Protocol. Access point for login, server control and configuration

The Server SOAP protocol provides login, configuration and triggering of user-defined events.

Registration Service

The Registration Service is a dictionary of services available in a given installation. It can be used to get hold of all installed services and their URLs. When multiple services of the same type is installed, it can be used as a round-robin access for load sharing.

Configuration API

The Configuration API enables programmatic management of most areas of the products.

Recording Server supported protocols

The default port is port 7563. For all products, this URL MUST be taken from the configuration.

Recorder SOAP Service

Gives access to commands, data and control commands that relates to specific devices, like PTZ control, recording sequences and more.

Status API (version 1 and 2)

The Status API provides information on status and events for devices.

ImageServer protocol

The ImageServer protocol is a mix of HTTP and XML commands. It is designed to be effective for access to binary data transfer, and provides access to live and playback video/audio and metadata, as well as supporting a number of control commands.

Event Server supported protocols

The Event Server receives, handles and stores all events on a site. To find the address (and port) of the Event Server, you should use the Registration Service web service.

AlarmCommand and AlarmCommandToken

MIP Communication

The MIP Communication is passing through the Event Server. The protocol is not publicly documented, as it implemented using .NET MIP components.

Analytics and MAD events

Analytic events can be sent to the Event Server, when enabled, on port 9090. Format is XML (MAD formatted) or serialized version of the class AnalyticsEvent.

Mobile Server protocol

The Mobile Server protocol is exposed on the Mobile Server, it provides configuration and access to live and playback video as well as PTZ control.

For further information, please refer to https://doc.developer.milestonesys.com/mipsdkmobile/

API Gateway - RESTful APIs

The API Gateway is a front-end that serves as a common entry point to services implemented by the other VMS server services. An API Gateway server can be installed on the same host as the management server or on a separate host, and more than one can be installed (each on their own host).

The RESTful API is exposed at this entry point:

The API Gateway exposes a list of relevant server and API Gateway URIs at this URI:

For API reference documentation, please refer to Milestone Integration Platform VMS RESTful API.

Identity Provider

In addition to Windows (Kerberos or NTLM) user credentials and HTTP Basic Authentication over HTTPS, XProtect offers authentication and authorization using an OpenID Connect- and OAuth2-compliant identity provider (IDP), either internal or external (external IDP supported in 2022 R1 and later). The internal IDP is located on the same host as the management server, and is accessed at this URI:

You can access information about the OpenID configuration at this URI: