DistributedCollectors¶

DistributedCollectors - Activate¶

Activates a distributed collector.

POST

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

Parameter

Field	Label in UI	Type	Description
id	-	String	Existing distributed collector ID. Execute DistributedCollectors - List API to obtain the id of required Distributed Collector. Mandatory Field

Request Example

{
    "data": {}
}

Success Response

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

DistributedCollectors - Deactivate¶

Deactivate a distributed collector.

POST

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

Parameter

Field	Label in UI	Type	Description
id	-	String	Existing distributed collector ID. Execute DistributedCollectors - List API to obtain the id of required Distributed Collector. Mandatory Field

Request Example

{
    "data": {}
}

Success Response

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

DistributedCollectors - Get¶

Fetches a distributed collector with given ID.

GET

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

Parameter

Field	Label in UI	Type	Description
id	-	String	Existing distributed collector ID. Execute DistributedCollectors - List API to obtain the id of required Distributed Collector.

Success Response

{
    "active": true,
    "buffering": true,
    "description": "",
    "file_socket_port": 6900,
    "id": "59b62b15d8aaa4245809137f",
    "identifier": "a8131f6cfb314e87b7cfdaedfee238a0",
    "ip": "192.168.100.79",
    "is_li_light": true,
    "name": "LogPoint79",
    "tid": ""
}

DistributedCollectors - List¶

Lists all distributed collectors.

GET

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

Success Response

[
    [
        {
            "active": true,
            "buffering": false,
            "description": "",
            "file_socket_port": 6900,
            "id": "59086b2e854ff52ff3344eb5",
            "identifier": "e2bb6740612049929b89a559043522f3",
            "ip": "10.45.1.188",
            "is_li_light": true,
            "name": "LogPoint",
            "tid": ""
        }
    ]
]

DistributedCollectors - RefreshList¶

Refresh the list to sync distributed collector data.

POST

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

Request Example

{
    "data": {}
}

Success Response

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

DistributedCollectors - Trash¶

Deletes a distributed collector with given ID.

DELETE

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

Parameter

Field	Label in UI	Type	Description
id	-	String	Existing distributed collector ID. Execute DistributedCollectors - List API to obtain the id of required Distributed Collector. Mandatory Field

Success Response

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

Helpful?