REST API

This section contains links to documentation about direct query REST APIs, token authentication, and some scripting API interfaces. More complete API documentation is available on the interactive Swagger OpenAPI documentation instance.

Complete open source clients are available for Golang with hosted documentation.

The test API located at /api/test can be used to verify that the webserver is up and functioning. The test API is unauthenticated and always responds with a StatusOK 200 and an empty body if the webserver is available.

Authenticating with the REST API

• API Tokens System

REST APIs

• Gravwell Direct Query API

---

Scripting API

This section documents the API available in Script automations. The libraries and functions documented below can be used to accomplish complex tasks using Gravwell’s scripting engine.

Script Automations

• Automation Script APIs & Examples