Skip to main content

Axiom

Axiom stores your events. Huntbase secures them. Connect an Axiom organisation and Huntbase queries your datasets where they are, in APL (Axiom Processing Language). Nothing is copied out of Axiom to make that work.

With an Axiom connection you can:

  • ask Scout questions and run hunts over your Axiom datasets;
  • run Sigma watchers against Axiom on a schedule, or push them into Axiom as its own monitors;
  • look back through Axiom for your threat intel indicators;
  • send the rows of scheduled queries to an Axiom dataset;
  • keep a running risk score per user, host and IP in an Axiom dataset.

Before you start​

Create an API token in Axiom under Settings › API tokens. What it needs depends on what you want Huntbase to do:

ToThe token needs
Search datasets from HuntbaseQuery permission on the datasets to hunt
Send scheduled results to AxiomIngest permission on the dataset that receives them
Write risk eventsIngest and query permission on the risk dataset
Push watchers as monitorsA separate token that can manage monitors and notifiers, added as the connection's rule-write credential

API tokens start with xaat-. A personal access token also works, but then Huntbase also needs your Organisation ID (in Axiom under Settings › General).

tip

Give Huntbase its own token, and grant it only the datasets you want it to read. You can limit the token's query cost in Axiom too. See Keep query compute low.

Connect Axiom​

  1. Go to Connections and click New connection, then pick Axiom. You can also start from Connect another lake and choose Axiom.

  2. On Details, name the connection and answer How will you use it?:

    ChoiceWhat happens
    Search it from HuntbaseScout, hunts, watchers and threat intel look-backs search its data.
    Send scheduled results to itHuntbase sends the rows of scheduled queries to it. It is not searched.
    BothHuntbase searches it and sends scheduled results to it.
  3. On Connect, paste the API token. Leave Axiom API URL at https://api.axiom.co unless Axiom gave you a different endpoint.

  4. On Verify, click Create & check.

If you already have an Axiom connection, the form says so and offers to use it for both instead of creating a second one.

After the check passes, Huntbase discovers the datasets the token can read and their fields. Each dataset appears on the connection's page.

To keep Huntbase out of a dataset, exclude it from search with its switch in the connection's list of discovered datasets. Huntbase then doesn't search it anywhere: queries, hunts, Scout, threat intel look-backs and normalised queries all skip it. An APL query that names an excluded dataset is refused. Excluding a dataset doesn't change access in Axiom: limit the API token's dataset access there for that. A watcher deployment on an excluded dataset fails its runs, so remove it first.

Settings​

FieldNotes
Axiom API URLAxiom's API base URL. Leave the default unless told otherwise.
Send scheduled results toAn Axiom dataset name, such as huntbase-telemetry. The dataset must already exist. Leave empty to only query Axiom.
Which scheduled resultsHuntbase scheduled queries, endpoint schedules run on the host (osquery), both, or Only the schedules I name.
Organisation IDUnder Advanced. Only needed with a personal access token.
Send risk events toAn Axiom dataset for risk-based alerting. Leave empty to turn it off.
Risk threshold, Tactics threshold, Detections neededUnder Advanced. When to raise a risk alert. See When it raises an insight.
Datasets to check for threat intelUnder Advanced. Comma-separated datasets that intel look-backs search. Leave empty to search every event dataset.
Ingest URLUnder Advanced. Only if sending fails. Huntbase normally finds the dataset's edge domain by itself.

Each scheduled query adds its columns to the receiving dataset, and Axiom limits how many fields a dataset can have. Send only the schedules you need.

Query Axiom in APL​

In a query tab, pick APL and your Axiom connection. A query starts from a dataset and pipes it through operators:

['okta-logs']
| where outcome == "FAILURE"
| summarize count() by user
  • Quote dataset and field names that contain dots, dashes or spaces: ['client.ip'].
  • The time range comes from the time-range pill and is sent with the run, so the query doesn't need a _time filter.
  • Axiom returns 1,000 rows when you set no limit. Use take or limit for more, or fewer.

The connection ships with starter templates in Content library › Queries, such as Search a dataset for an indicator, Event volume per hour, Rare values of a field and Encoded or obfuscated command lines.

On Auto, Scout writes APL for you when the question is about data in Axiom, and says which dataset it searched.

What runs on Axiom​

FeatureHow it uses Axiom
HuntsHunt steps run APL over the hunt's time window.
Watcher deploymentsHuntbase converts a Sigma watcher to APL and searches a dataset on a schedule, at most once an hour by default. See Query budgets.
Threat intel look-backSearches your datasets for new indicators from your feeds.
Scheduled resultsSends the rows of scheduled queries to the dataset you chose. Ad-hoc queries, hunts and Scout queries are never sent.

In this section​

Next steps​