Knowledge Base APIs
The Knowledge Base APIs let you configure and manage the items of the Knowledge Base section of a Logpoint.
The Knowledge Base APIs let you analyze the normalized data using search queries for dashboards and reports, and alerts rules for incidents.
NormalizationPackage
The NormalizationPackage API allows you to configure and manage normalization packages on behalf of a Fabric-enabled Logpoint.
Normalization Packages are the collections of log signatures. A normalization package uses log signatures to define the rules for extracting the key-value pairs from a log.
AlertRules
The AlertRules API allows you to configure and manage alert rules on behalf of a Fabric-enabled Logpoint.
Alerts are warnings generated to notify users when any significant events occur. They fire incidents that enable you to execute appropriate actions. Any valid search query can trigger an alert to generate incidents.
Endpoint
Description
Activate
Activates the alert rule with given ID in a Fabric-enabled Logpoint.
Create
Creates a new alert rule for a Fabric-enabled Logpoint.
Deactivate
Deactivates the alert rule with given ID in a Fabric-enabled Logpoint.
Edit
Updates the configuration settings of the alert rule with the given ID.
EmailNotification
Configures the email notification for the alert rule with the given ID.
FetchMyRules
Fetches the alert rules defined under MyRules section.
FetchSharedRules
Lists the alert rules shared with the user.
FetchUsedRules
Lists the alert rules previously used by the user.
FetchUsedSharedRules
Fetches the alert rules that were shared by users and are currently being used in the given Logpoint.
FetchVendorRules
List the alert rules provided by the vendor.
HTTPNotification
Configures the HTTP notification for the alert rule with the given ID.
Install
Installs an alert rule application file in a Fabric-enabled Logpoint.
ListPrivateUploads
Lists the alert rules from private storage.
ListPublicUploads
Lists the alert rules from public storage.
SNMPNotification
Configures the SNMP notification for the alert rule with the given ID.
SSHNotification
Configures the SSH notification for the alert rule with the given ID.
ShareWithUsers
Shares the alert rule of the given ID with other users.
SyslogNotification
Configures the Syslog notification for the alert rule with the given ID.
TransferOwnership
Transfers the ownership of an alert rule to another user.
Trash
Deletes the alert rule with the given ID.
TrashPrivateUploads
Deletes the file by its name from the private storage.
TrashPublicUploads
Deletes the file by its name from the public storage.
Upload
Uploads the alert rule application file to the private storage.
UploadPublic
Uploads the alert rules application file to the public storage.
UseAlertRules
Allows you to use an alert rule provided by the vendor or shared by other users.
Lists
The Lists API allows you to configure and manage lists on behalf of a Fabric-enabled Logpoint.
Lists are a collection of values. You can use a list to search logs associated with the values in it. Refer to the Lists section in the Logpoint Data Integration guide for more details.
Endpoint
Description
CreateDynamic
Creates a dynamic list that collects specific values from the runtime events and stores them for a limited or an unlimited period.
CreateStatic
Creates a static list of pre-defined values.
EditDynamic
Edits the dynamic list with the given ID.
EditStatic
Edits the static list with the given ID.
Get
Fetches the list with the given ID.
Install
Installs the given list package file in a Fabric-enabled Logpoint.
List
Lists the static and dynamic lists in a Fabric-enabled Logpoint.
ListPrivateUploads
Lists the list package files uploaded in the private storage.
ListPublicUploads
Lists the list package files uploaded in the public storage.
Trash
Deletes the list with the given ID.
TrashPrivateUploads
Deletes the lists from the private storage.
TrashPublicUploads
Deletes the lists from the public storage.
Upload
Uploads a list package file in the private storage.
UploadPublic
Uploads a list package file in the public storage.
Macros
The Macros API allows you to configure and manage macros on behalf of a Fabric-enabled Logpoint.
Macros lets you save any search query with an alias and use the name to perform a search action based on the saved query in a Fabric-enabled Logpoint. Refer to the Macros section in the Logpoint Search guide for more details.
Endpoint
Description
Create
Creates a macro in a Fabric-enabled Logpoint.
Edit
Updates the existing macro with the given ID.
Get
Fetches the macro with the given ID.
Install
Installs the given macro package file in a Fabric-enabled Logpoint.
List
Lists the macros in a Fabric-enabled Logpoint.
ListPrivateUploads
Lists the macro package files uploaded in private storage.
ListPublicUploads
Lists the macro package files uploaded in public storage.
Trash
Deletes the macro with the given ID.
TrashPrivateUploads
Deletes the macro from private storage.
TrashPublicUploads
Deletes the macro from public storage.
Upload
Uploads a macro package file in private storage.
UploadPublic
Uploads a macro package file in public storage.
LabelPackages
The LabelPackages API allows you to configure and manage label packages on behalf of a Fabric-enabled Logpoint.
Label packages are the collection of labeling rules. Labeling rules are search terms that apply specific search labels to log messages. Using search labels, you can group similar logs. Refer to the Label Packages section in Logpoint for more details.
Endpoint
Description
Activate
Activates the label package with the given ID in a Fabric-enabled Logpoint.
Clone
Clones the label package with the given ID.
Create
Creates a label package in a Fabric-enabled Logpoint.
Deactivate
Deactivates the label package with given ID in a Fabric-enabled Logpoint.
Edit
Updates the existing label package with the given ID.
Get
Fetches the label package with the given ID.
Install
Installs the given label package file in a Fabric-enabled Logpoint.
List
Lists the label packages in a Fabric-enabled Logpoint.
ListPrivateUploads
Lists the label package files uploaded in private storage.
ListPublicUploads
Lists the label package files uploaded in public storage.
Trash
Deletes the label package with the given ID.
TrashPrivateUploads
Deletes the label package from private storage.
TrashPublicUploads
Deletes the label package from public storage.
Upload
Uploads a label package file in private storage.
UploadPublic
Uploads a label package file in public storage.
SearchLabels
The SearchLabels API allows you to create and manage search labels. You can add search labels to the label packages and apply them to log messages in a Fabric-enabled Logpoint.
Endpoint
Description
Activate
Activates the search label with the given ID in a Fabric-enabled Logpoint.
Create
Creates a search label in a Fabric-enabled Logpoint.
Deactivate
Deactivates the search label with the given ID in a Fabric-enabled Logpoint.
Edit
Updates the search label with the given ID.
Trash
Deletes the search labels with the given ID.
Tables
The Tables API allows you to configure and manage dynamic tables for a Fabric-enabled Logpoint.
Tables store the data that you can use to enrich the logs. A dynamic table is a table where you can specify the fields and obtain the values for the specified fields during runtime for a limited or an unlimited period of time. For more details, go to the Tables section in Logpoint Data Integration.
Endpoint
Description
Create
Creates a dynamic table that stores the specified field and field values synchronously during the runtime for a limited or unlimited period of time.
Edit
Updates the dynamic table with the given ID.
Get
Fetches a single dynamic table with the given ID.
List
Lists all dynamic tables. Obtain the current data of tables with Logpoint's tables using EnrichmentSource-RefreshList.
Trash
Deletes the dynamic table with the given ID.
Last updated
Was this helpful?