Overview
Reservations can be created externally from the MCS interface using a parameter-driven API URL, provided the necessary security feature (auto-login) is enabled.
https://yoururl.mcs.com/myspeed/admin/rmoUsing invalid parameter keys or values will result in an error code.
Creation Parameters
| Key | Format | Required | Default | Description |
|---|---|---|---|---|
swo |
text | Yes | — | Name of an existing work order as defined in MCS. |
rsn |
alphanumeric | No | computername | Session ID. Used to identify and retrieve results. Defaults to the client computer name if left blank. |
grp |
alphanumeric | No | Background | Group name. Specifies the satellite group where the reservation appears. If the group does not exist, it is created automatically. |
itl |
integer (1–1,000) | No | 3 | Iteration limit. Number of times a single client can run the reservation. |
dtl |
integer (1–1,000) | No | 100 | Distribution limit. Number of unique clients the reservation can run on. |
dll |
integer | No | -1 | Download limit. Number of downloads allowed. -1 = no limit. |
dti |
hh–hh | No | Download time range. Restricts when the reservation can be downloaded. | |
rti |
hh–hh | No | Run-time time range. Restricts when the reservation can be run. | |
rir |
IP, IP range, CIDR | No | Run-time IPs. Restricts running to certain client IP addresses. | |
dir |
IP, IP range, CIDR | No | Download IPs. Restricts downloading to certain client IP addresses. | |
accid |
integer (9–19 digits) | No | Account ID. By default, data has an account ID of 0 (public). | |
exp |
integer | No | -1 | Expiry in days. -1 = no expiry. A value of 1 or greater expires the reservation after that many days. |
sps |
text | No | permit | Permit state. permit = runs immediately on connection. wait = requires manual approval to run. |
Usage
An example API URL that sets an expiry of 10 days, a work order named voiptest, and a session ID of test:
https://yoururl.mcs.com/myspeed/admin/rmo?swo=voiptest&rsn=test&exp=10If the parameters and values are valid, the API responds with an 8-character alphanumeric key such as ACDF5C2D. This is the reservation key, needed for users to download the reservation.
Error Codes
If an issue occurs during the request — 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.
| Code | Meaning |
|---|---|
410 |
Invalid work order: parameter missing/incorrect or work order not found. |
411 |
Invalid request: unknown or misspelled parameters present. |
412 |
Invalid time range: accepted format is hh-hh. |
413 |
Invalid IP or IP range: accepted formats are a single IP, an IP range (x.x.x.x-x.x.x.x), or CIDR notation (0.0.0.0/24). |
414 |
Invalid account ID: must be numeric, 9–19 digits in length. |
415 |
Invalid expiry: accepted values are -1 (no expiry) or a positive integer representing days. |
416 |
Invalid permission state: accepted values are permit or wait. |
417 |
Invalid iteration limit: must be an integer from 1 to 1,000. |
418 |
Invalid distribution limit: must be an integer from 1 to 1,000. |
419 |
Invalid download limit: accepted values are -1 (no limit) or a positive integer. |
Security
Creating a reservation 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 reservation requests from external sources originate from a single IP address.
The auto-login feature can be configured within MCS at:
https://yourmcs.mcs.com/myspeed/admin/serversecurity