The create command is used to provision a new Vista Session.

JSON Input Data Format
{
    "name": string,
    "gate": string,
    "user": string,
    "protocol": string,
    "instance": string,
    "port": integer,
    "token": string
}
name * Specifies the name for the session, which can be anything.
gate * Specifies the ID of the Access Gates that will be used to establish the encrypted session tunnel.
user * Specifies the ID of the identity that will be granted access.
protocol * Specifies the protocol for the session, which can be set to one of the following:
  • http or https
    The Vista Connect client will launch a web browser and navigate to the specified instance and port.
  • ssh
    The Vista Connect client will launch a SSH session to the specified instance and port.
  • rdp
    The Vista Connect client will launch a RDP session to the specified instance and port.
  • spice
    The Vista Connect client will launch a SPICE session to the specified instance and port.
  • vnc or xvnc
    The Vista Connect client will launch a VNC session to the specified instance and port.
  • custom
    The Vista Connect client will only inform the user of the accessible port after the session has been created to the specified instance and port.
instance * Specifies the ID of the instance that will be granted access.
port * Specifies the port number on the instance that will be tunneled. For SPICE and XVNC protocols, this port number must be the access point port that directs to the {ANYNODE}.
token * Specifies a token for the session that adds an additional layer of encryption. The token values can only contain uppercase ASCII letters (A-Z), lowercase ASCII letters (a-z), and numbers (0-9), and must be at least 60 characters long.
* Indicates a mandatory field.

Code Snippets
Here are several code snippets provided for your direct use. Simply select your preferred tool/language by clicking on it.


Successful Response
{
    "result": "OK",
    "payload": "The process was successfully completed",
    "id": "V7-49ff499f-xxxx-xxxx-xxxx-b47fxxxx99af"
}

Failed Response
{
    "result": "ERR",
    "message": "Error message ..."
}