System APIs
The System APIs let you perform system related tasks such as license management, updates, backup and restore, open door, snapshots, application, and plugins management on behalf of a Fabric-enabled LogPoint.
SystemSettingsEnrichment
The SystemSettingsEnrichment API allows you to configure and manage enrichment settings on behalf of a Fabric-enabled LogPoint.
Using enrichment, incoming log data can be enhanced, refined, and improved. Enrichment adds contextual information and improves the usability of the logs. The incoming logs can be enriched with information available to the corresponding Fabric-enabled LogPoint from other sources.
Endpoint
Description
List
Lists the enrichment settings.
RefreshList
Syncs the existing enrichment settings data.
Save
Updates the existing enrichment settings.
SystemSettingsGeneral
The SystemSettingsGeneral API allows you to configure and manage general system settings like a Fabric-enabled LogPoint's information, default login screen, and session inactivity timeout time.
Endpoint
Description
List
Lists the general system settings.
ListAuth
Lists the authentication types for LogPoint.
RefreshList
Updates the authentication types for LogPoint.
Save
Updates the existing general system settings.
SystemSettingsNTP
The SystemSettingsNTP API allows you to configure and manage NTP settings on behalf of a Fabric-enabled LogPoint. NTP synchronizes the time of your appliance with a network time server.
Endpoint
Description
List
Lists the NTP settings.
NTPRestart
Restarts the NTP Server if it is enabled in the Fabric-enabled LogPoint.
Save
Updates the existing NTP settings.
SystemSettingsSMTP
The SystemSettingsSMTP API allows you to configure and manage SMTP settings on behalf of a Fabric-enabled LogPoint.
SMTP is used to send emails from the Fabric-enabled LogPoint. The alert engine uses SMTP service to forward information. You need to configure the SMTP service before using the Fabric-enabled LogPoint to send emails.
Endpoint
Description
List
Lists the SMTP settings.
SMTPTest
Tests the SMTP settings.
Save
Updates the existing SMTP settings.
SystemSettingsSNMP
The SystemSettingsSNMP API allows you to configure and manage SNMP settings on behalf of a Fabric-enabled LogPoint.
Endpoint
Description
List
Lists the SNMP settings.
Save
Updates the existing SNMP settings.
SystemSettingsSSH
The SystemSettingsSSH API allows you to configure and manage SSH settings on behalf of a Fabric-enabled LogPoint. SSH settings generate SSH certificates for the li-admin user.
Endpoint
Description
List
Lists the SSH settings.
Save
Updates the exisitng SSH settings.
SystemSettingsSupportConnection
The SystemSettingsSupportConnection API allows you to configure and manage support connection settings on behalf of a Fabric-enabled LogPoint.
The support connection creates an encrypted end-to-end communication channel between the Fabric-enabled LogPoint and the LogPoint support.
Endpoint
Description
List
Lists the support connection settings.
RefreshList
Syncs the current support connection settings list with LogPoint's support connection settings.
Save
Updates the existing support connection settings.
SystemSettingsModeOfOperation
The SystemSettingsModeOfOperation API allows you to set a mode of operation of a Fabric-enabled LogPoint.
A Fabric-enabled LogPoint can be operated in two modes: LogPoint Collector and Syslog Forwarder.
Endpoint
Description
List
Lists the modes of operation settings.
Save
Updates the existing mode of operation to a LogPoint Collector or a Syslog Forwarder.
SystemSettingsHTTPS
The SystemSettingsHTTPS API allows you to configure and manage HTTPS settings on behalf of a Fabric-enabled LogPoint.
The HTTPS service authenticates the Fabric-enabled LogPoint and prevents eavesdroppers from accessing the data in the network. HTTPS secures the server connection so that the Fabric-enabled LogPoint can easily be accessed from the Internet.
You must have a certificate and a key to enable the HTTPS option.
Endpoint
Description
InstallCertificate
Installs the certificate and key uploaded in the Fabric Storage to the Fabric-enabled LogPoint.
List
Lists the keys and certificate in the private storage for the requested pool.
ListPublic
Lists the keys and certificate in the public storage for the requested pool.
TrashPrivate
Deletes the file with the given name from the private storage.
TrashPublic
Deletes the file with the given name from the public storage.
UploadCertificate
Uploads the certificate and key files to the Fabric storage.
UploadCertificateToPool
Uploads the certificate and key files to the private storage.
SystemSettingsLockoutPolicy
The SystemSettingsLockoutPolicy API allows you to configure and manage the lockout policy settings of a Fabric-enabled LogPoint.
The lockout policy lets you control user login and password security attributes. LogPoint locks your account for a specific lockout duration if you make multiple failed login attempts. Refer to the Lockout Policy section in the LogPoint Administrator Manual for more details.
Endpoint
Description
List
Lists the current lockout policy settings.
PolicyReset
Restores the default lockout policy settings.
Save
Updates the existing lockout policy settings with the given settings.
Upload
The Upload API allows you to upload applications to the Fabric Storage for installation on the Fabric-enabled LogPoints.
If you upload the plugins or applications privately (using the Upload - Upload endpoint), they are only accessible within a specific LogPoint Pool. If you upload the plugins or applications publicly (using the Upload - UploadPublic endpoint), they are accessible by all LogPoint pools in the Director setup.
Endpoint
Description
Install
Installs the applications and patches already uploaded to the Fabric Storage, to the Fabric-enabled LogPoint.
List
Lists the files in private storage.
ListPublic
Lists the files in the public storage.
TrashPrivate
Deletes the file with the given name from the private storage.
TrashPublic
Deletes the file with the given name from the public storage.
Upload
Uploads files to the private storage.
UploadPublicFiles
Uploads files to the public storage.
OpenDoor
The OpenDoor API allows you to enable connections between a Fabric-enabled LogPoint and remote LogPoints.
When enabled, a remote LogPoint can add your Fabric-enabled LogPoint machine as its Distributed LogPoint. After enabling Open Door and configuring the remote LogPoints for a distributed network, you can centrally manage logs from a remote location. Under distributed architecture, the central server controls and manages the remote LogPoints.
Endpoint
Description
Create
Adds a new remote connection.
Get
Fetches details of a remote connection by the given Open Door ID.
List
Lists the remote connections.
BackupAndRestore
The BackupAndRestore API allows you to create and restore backups on behalf of a Fabric-enabled LogPoint.
Using this API, you can create a backup of repos and configurations of a Fabric-enabled LogPoint, and restore them in the future.
Endpoint
Description
BackupNow
Adds a backup of files at the current time.
CreateConfigBackup
Backs up the configuration details of Fabric-enabled LogPoint and all of its collectors or fetchers.
CreateLogsChecksumBackup
Backs up the logs, index of the logs and the checksum of the logs of the Fabric-enabled LogPoint.
Get
Fetches the backup data with the given ID.
List
Lists the backup data.
ListSettings
Lists the backup and restore settings.
LogChecksumBackupNow
Backs up the logs, index of the logs, and the checksum of the logs of the Fabric-enabled LogPoint at the current time.
RefreshList
Updates the list of backup schedule.
Restore
Restores the backup data.
Trash
Deletes the backup data with the given ID.
Snapshots
The Snapshots API allows you to save the state of a Fabric-enabled LogPoint so that you can revert to it at any time in the future.
A snapshot captures the entire state of the system. It preserves the Fabric-enabled LogPoint's data just as it was when you took the snapshot.
Endpoint
Description
Create
Adds a new snapshot of a machine.
Get
Fetches a snapshot with the given ID.
List
Lists the snapshots.
Revert
Reverts to the snapshot with the given ID.
Trash
Deletes the snapshot with the given ID.
Plugins
The Plugins API allows you to get information about the plugins installed on a Fabric-enabled LogPoint. You can also uninstall plugins on behalf of a Fabric-enabled LogPoint.
Plugins or pluggable components are similar to the browser add-ons that can be used to support extra functionaties in a Fabric-enabled LogPoint.
Endpoint
Description
Get
Fetches the plugin with the given ID.
List
Lists the plugins.
Uninstall
Uninstalls the plugin with the given ID.
Last updated
Was this helpful?