Fortinet black logo

Integration API Guide

REST API to Return Worker Queue State

REST API to Return Worker Queue State

The following public REST API can be used to query Worker Event Upload Queue state. An upstream load balancer can use the information to route events from Collectors to the least loaded Worker.

Release Added: 6.4.0

API: GET https://<Worker_IP>/workerUploadHealth/response.json

Response: { allowUpload: true, fileQueueSizeMB: 500, fileQueueCount: 300 }

Response Parameter

Description

allowUpload

True means Worker upload queue is less than 100MB and Worker will accept events.

False means Worker upload queue is more than 100MB and Worker will reject events. This is likely because inserts to event database is slow.

fileQueueSizeMB Current file queue size in MB.
fileQueueCount Current file queue count.

REST API to Return Worker Queue State

The following public REST API can be used to query Worker Event Upload Queue state. An upstream load balancer can use the information to route events from Collectors to the least loaded Worker.

Release Added: 6.4.0

API: GET https://<Worker_IP>/workerUploadHealth/response.json

Response: { allowUpload: true, fileQueueSizeMB: 500, fileQueueCount: 300 }

Response Parameter

Description

allowUpload

True means Worker upload queue is less than 100MB and Worker will accept events.

False means Worker upload queue is more than 100MB and Worker will reject events. This is likely because inserts to event database is slow.

fileQueueSizeMB Current file queue size in MB.
fileQueueCount Current file queue count.