OpenDoor¶

OpenDoor - Create¶

Creates a new remote connection for a Distributed LogPoint setup (Distributed LogPoints and Distributed Collectors).

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/OpenDoor

Parameter

Field	Label in UI	Type	Description
netmask	Netmask	String	Netmask address of the Fabric-enabled LogPoint. Mandatory only when the value of opened parameter is set as “on”. Optional Field
network	Private IP	String	Private ip address of the Fabric-enabled LogPoint. Mandatory only when value of opened parameter is set as “on”. The last octet of the IP address should always be 1 (x.x.x.1). Optional Field
opened	Open Door	String	Set the value of this parameter as “on” to enable a remote connection. Requesting this endpoint with empty data will disable the remote connection. Optional Field
password	Password	String	Password to establish a remote connection between individual LogPoints. Mandatory only when the value of opened parameter is set as “on”. Optional Field

Request Example

{
    "data": {
        "netmask": "255.255.255.0",
        "network": "10.4.0.1",
        "opened": "on",
        "password": "examplePassword"
    }
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

OpenDoor - Get¶

Lists the saved OpenDoor configuration with given open door id.

GET

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/OpenDoor/{id}

Parameter

Field	Label in UI	Type	Description
id	-	String	ID of open door

Success Response

{
    "id": "574fb123d8aaa4625bfe2d23",
    "mtu": 1500,
    "netmask": "255.255.255.0",
    "network": "10.4.0.1",
    "opened": "on",
    "password": "5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8"
}

OpenDoor - List¶

Lists the saved OpenDoor configuration.

GET

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/OpenDoor

Success Response

[
    {
        "id": "574fb123d8aaa4625bfe2d23",
        "mtu": 1500,
        "netmask": "255.255.255.0",
        "network": "10.4.0.1",
        "opened": "on",
        "password": "5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8"
    }
]

OpenDoor - Save¶

Updates a new remote connection for a Distributed LogPoint setup (Distributed LogPoints and Distributed Collectors).

POST

https://api-server-host-name/configapi/{pool_UUID}/{logpoint_identifier}/OpenDoor

Parameter

Field	Label in UI	Type	Description
mtu	MTU	int	Maximum Transmissions Unit (MTU) in bytes. All the packets transferred between the Main LogPoint and its Remote LogPoint(s) are chunked into the size of the specified MTU. The default value of the MTU is 1500. Optional Field
netmask	Netmask	String	Netmask address of the Fabric-enabled LogPoint. Mandatory only when the value of opened parameter is set as “on”. Optional Field
network	Private IP	String	Private ip address of the Fabric-enabled LogPoint. Mandatory only when value of opened parameter is set as “on”. The last octet of the IP address should always be 1 (x.x.x.1). Optional Field
opened	Open Door	String	Set the value of this parameter as “on” to enable a remote connection. Requesting this endpoint with empty data will disable the remote connection. Optional Field
password	Password	String	Password to establish a remote connection between individual LogPoints. Mandatory only when the value of opened parameter is set as “on”. Optional Field

Request Example

{
    "data": {
        "mtu": 1500,
        "netmask": "255.255.255.0",
        "network": "10.4.0.1",
        "opened": "on",
        "password": "examplePassword"
    }
}

Success Response

{
    "status": "Success",
    "message": "/monitorapi/{pool_UUID}/{logpoint_identifier}/orders/{request_id}"
}

Helpful?