DistributedLogpoints¶

DistributedLogpoints - Create¶

Adds a new remote LogPoint.

POST

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

Parameter

Field	Label in UI	Type	Description
ip_dns	IP Address or DNS Name	String	IP address of the remote LogPoint. Mandatory Field
password	Password	String	Password for the remote connection provided in the password parameter of the OpenDoor - Create API. Mandatory Field
private_ip	Private IP	String	Private IP address provided in network parameter of the OpenDoor - Create API. Mandatory Field

Request Example

{
    "data": {
        "ip_dns": "192.168.2.23",
        "password": "aaaa",
        "private_ip": "10.2.1.1"
    }
}

Success Response

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

DistributedLogpoints - Edit¶

Edits a remote LogPoint with given ID.

PUT

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

Parameter

Field	Label in UI	Type	Description
id	-	String	ID of the remote LogPoint. Execute DistributedLogPoints - List API to list the details of all Remote LogPoints. Mandatory Field
ip_dns	IP Address or DNS Name	String	Ip address of the remote LogPoint. Passed as string. Mandatory Field
password	Password	String	Password of the remote LogPoint ( during configuring open door at remote LogPoint side). Mandatory Field
private_ip	Private IP	String	Private ip address of the remote LogPoint. Passed as string. Mandatory Field

Request Example

{
    "data": {
        "ip_dns": "192.168.2.23",
        "password": "aaaa",
        "private_ip": "10.2.1.1"
    }
}

Success Response

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

DistributedLogpoints - Get¶

Fetches a remote LogPoint with given ID.

GET

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

Parameter

Field	Label in UI	Type	Description
id	-	String	Existing remote LogPoint ID. Use the value of id parameter of the required remote LogPoint from DistributedLogPoints - List API.

Success Response

{
    "id": "59100cc2d8aaa439015c8086",
    "is_higher_security_lite": false,
    "name": "",
    "private_ip": "10.2.1.1",
    "remote": "test_DLP_8",
    "status": "Connected",
    "vpn_ip": ""
}

DistributedLogpoints - List¶

List all remote LogPoints.

GET

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

Success Response

[
    {
        "id": "59100cc2d8aaa439015c8086",
        "is_higher_security_lite": false,
        "name": "",
        "private_ip": "10.2.1.1",
        "remote": "test_DLP_8",
        "status": "Connected",
        "vpn_ip": ""
    }
]

DistributedLogpoints - RefreshList¶

Updates the list to sync Distributed Logpoints status data

POST

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

Request Example

{
    "data": {}
}

Success Response

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

DistributedLogpoints - Trash¶

Delete remote LogPoint with given ID.

DELETE

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

Parameter

Field	Label in UI	Type	Description
id	-	String	Existing remote LogPoint ID. Mandatory Field

Success Response

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

Helpful?