mobile menu
About MCS
Solutions
Try a Demo
MyConnection Server
BCS
Information

Retrieve Reservations via API URL

Query existing satellite reservations using a parameter-driven API URL.

Overview

Existing reservations can be retrieved externally from the MCS interface using a parameter-driven API URL, provided the necessary security feature (auto-login) is enabled.

https://<your-mcs-server>/myspeed/admin/rmolist

Using invalid parameter keys or values will result in an error code.

Retrieval Parameters

Key Format Required Description
ofmt json Yes Must be included for the request to work. Always set to json.
matchswo string Yes* Filter by work order name. Wildcard * is accepted.
matchaid integer Yes* Filter by account ID. Wildcard * is accepted.
matchgrp string Yes* Filter by group name. Wildcard * is accepted.
matchusr string Yes* Filter by username that created the reservation. Wildcard * is accepted.
matchuid string Yes* Filter by UDID — the unique string associated with a running satellite. Returns any reservation run by a satellite matching the specified pattern. Wildcard * is accepted.

* Note: At least one of the filter parameters (matchswo, matchaid, matchgrp, matchusr, matchuid) must be included in the request.

Usage

Return every reservation (wildcard on work order name):

https://<your-mcs-server>/myspeed/admin/rmolist?ofmt=json&matchswo=*

Return all reservations created by user admin with a work order name containing newyork:

https://<your-mcs-server>/myspeed/admin/rmolist?ofmt=json&matchswo=*newyork*&matchusr=admin

Response Format

A successful response is an array containing a status code and a JSON object. Each reservation is listed by its alphanumeric key:

[200, {
    "A5433GD6": {
        "swo": "swoname",
        "aid": "-"
    }
}]

If no reservations match the parameters, the JSON object is empty:

[200, {}]

Response Fields

Key Description
swo Work order assigned to the reservation.
rsn Session ID. Can be overridden when downloading the reservation.
grp Satellite group name. Defaults to "background" if not set.
ct Creation time as a UNIX timestamp in milliseconds.
usr Username that created the reservation.
du Distributions used — number of unique systems that have run the reservation.
dlc Download count.
itl Iteration limit — times a single client can run the reservation.
dtl Distribution limit — number of unique clients allowed.
dll Download limit. -1 = no limit.
dti Download time range restriction.
rtr Run-time time range restriction.
rir Run-time IP restriction (IP, IP range, or CIDR).
dir Download IP restriction (IP, IP range, or CIDR).
aid Account ID. A hyphen if none; otherwise a 9–19 digit number.
exp Expiry. -1 = never expires. Otherwise a UNIX timestamp in milliseconds — if the current time exceeds this value, the reservation has expired.
sps Permit state. 0 = Wait, 1 = Permit.

Error Codes

If an issue occurs — such as an unexpected parameter or invalid value — an error code is returned. Security measures also protect against code injection attempts, which result in a 403 Forbidden response.

The error response format is an array containing the error code and a message string:

[410, 'Error message']

Security

Retrieving reservations requires MCS users with admin or rmo privilege.

When using the API URL from remote applications, the auto-login feature must be enabled. This feature automatically treats connections from specified IP addresses as authenticated, assigning them a defined privilege level. For enhanced security, it is recommended that requests from external sources originate from a single IP address.

The auto-login feature can be configured within MCS at:

https://<your-mcs-server>/myspeed/admin/serversecurity
© Visualware Inc. 2026