API

This section documents the web API used between the GUI and the “frontend” webserver.

The bulk of the API is RESTful. The exception to this rule is the searching API which uses websockets due to the nature of data exchange and transfer involved in launching and observing data from a search.

APIs & Objects

Basic APIs

• Login
• User Preferences
• User account controls
• User group controls
• Notifications
• Search Controls
• Downloading Search Results
• Search History
• Logging
• Ingesting Entries
• Miscellaneous APIs
• System Management

API Objects

• Auto-extractors
• Dashboards
• Kits
• Macros
• Playbooks
• Resources
• Scheduled Searches
• Search Library
• Templates
• Actionables
• User Files

Search and Stats

• Gravwell Direct Query API

Automation Scripting

• Automation Script APIs & Examples

System Stats

The system stats may be accessed via REST calls.

System Stats (REST)

• REST Stats API

Test API

The System contains a test API located at /api/test which can be used to test if the webserver is alive and functioning. The test API is entirely unauthenticated and always responds with a StatusOK 200 and an empty body.

Tokens

API Tokens System

• API Tokens System