<no title> — API Documentation release/2.8.0 documentation

Director - Director Fabric - API Documentation

2.8.0 (latest)

Director - Director Fabric - API Documentation

Version:

2.8.0 (latest)

Page Contents

Director Console API
- Accessing the API endpoints
- Conventions for Non-Breaking and Breaking Changes
  - Non-Breaking Changes
  - Breaking Changes
- Guidelines for Director Console API Clients
  - General Guidelines
  - API Usage Guidelines
AlertRules
- AlertRules - Activate
- AlertRules - Create
- AlertRules - Deactivate
- AlertRules - Edit
- AlertRules - EmailNotification
- AlertRules - FetchMyRules
- AlertRules - FetchSharedRules
- AlertRules - FetchUsedRules
- AlertRules - FetchUsedSharedRules
- AlertRules - FetchVendorRules
- AlertRules - HTTPNotification
- AlertRules - Install
- AlertRules - ListPrivateUploads
- AlertRules - ListPublicUploads
- AlertRules - SMSNotification
- AlertRules - SNMPNotification
- AlertRules - SSHNotification
- AlertRules - ShareWithUsers
- AlertRules - SyslogNotification
- AlertRules - TransferOwnership
- AlertRules - Trash
- AlertRules - TrashPrivateUploads
- AlertRules - TrashPublicUploads
- AlertRules - UnshareWithUsers
- AlertRules - Upload
- AlertRules - UploadPublic
- AlertRules - UseAlertRules
- AlertRules - UseVendorRules
BackupAndRestore
- BackupAndRestore - BackupNow
- BackupAndRestore - CreateConfigBackup
- BackupAndRestore - CreateLogsChecksumBackup
- BackupAndRestore - Get
- BackupAndRestore - List
- BackupAndRestore - ListSettings
- BackupAndRestore - LogChecksumBackupNow
- BackupAndRestore - RefreshList
- BackupAndRestore - Restore
- BackupAndRestore - Trash
Certificate
- Certificate - FetchUserSSHCertificate
- Certificate - List
- Certificate - ListSystemSSHCertificate
Charsets
- Charsets - ListCharsets
DeviceGroups
- DeviceGroups - Create
- DeviceGroups - Edit
- DeviceGroups - Get
- DeviceGroups - List
- DeviceGroups - Trash
Devices
- Devices - AddIgnoredIPs
- Devices - Attach
- Devices - Create
- Devices - Detach
- Devices - Edit
- Devices - Get
- Devices - GetPlugins
- Devices - Install
- Devices - List
- Devices - ListBlockedIps
- Devices - ListIgnoredIps
- Devices - ListPrivateUploads
- Devices - ListPublicUploads
- Devices - RefreshBlockedIpsList
- Devices - Trash
- Devices - TrashIgnoredIps
- Devices - TrashPrivateUploads
- Devices - TrashPublicUploads
- Devices - Upload
- Devices - UploadPublic
Diagnosis
- Diagnosis - GetDirectorDiagnosisAPIStat
- Diagnosis - GetDirectorDiagnosisFabricStat
- Diagnosis - GetDirectorDiagnosisLPSMStat
- Diagnosis - GetDirectorHealth
- Diagnosis - GetDirectorVersion
- Diagnosis - GetLogpointDiagnosisJava
- Diagnosis - GetLogpointDiagnosisNormFront
- Diagnosis - GetLogpointDiagnosisNormalisers
- Diagnosis - GetLogpointDiagnosisPremerger
- Diagnosis - GetLogpointDiagnosisStat
- Diagnosis - GetLogpointDiagnosisStoreHandler
- Diagnosis - GetPoolInfo
DistributedCollectors
- DistributedCollectors - Activate
- DistributedCollectors - Deactivate
- DistributedCollectors - Get
- DistributedCollectors - List
- DistributedCollectors - RefreshList
- DistributedCollectors - Trash
DistributedLogpoints
- DistributedLogpoints - Create
- DistributedLogpoints - Edit
- DistributedLogpoints - Get
- DistributedLogpoints - List
- DistributedLogpoints - RefreshList
- DistributedLogpoints - Trash
EnrichmentPolicy
- EnrichmentPolicy - Create
- EnrichmentPolicy - Edit
- EnrichmentPolicy - Get
- EnrichmentPolicy - List
- EnrichmentPolicy - Trash
EnrichmentSource
- EnrichmentSource - Get
- EnrichmentSource - List
- EnrichmentSource - RefreshList
FileSystemCollector
- FileSystemCollector - Create
- FileSystemCollector - Edit
- FileSystemCollector - Trash
FTPCollectorPlugin
- FTPCollectorPlugin - Create
- FTPCollectorPlugin - Edit
- FTPCollectorPlugin - Trash
FTPFetcherPlugin
- FTPFetcherPlugin - Create
- FTPFetcherPlugin - Edit
- FTPFetcherPlugin - TestExisting
- FTPFetcherPlugin - TestNew
- FTPFetcherPlugin - Trash
Hardwarekey
- Hardwarekey - List
Incidents
- Incidents - Close
- Incidents - Comment
- Incidents - FetchIncidentData
- Incidents - FetchIncidents
- Incidents - GetIncidentData
- Incidents - Reassign
- Incidents - Reopen
- Incidents - Resolve
- Incidents - SendForInvestigation
IncidentUserGroups
- IncidentUserGroups - Create
- IncidentUserGroups - FetchIncidentUserGroup
- IncidentUserGroups - Get
- IncidentUserGroups - List
- IncidentUserGroups - Trash
IPLookup
- IPLookup - Delete
- IPLookup - Install
- IPLookup - List
- IPLookup - TrashPrivate
- IPLookup - TrashPublic
- IPLookup - Upload
- IPLookup - UploadPublic
- IPLookup - UploadsList
- IPLookup - UploadsListPublic
LDAPAuthentication
- LDAPAuthentication - Activate
- LDAPAuthentication - Create
- LDAPAuthentication - Deactivate
- LDAPAuthentication - Edit
- LDAPAuthentication - Get
- LDAPAuthentication - GetLDAPGroup
- LDAPAuthentication - List
- LDAPAuthentication - ListLDAPGroup
- LDAPAuthentication - MapLDAPGroup
- LDAPAuthentication - RefreshLDAPGroupList
- LDAPAuthentication - Trash
LabelPackages
- LabelPackages - Activate
- LabelPackages - Clone
- LabelPackages - Create
- LabelPackages - Deactivate
- LabelPackages - Edit
- LabelPackages - Get
- LabelPackages - Install
- LabelPackages - List
- LabelPackages - ListPrivateUploads
- LabelPackages - ListPublicUploads
- LabelPackages - Trash
- LabelPackages - TrashPrivateUploads
- LabelPackages - TrashPublicUploads
- LabelPackages - Upload
- LabelPackages - UploadPublic
Lists
- Lists - CreateDynamic
- Lists - CreateStatic
- Lists - EditDynamic
- Lists - EditStatic
- Lists - Get
- Lists - Install
- Lists - List
- Lists - ListPrivateUploads
- Lists - ListPublicUploads
- Lists - RefreshList
- Lists - Trash
- Lists - TrashPrivateUploads
- Lists - TrashPublicUploads
- Lists - Upload
- Lists - UploadPublic
LogCollectionPolicies
- LogCollectionPolicies - Create
- LogCollectionPolicies - Edit
- LogCollectionPolicies - Get
- LogCollectionPolicies - GetPlugins
- LogCollectionPolicies - List
- LogCollectionPolicies - Trash
LogSources
- LogSources - Create
- LogSources - Edit
- LogSources - Get
- LogSources - List
- LogSources - ListLogSourceMetaData
- LogSources - RefreshList
- LogSources - Trash
- LogSources - Upload
MachineInfo
- MachineInfo - List
Macros
- Macros - Create
- Macros - Edit
- Macros - Get
- Macros - Install
- Macros - List
- Macros - ListPrivateUploads
- Macros - ListPublicUploads
- Macros - Trash
- Macros - TrashPrivateUploads
- Macros - TrashPublicUploads
- Macros - Upload
- Macros - UploadPublic
MitreAttacks
- MitreAttacks - FetchMitreAttacks
NormalizationPolicy
- NormalizationPolicy - Create
- NormalizationPolicy - Edit
- NormalizationPolicy - Get
- NormalizationPolicy - List
- NormalizationPolicy - Trash
NormalizationPackage
- NormalizationPackage - AddSignature
- NormalizationPackage - CheckPattern
- NormalizationPackage - ClonePackage
- NormalizationPackage - Create
- NormalizationPackage - Edit
- NormalizationPackage - EditSignature
- NormalizationPackage - Get
- NormalizationPackage - Install
- NormalizationPackage - List
- NormalizationPackage - ListCompiledNormalizers
- NormalizationPackage - ListPrivateUploads
- NormalizationPackage - ListPublicUploads
- NormalizationPackage - RefreshCompiledNormalizersList
- NormalizationPackage - ReorderSignature
- NormalizationPackage - Trash
- NormalizationPackage - TrashPrivateUploads
- NormalizationPackage - TrashPublicUploads
- NormalizationPackage - TrashSignature
- NormalizationPackage - UnuseSignature
- NormalizationPackage - Upload
- NormalizationPackage - UploadPublic
OpenDoor
- OpenDoor - Create
- OpenDoor - Get
- OpenDoor - List
- OpenDoor - Save
Parsers
- Parsers - Check
- Parsers - Create
- Parsers - Edit
- Parsers - Get
- Parsers - List
- Parsers - Trash
PermissionGroups
- PermissionGroups - Create
- PermissionGroups - Edit
- PermissionGroups - Get
- PermissionGroups - List
- PermissionGroups - Trash
PluginConfiguration
- PluginConfiguration - Create
- PluginConfiguration - Edit
- PluginConfiguration - EditInstall
- PluginConfiguration - Get
- PluginConfiguration - Install
- PluginConfiguration - List
- PluginConfiguration - ListPlugins
- PluginConfiguration - ListPrivateUploads
- PluginConfiguration - ListPublicUploads
- PluginConfiguration - RefreshList
- PluginConfiguration - TestExisting
- PluginConfiguration - TestNew
- PluginConfiguration - Trash
- PluginConfiguration - TrashPrivateUploads
- PluginConfiguration - TrashPublicUploads
- PluginConfiguration - Upload
- PluginConfiguration - UploadPublic
Plugins
- Plugins - Get
- Plugins - List
- Plugins - ListPluginsVersion
- Plugins - Uninstall
ProcessingPolicy
- ProcessingPolicy - Create
- ProcessingPolicy - Edit
- ProcessingPolicy - Get
- ProcessingPolicy - List
- ProcessingPolicy - Trash
Query
- Query - ValidateLabelQuery
- Query - ValidateQuery
RawSyslogForwarder
- RawSyslogForwarder - Create
- RawSyslogForwarder - CreateTarget
- RawSyslogForwarder - Edit
- RawSyslogForwarder - EditTarget
- RawSyslogForwarder - Get
- RawSyslogForwarder - GetTarget
- RawSyslogForwarder - List
- RawSyslogForwarder - ListTarget
- RawSyslogForwarder - Trash
- RawSyslogForwarder - TrashTarget
RefreshToken
- RefreshToken - Create
Repos
- Repos - Create
- Repos - Edit
- Repos - FetchRemoteRepos
- Repos - Get
- Repos - List
- Repos - ListRepoPaths
- Repos - RefreshRepoPaths
- Repos - Trash
RoutingPolicies
- RoutingPolicies - Create
- RoutingPolicies - Edit
- RoutingPolicies - Get
- RoutingPolicies - List
- RoutingPolicies - Trash
Search
- Search - FetchSearchLogs
SearchLabels
- SearchLabels - Activate
- SearchLabels - Create
- SearchLabels - Deactivate
- SearchLabels - Edit
- SearchLabels - Trash
SCPFetcher
- SCPFetcher - Create
- SCPFetcher - Edit
- SCPFetcher - TestExisting
- SCPFetcher - TestNew
- SCPFetcher - Trash
SFlowCollectorPlugin
- SFlowCollectorPlugin - Create
- SFlowCollectorPlugin - Edit
- SFlowCollectorPlugin - Trash
SnareCollectorPlugin
- SnareCollectorPlugin - Create
- SnareCollectorPlugin - Edit
- SnareCollectorPlugin - Trash
SNMPFetcher
- SNMPFetcher - Create
- SNMPFetcher - Edit
- SNMPFetcher - TestExisting
- SNMPFetcher - TestNew
- SNMPFetcher - Trash
SNMPPolicy
- SNMPPolicy - Create
- SNMPPolicy - Edit
- SNMPPolicy - Get
- SNMPPolicy - List
- SNMPPolicy - Trash
SNMPTrapCollector
- SNMPTrapCollector - Create
- SNMPTrapCollector - Edit
- SNMPTrapCollector - Trash
SyslogCollector
- SyslogCollector - Create
- SyslogCollector - Edit
- SyslogCollector - Trash
SystemSettingsEnrichment
- SystemSettingsEnrichment - List
- SystemSettingsEnrichment - RefreshList
- SystemSettingsEnrichment - Save
SystemSettingsGeneral
- SystemSettingsGeneral - List
- SystemSettingsGeneral - ListAuth
- SystemSettingsGeneral - RefreshAuthList
- SystemSettingsGeneral - Save
SystemSettingsHTTPS
- SystemSettingsHTTPS - InstallCertificate
- SystemSettingsHTTPS - List
- SystemSettingsHTTPS - ListPublic
- SystemSettingsHTTPS - TrashPrivate
- SystemSettingsHTTPS - TrashPublic
- SystemSettingsHTTPS - UploadCertificate
- SystemSettingsHTTPS - UploadCertificateToPool
SystemSettingsLockoutPolicy
- SystemSettingsLockoutPolicy - List
- SystemSettingsLockoutPolicy - PolicyReset
- SystemSettingsLockoutPolicy - Save
SystemSettingsModesOfOperation
- SystemSettingsModesOfOperation - List
- SystemSettingsModesOfOperation - Save
SystemSettingsNTP
- SystemSettingsNTP - List
- SystemSettingsNTP - NTPRestart
- SystemSettingsNTP - Save
SystemSettingsSMTP
- SystemSettingsSMTP - List
- SystemSettingsSMTP - SMTPTest
- SystemSettingsSMTP - Save
SystemSettingsSNMP
- SystemSettingsSNMP - List
- SystemSettingsSNMP - Save
SystemSettingsSSH
- SystemSettingsSSH - List
- SystemSettingsSSH - Save
SystemSettingsSupportConnection
- SystemSettingsSupportConnection - List
- SystemSettingsSupportConnection - RefreshList
- SystemSettingsSupportConnection - Save
SystemSettingsSyslog
- SystemSettingsSyslog - InstallCertificate
- SystemSettingsSyslog - List
- SystemSettingsSyslog - ListPublic
- SystemSettingsSyslog - ListSyslogSettings
- SystemSettingsSyslog - TrashPrivate
- SystemSettingsSyslog - TrashPublic
- SystemSettingsSyslog - UploadCertificate
- SystemSettingsSyslog - UploadCertificateToPool
Tables
- Tables - Create
- Tables - Edit
- Tables - Get
- Tables - List
- Tables - Trash
Timezone
- Timezone - List
UEBA
- UEBA - ConfigureAlertLogs
- UEBA - ConfigureRepo
- UEBA - CreateEntity
- UEBA - EditEntity
- UEBA - EnableUEBAMode
- UEBA - FetchHealthStatus
- UEBA - FetchUEBALicenseState
- UEBA - FetchValidationReport
- UEBA - GetEntity
- UEBA - InstallUEBALicense
- UEBA - ListEntities
- UEBA - ListPrivateUploads
- UEBA - ListPublicUploads
- UEBA - ListUEBAConfiguration
- UEBA - ListUEBALicenseInfo
- UEBA - RefreshUEBAConfigurationLists
- UEBA - RefreshUEBAEntityLists
- UEBA - TrashEntity
- UEBA - TrashPrivateUploads
- UEBA - TrashPublicUploads
- UEBA - UpdateEntityPriorities
- UEBA - Upload
- UEBA - UploadPublic
Upload
- Upload - Install
- Upload - List
- Upload - ListPublic
- Upload - TrashPrivate
- Upload - TrashPublic
- Upload - Upload
- Upload - UploadPublic files
UserGroups
- UserGroups - Create
- UserGroups - Edit
- UserGroups - Get
- UserGroups - List
- UserGroups - RefreshList
- UserGroups - Trash
Users
- Users - Activate
- Users - ChangePassword
- Users - Create
- Users - Deactivate
- Users - Edit
- Users - FetchUsers
- Users - Get
- Users - List
- Users - RefreshList
- Users - Trash
- Users - Unlock
WMIFetcherPlugin
- WMIFetcherPlugin - Create
- WMIFetcherPlugin - Edit
- WMIFetcherPlugin - TestExisting
- WMIFetcherPlugin - TestNew
- WMIFetcherPlugin - Trash

Helpful?

We are glad this guide helped.

Please don't include any personal information in your comment

Contact Support

×

Navigation

next
API Documentation release/2.8.0 documentation »

Privacy policy EULA Terms of service

Copyright © Logpoint. All rights reserved.