Create SSH Server

Version 4.0.24.14

Create an SSH Server.

Request

POST /ssh_servers
Datatype
Description
Request
HTTP Request
body
HTTP Body
Expand HTTP Body definition...
body
SSH Server
Expand SshServer definition...
ssh_server_id
string
A unique id used to identify this SSH Server
ssh_server_name
string
The name to identify this SSH Server
ssh_server_host
string
The hostname or ip address of the SSH Server
ssh_server_port
integer
The port to connect to on the SSH Server
ssh_server_user
string
The username used to connect to the SSH Server
finger_print
string
The md5 fingerprint used to identify the SSH Server
sha_finger_print
string
The SHA fingerprint used to identify the SSH Server
public_key
string
The SSH public key created for this instance
status
string
The current connection status to this SSH Server

Response

200: SSH Server

Datatype
Description
(object)
ssh_server_id
string
A unique id used to identify this SSH Server
ssh_server_name
string
The name to identify this SSH Server
ssh_server_host
string
The hostname or ip address of the SSH Server
ssh_server_port
integer
The port to connect to on the SSH Server
ssh_server_user
string
The username used to connect to the SSH Server
finger_print
string
The md5 fingerprint used to identify the SSH Server
sha_finger_print
string
The SHA fingerprint used to identify the SSH Server
public_key
string
The SSH public key created for this instance
status
string
The current connection status to this SSH Server

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

409: Resource Already Exists

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

422: Validation Error

Datatype
Description
(object)
message
string
Error details
Expand ValidationErrorDetail definition...
field
string
Field with error
code
string
Error code
message
string
Error info message
documentation_url
string
Documentation link
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link