Create a Gateway Vertex
post
/api/gateway/Gateways
Creates a new gateway vertex.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ConnectionTypeID: integer
Connection Type 0 => TCP Socket 1 => Telnet login 2 => SSH loginExample:
0
-
Delimiter: string
The message delimiter used by the gateway.Example:
;
-
Description: string
Description of the Gateway.Example:
-
DeviceID: integer
Unique identifier associated with the device name.Example:
54
-
Elements: array
Elements
Selection of associated Network Elements for this gateway.
-
GatewayName: string
The name of the gateway, which must be unique within the database.Example:
Gateway1
-
LoginPrompt: string
If Connection Type is set to "SSH Login" or "Telnet Login", optional regex match for login prompt (default is "[$%#>] $").
-
Password: string
If Connection Type is set to "SSH Login" or "Telnet Login", the password to use when connecting to Gateway.Example:
admin
-
Port: integer
Connection port.Example:
9001
-
StatusID: integer
Status ID 0 => Disabled 1 => EnabledExample:
1
-
Username: string
If Connection Type is set to "SSH Login" or "Telnet Login", the username to use when connecting to Gateway.Example:
admin
Nested Schema : Elements
Type:
array
Selection of associated Network Elements for this gateway.
Show Source
Example:
[
"b1e9b165-5f05-4e41-8031-e9f7586a88f9"
]
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Added record
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : gatewayGatewaysRead
Type:
Show Source
object
-
ConnectionType: string
Gateway Connection Type. Plain TCP Socket, SSH login or Telnet login.Example:
TCP socket
-
ConnectionTypeID: integer
Connection Type 0 => TCP Socket 1 => Telnet login 2 => SSH loginExample:
0
-
Delimiter: string
The message delimiter used by the gateway.Example:
;
-
Description: string
Description of the Gateway.Example:
-
DeviceID: integer
Unique identifier associated with the device name.Example:
54
-
DeviceName: string
The Device Catalog entry associated to the Gateway, which is used for connection information.Example:
router.example.com
-
ElementCount: integer
Count of the Gateway Element.Example:
1
-
Elements: array
Elements
Selection of associated Network Elements for this gateway.
-
GatewayID: string
Unique identifier for the gateway.Example:
a433d205-4cae-45c3-a637-50b08840ea63
-
GatewayName: string
The name of the gateway, which must be unique within the database.Example:
Gateway1
-
NoPromptCheck: boolean
If Connection Type is set to "SSH Login" or "Telnet Login" and the TL1 device does not return a prompt on successful login, check this box.Example:
false
-
Password: string
If Connection Type is set to "SSH Login" or "Telnet Login", the password to use when connecting to Gateway.Example:
admin
-
Port: integer
Connection port.Example:
9001
-
StatusID: integer
Status ID 0 => Disabled 1 => EnabledExample:
1
-
StatusName: string
The status of the gateway.Example:
Enabled
-
Username: string
If Connection Type is set to "SSH Login" or "Telnet Login", the username to use when connecting to Gateway.Example:
admin
Nested Schema : Elements
Type:
array
Selection of associated Network Elements for this gateway.
Show Source
Example:
[
{
"ElementID":"b1e9b165-5f05-4e41-8031-e9f7586a88f9",
"ElementName":"Element1"
}
]
Nested Schema : items
Type:
Show Source
object
-
ElementID: string
Element IDExample:
b1e9b165-5f05-4e41-8031-e9f7586a88f9
-
ElementName: string
Element NameExample:
Element1
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object