Activity and account

Where the account is in setting up es-python

Returns the steps of the dashboard's setup checklist for es-python and the next one to do. has_plan is false until a plan is set up for the account. machines_total, machines_installed and machines_pending count es-python machines by status. sources_on is true when at least one es-python source of untrusted data is On for the account or for one of its es-python machines. ran is true once es-python has been started on a machine. events_total counts es-python events, leaving out self-test events, and stops counting at 100. selftest_seen is true when eyalsec selftest has reached the dashboard in the last 30 days. next_step is one of plan, add_machine, install, sources, run, first_event, done. empty_reason is one plain sentence saying why the es-python events list is empty, or empty when there is no setup reason. Cheap enough to poll every few seconds.

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

get/api/onboarding_state/

Request

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

Response

OK.

object required

Changes

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