Jump to

• Request
• Response

Create a Gateway Vertex

post

/api/gateway/Gateways

Creates a new gateway vertex.
The minimum required properties in the request body are:

• Port
• DeviceName
• ConnectionTypeID
• StatusID
• Elements

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ConnectionTypeID: integer
  Connection Type 0 => TCP Socket 1 => Telnet login 2 => SSH login

  Example: 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 gateway name.
  To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.

  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
  The gateway status ID. Either 0 (disabled) or 1 (enabled).

  Example: 1
• Username: string
  If Connection Type is set to "SSH Login" or "Telnet Login", the username to use when connecting to Gateway.

  Example: admin

{
    "properties":{
        "GatewayName":{
            "description":"The gateway name.\n<br>To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"Gateway1"
        },
        "Description":{
            "$ref":"#/components/schemas/gatewayGatewaysRead/properties/Description"
        },
        "Port":{
            "$ref":"#/components/schemas/gatewayGatewaysRead/properties/Port"
        },
        "Delimiter":{
            "$ref":"#/components/schemas/gatewayGatewaysRead/properties/Delimiter"
        },
        "DeviceID":{
            "$ref":"#/components/schemas/gatewayGatewaysRead/properties/DeviceID"
        },
        "ConnectionTypeID":{
            "$ref":"#/components/schemas/gatewayGatewaysRead/properties/ConnectionTypeID"
        },
        "Username":{
            "$ref":"#/components/schemas/gatewayGatewaysRead/properties/Username"
        },
        "Password":{
            "$ref":"#/components/schemas/gatewayGatewaysRead/properties/Password"
        },
        "LoginPrompt":{
            "description":"If Connection Type is set to \"SSH Login\" or \"Telnet Login\", optional regex match for login prompt (default is \"[$%#>] $\").",
            "type":"string"
        },
        "StatusID":{
            "$ref":"#/components/schemas/gatewayGatewaysRead/properties/StatusID"
        },
        "Elements":{
            "description":"Selection of associated Network Elements for this gateway.",
            "type":"array",
            "items":{
            },
            "example":[
                "b1e9b165-5f05-4e41-8031-e9f7586a88f9"
            ]
        }
    },
    "type":"object"
}

Nested Schema : Elements

Type: array

Selection of associated Network Elements for this gateway.

Show Source

• Array of:

{
    "description":"Selection of associated Network Elements for this gateway.",
    "type":"array",
    "items":{
    },
    "example":[
        "b1e9b165-5f05-4e41-8031-e9f7586a88f9"
    ]
}

Example:

[
    "b1e9b165-5f05-4e41-8031-e9f7586a88f9"
]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
  The response body for a successful add operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/gatewayGatewaysRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

The response body for a successful add operation.

Show Source

• message: string
  The response message.

  Example: Added record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful add operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/gatewayGatewaysRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object gatewayGatewaysRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/gatewayGatewaysRead"
    }
}

Nested Schema : gatewayGatewaysRead

Type: object

Show Source

• 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 login

  Example: 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
  The gateway status ID. Either 0 (disabled) or 1 (enabled).

  Example: 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

{
    "properties":{
        "GatewayID":{
            "description":"Unique identifier for the gateway.",
            "type":"string",
            "example":"a433d205-4cae-45c3-a637-50b08840ea63"
        },
        "GatewayName":{
            "description":"The name of the gateway, which must be unique within the database.",
            "type":"string",
            "example":"Gateway1"
        },
        "Description":{
            "description":"Description of the Gateway.",
            "type":"string",
            "example":""
        },
        "Port":{
            "description":"Connection port.",
            "type":"integer",
            "example":9001
        },
        "Delimiter":{
            "description":"The message delimiter used by the gateway.",
            "type":"string",
            "example":";"
        },
        "DeviceID":{
            "description":"Unique identifier associated with the device name.",
            "type":"integer",
            "example":54
        },
        "DeviceName":{
            "description":"The Device Catalog entry associated to the Gateway, which is used for connection information.",
            "type":"string",
            "example":"router.example.com"
        },
        "ConnectionTypeID":{
            "description":"Connection Type\n0 => TCP Socket\n1 => Telnet login\n2 => SSH login",
            "type":"integer",
            "example":0
        },
        "ConnectionType":{
            "description":"Gateway Connection Type. Plain TCP Socket, SSH login or Telnet login.",
            "type":"string",
            "example":"TCP socket"
        },
        "NoPromptCheck":{
            "description":"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.",
            "type":"boolean",
            "example":false
        },
        "StatusID":{
            "description":"The gateway status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"integer",
            "example":1
        },
        "StatusName":{
            "description":"The status of the gateway.",
            "type":"string",
            "example":"Enabled"
        },
        "Username":{
            "description":"If Connection Type is set to \"SSH Login\" or \"Telnet Login\", the username to use when connecting to Gateway.",
            "type":"string",
            "example":"admin"
        },
        "Password":{
            "description":"If Connection Type is set to \"SSH Login\" or \"Telnet Login\", the password to use when connecting to Gateway.",
            "type":"string",
            "example":"admin"
        },
        "ElementCount":{
            "description":"Count of the Gateway Element.",
            "type":"integer",
            "example":1
        },
        "Elements":{
            "description":"Selection of associated Network Elements for this gateway.",
            "type":"array",
            "items":{
                "properties":{
                    "ElementID":{
                        "description":"Element ID",
                        "type":"string",
                        "example":"b1e9b165-5f05-4e41-8031-e9f7586a88f9"
                    },
                    "ElementName":{
                        "description":"Element Name",
                        "type":"string",
                        "example":"Element1"
                    }
                }
            },
            "example":[
                {
                    "ElementID":"b1e9b165-5f05-4e41-8031-e9f7586a88f9",
                    "ElementName":"Element1"
                }
            ]
        }
    },
    "type":"object"
}

Nested Schema : Elements

Type: array

Selection of associated Network Elements for this gateway.

Show Source

• Array of: object items

{
    "description":"Selection of associated Network Elements for this gateway.",
    "type":"array",
    "items":{
        "properties":{
            "ElementID":{
                "description":"Element ID",
                "type":"string",
                "example":"b1e9b165-5f05-4e41-8031-e9f7586a88f9"
            },
            "ElementName":{
                "description":"Element Name",
                "type":"string",
                "example":"Element1"
            }
        }
    },
    "example":[
        {
            "ElementID":"b1e9b165-5f05-4e41-8031-e9f7586a88f9",
            "ElementName":"Element1"
        }
    ]
}

Example:

[
    {
        "ElementID":"b1e9b165-5f05-4e41-8031-e9f7586a88f9",
        "ElementName":"Element1"
    }
]

Nested Schema : items

Type: object

Show Source

• ElementID: string
  Element ID

  Example: b1e9b165-5f05-4e41-8031-e9f7586a88f9
• ElementName: string
  Element Name

  Example: Element1

{
    "properties":{
        "ElementID":{
            "description":"Element ID",
            "type":"string",
            "example":"b1e9b165-5f05-4e41-8031-e9f7586a88f9"
        },
        "ElementName":{
            "description":"Element Name",
            "type":"string",
            "example":"Element1"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top