Optimate BGYS

Connection Requirements

1

IP

IP Address of the Optimate BGYS.

2

Port

Port number of the Optimate BGYS.

3

Username

Username of the Optimate BGYS that has access to API.

4

Password

Password of the Optimate BGYS that has access to API.

5

View ID

This is the reference for the View record from which data will be read. It accepts values of type number or string.

  • Number format: The unique ID of the View (e.g., 5).

  • String format: The full system name ({Module.SystemName}.{View.SystemName}, e.g., MyModule.MyView).

6

Profile ID

This is the reference for the Profile record to be used during data reading. It accepts values of type number or string. The requesting user must be a member of the selected profile.

  • Number format: The unique ID of the Profile (e.g., 5).

  • String format: The system name of the Profile (e.g., MyProfile).

7

Hostname Field

The name of the column in your list that contains the device hostnames.

8

IP Address Field

The name of the column in your list that contains devices IP address. This field is optional.

9

First Seen Field

The name of the column in your list that contains devices first seen field. This field is optional.

10

Last Seen Field

The name of the column in your list that contains devices last seen field. This field is optional.

circle-info

First seen and last seen fields dates will be displayed in the format YYYY-MM-DDTHH:MM:SS.ssssssZ (e.g., 2025-08-11T19:45:32.123456Z), which is an ISO 8601 UTC timestamp or in the Epoch format (e.g., 1708430400). You need to change the formats if you want to view these fields. You can add the remaining fields as you wish.

11

SSL

Use SSL for connection. (default: Encrypted).

circle-exclamation

Was this helpful?