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/rmo

Using invalid parameter keys or invalid parameter values will result in an error code. These are explained below.

Creation parameters

Key	Format	Required	Default Value	Description
swo	text	Yes	n/a	The name of an existing work order as defined in MyConnection Server (MCS)
rsn	alphanumeric	No	computername	Session ID. Used to identify and retrieve results from the server. If left blank, it defaults to the computer name detected when the reservation runs on the client.
grp	alphanumeric	No	Background	Group Name. Specify the satellite group where the reservation will appear when viewing the list of satellites in MCS. If no group name is provided, the default "background" group will be used. If the specified group name doesn't exist, it will be created automatically.
itl	integer (1-1,000)	No	3	Iteration limit. The number of times a single client can run the reservation.
dtl	integer (1-1,000)	No	100	Distribution limit. The number of unique clients the reservation can be run on.
dll	integer	No	-1	Download limit. The number of downloads allowed for the reservation. -1 = no limit.
dti	hh–hh	No		Download time range. Restricts the time window that a reservation can be downloaded.
rti	hh–hh	No		Run-time time range. Restricts the time window that a reservation can be run.
rir	IP, IP range, CIDR	No		Run-time IP(s). Restricts the running of a reservation to certain client IPs.
dir	IP, IP range, CIDR	No		Download IP(s). Restricts the downloading of a reservation to certain client IPs.
accid	integer (9-19)	No		Account ID. By default, data has an account id of 0 (public).
exp	integer	No	-1	Expiry. -1 means the reservation will not expire. Setting a value of 1 or greater, in days, will expire the reservation when the days expire.
sps	text	No	Permit	Permit State. Accepts two values: "permit", meaning the reservation runs immediately upon connecting to the server, or "wait", meaning the reservation connects to the server but requires manual approval to run.

Usage

An example of an API URL that sets an expiry of 10 days, a work order named voiptest, and a session ID of test is below.

https://yoururl.mcs.com/myspeed/admin/rmo?swo=voiptest&rsn=test&exp=10

If the parameters are correct and the values are valid, the API URL will respond with an 8 character alphanumeric like ACDF5C2D. This is the reservation key. This is needed for users to download the reservation.

Error Codes

If an issue occurs during the create reservation request—such as an unexpected parameter or invalid value—an error code from the list below will be returned. Additionally, security measures protect against code injection attempts, which, if detected, will result in a "403 Forbidden" response.

Code	Format	Meaning
410	nnn,message	Invalid work order: parameter missing/incorrect or work order not found.
411	nnn,message	Invalid request: unknown or misspelled parameters present.
412	nnn,message	Invalid time range: the accepted time range format is hh-hh.
413	nnn,message	Invalid IP or IP range: accepted formats include a single IP address, an IP range (xxx.xxx.xxx.xxx-xxx.xxx.xxx.xxx), or CIDR notation (0.0.0.0/24).
414	nnn,message	Invalid account ID: accepted format is numeric, between 9 and 19 digits in length.
415	nnn,message	Invalid expiry: accepted values are -1 for no expiry or a numeric value of 1 or greater representing the number of days until expiry.
416	nnn,message	Invalid permission state: accepted values are "permit" to allow the reservation to begin testing immediately upon connecting, or "wait" to require manual approval before starting the reservation.
417	nnn,message	Invalid iteration limit: accepted value is an integer from 1 to 1000.
418	nnn,message	Invalid distribution limit: accepted value is an integer from 1 to 1000.
419	nnn,message	Invalid download limit: accepted values are -1 for no limit or a numeric value of 1 or greater.

Security

Creating a reservation is reserved for users of MCS with admin or rmo privilege.

When utilizing 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 and control, it's recommended that reservation requests from external sources originate from a single IP address. You can configure the auto-login feature within MCS at the URL below.

https://yourmcs.mcs.com/myspeed/admin/serversecurity