To fetch metadata of a SSH Server object send a GET request to:|xml)

example. request json with curl utility:

curl -H "authorization: bearer _token"

example. request xml with curl utility:

curl -H "authorization: bearer _token"

table below is the list of fields contained in the response, this list will be properly formatted to json or xml as requested.


Param Data type Access Description
id integer read SSH Server identifier
remote_host string read/write Remote host address
remote_port integer read/write Remote host port
name string read/write Name of the server
description string read/write Server description
space_tool_id string read SSH tool identifier


Field Validator Description
remote_host presence validator Remote host should be present.
remote_host format validator Remote host should pass this regex: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-zA-Z]|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9])$.
remote_port presence validator Remote port should be present.
remote_port inclusion validator Remote port should be in range 1..65535
name presence validator Name should be present.
name format validator Name should pass this regex: ^[a-zA-Z0-9 _]+$.