Jump to Content

Home Guides API Reference Changelog 💬 Discussions

v1.0

API Reference

v1.0Home Guides API Reference Changelog 💬 Discussions

LogRhythm Admin Service API

lists
identities
identity lists
- Get Identity From Listget
entities
hosts
networks
users
knowledgebase
notification groups
logsources
agents
licenses
- Get Licensed Entitlements *get
- List licensesget
mperules
beats
openCollectors
locations
- Provides all available locations.get
- Provides location details by location ID.get
mpePolicies
messagesourcedateformats
- List Date Formatsget
- Get Message Source Date Formatget

LogRhythm AIE Drill Down API

/drilldown/{alarmID}
- Get Drill-Down Logs and Summaryget
/drilldown/{alarmID}/summary
- Get Drill-Down Summaryget

LogRhythm Alarm API

alarms

LogRhythm Case API

Case Summary
Case Metrics
- Get Case Metricsget
- Update Case Metricsput
Case Evidence
Playbooks
Playbook Procedures
Playbook Attachments
Playbook Import / Export
- Import Playbookpost
- Export Playbookget
Files
Case Tags
- Add Case Tags *put
- Remove Case Tags *put
Case Collaborators
Associated Cases
Case History
- List Case History *get
Case Playbooks
Case Playbook Procedures
Case Playbook Attachments
Global History
- List Global History *get
Logs Indexes
- List Logs Indexes (All Cases)get
Tags
Capabilities
- Get Capabilitiesget
Users
Feature Flags
- Get Feature Flags *get
Maintenance
- Run Log Evidence Maintenance *post

LogRhythm Metrics API

Log Volume
- Get Log Volume Detailspost
TTL
- Get TTL detailsget

LogRhythm Search API

Search API
- Initiate Searchpost
- Search Resultpost

LogRhythm Admin Service API

lists
identities
identity lists
- Get Identity From Listget
entities
hosts
networks
users
knowledgebase
notification groups
logsources
agents
licenses
- Get Licensed Entitlements *get
- List licensesget
mperules
beats
openCollectors
locations
- Provides all available locations.get
- Provides location details by location ID.get
mpePolicies
messagesourcedateformats
- List Date Formatsget
- Get Message Source Date Formatget

LogRhythm AIE Drill Down API

/drilldown/{alarmID}
- Get Drill-Down Logs and Summaryget
/drilldown/{alarmID}/summary
- Get Drill-Down Summaryget

LogRhythm Alarm API

alarms

LogRhythm Case API

Case Summary
Case Metrics
- Get Case Metricsget
- Update Case Metricsput
Case Evidence
Playbooks
Playbook Procedures
Playbook Attachments
Playbook Import / Export
- Import Playbookpost
- Export Playbookget
Files
Case Tags
- Add Case Tags *put
- Remove Case Tags *put
Case Collaborators
Associated Cases
Case History
- List Case History *get
Case Playbooks
Case Playbook Procedures
Case Playbook Attachments
Global History
- List Global History *get
Logs Indexes
- List Logs Indexes (All Cases)get
Tags
Capabilities
- Get Capabilitiesget
Users
Feature Flags
- Get Feature Flags *get
Maintenance
- Run Log Evidence Maintenance *post

LogRhythm Metrics API

Log Volume
- Get Log Volume Detailspost
TTL
- Get TTL detailsget

LogRhythm Search API

Search API
- Initiate Searchpost
- Search Resultpost

Get Network Details

get https://localhost:8501/lr-admin-api/networks/{id}

Returns Network details based on the networkID.

Language

Click Try It! to start a request and see the response here!