CI

What one es-python machine's runs reported since a moment, for failing a CI build

Lists the es-python events that programs on one machine reported at or after since, and counts those at or above min_severity. An event counts when one of the machine's runs reached it inside the window, even if an earlier run had reached it too; new marks the ones no run had reached before the window. Only events the es-python events page would show are counted: your product access, monthly event quota, saved filters, your global and this machine's Hide rules and the live (not suppressed) bucket all apply, so a finding you hid or that was suppressed never fails a build. The value that reached the sink is not returned, because CI logs are often public; open the event on the dashboard (url) to see it. Add format=text for key=value lines that a shell script can read without a JSON parser. 404 when no es-python machine has that name, 409 when more than one does, 403 without es-python on your account.

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

get/api/ci/findings/

Request

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

Query parameters

machinestring required

The machine's display name (exact match, es-python machines only).

sincestring required

Window start: RFC3339, Unix seconds, or an HTTP date such as a Date response header. Use server_time from POST /api/ci/install/ so the runner's clock does not matter.

min_severitystring

critical, high (the default), medium, low or info. findings counts events at or above it.

limitinteger

How many of those events to list, worst first, 0 to 100 (default 20). The counts always cover all of them.

formatstring

text for key=value lines instead of JSON.

Response

OK.

object required

Changes

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