Filters, rules and taint

Get a machine's taint configuration

Returns the tri-state taint config for the given scope (machine query param = a machine public_id, '' or absent = global). Every gate key is reported as on, off, or unset: socket, file, stdin, foreign, env, make_vuln, argv, weak_random, hardcoded, build, posture, concurrency, resource, secret, memory, ffi, lifetime, arith, identity, subprocess, worker, dns, db_rows, calldata, caller, returndata, storage, chainenv, oracle, http, report_cmdline, report_env, report_code, drop_suppressed, handoff. drop_suppressed is not a taint source: switched on, the server discards that machine's suppressed events as they arrive instead of storing them, and a discarded event cannot be recovered. Each product's filters page offers the subset listed for that product. A key an agent has no counterpart for is ignored by that agent, never mapped onto a different source. es-chromium, es-c, es-cpp, es-node, es-ruby and es-php do not fetch this configuration at all, so nothing set here reaches them.

This is a read: a read-only API key may call it.

get/api/machine_taint/

Request

  • Base URL: https://eyalsec.com
  • URL: https://eyalsec.com/api/machine_taint/
  • Auth: one of:
    • API key in header X-API-Key
    • API key in cookie __Host-es2session

Query parameters

machinestring

Machine public_id to scope to; omit for global.

Response

OK. For example:

{
  "taint": {
    "socket": "on",
    "file": "unset",
    "stdin": "unset",
    "foreign": "off",
    "env": "unset",
    …one entry for every gate key
  }
}
object required

Changes

No recorded changes to this operation across all 1 revision of this API.