Create a live query

Base URL: https://{kibana_url}

POST /api/osquery/live_queries

Create and run a live query.

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Request body

agent_all boolean: When true, the query runs on all agents.
agent_ids string[]: A list of agent IDs to run the query on.
agent_platforms string[]: A list of agent platforms to run the query on.
agent_policy_ids string[]: A list of agent policy IDs to run the query on.
alert_ids string[]: A list of alert IDs associated with the live query.
case_ids string[]: A list of case IDs associated with the live query.
ecs_mapping map string to object: Map osquery results columns or static values to Elastic Common Schema (ECS) fields
event_ids string[]: A list of event IDs associated with the live query.
metadata object nullable: Custom metadata object associated with the live query.
pack_id string: The ID of the pack.
queries object[]: An array of queries to run.
query string: The SQL query you want to run.
saved_query_id string: The ID of a saved query.

Response

Indicates a successful call.

application/json

data object required

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/osquery/live_queries
{
  "agent_all": true,
  "ecs_mapping": {
    "host.uptime": {
      "field": "total_seconds"
    }
  },
  "query": "select * from uptime;"
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/osquery/live_queries" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_all": true,
    "ecs_mapping": {
      "host.uptime": {
        "field": "total_seconds"
      }
    },
    "query": "select * from uptime;"
  }'

Generated from the API spec

Response

{
  "data": {
    "@timestamp": "2022-07-26T09:59:32.220Z",
    "action_id": "3c42c847-eb30-4452-80e0-728584042334",
    "agent_all": true,
    "agents": [
      "16d7caf5-efd2-4212-9b62-73dafc91fa13"
    ],
    "expiration": "2022-07-26T10:04:32.220Z",
    "input_type": "osquery",
    "queries": [
      {
        "action_id": "609c4c66-ba3d-43fa-afdd-53e244577aa0",
        "agents": [
          "16d7caf5-efd2-4212-9b62-73dafc91fa13"
        ],
        "id": "6724a474-cbba-41ef-a1aa-66aebf0879e2",
        "query": "select * from uptime;",
        "timeout": 120
      }
    ],
    "type": "INPUT_ACTION",
    "user_id": "elastic"
  }
}

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/osquery/live_queries
{
  "agent_ids": [
    "16d7caf5-efd2-4212-9b62-73dafc91fa13"
  ],
  "query": "select * from processes;"
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/osquery/live_queries" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_ids": [
      "16d7caf5-efd2-4212-9b62-73dafc91fa13"
    ],
    "query": "select * from processes;"
  }'

Generated from the API spec

Response

{
  "data": {
    "@timestamp": "2022-07-26T09:59:32.220Z",
    "action_id": "3c42c847-eb30-4452-80e0-728584042334",
    "agent_all": true,
    "agents": [
      "16d7caf5-efd2-4212-9b62-73dafc91fa13"
    ],
    "expiration": "2022-07-26T10:04:32.220Z",
    "input_type": "osquery",
    "queries": [
      {
        "action_id": "609c4c66-ba3d-43fa-afdd-53e244577aa0",
        "agents": [
          "16d7caf5-efd2-4212-9b62-73dafc91fa13"
        ],
        "id": "6724a474-cbba-41ef-a1aa-66aebf0879e2",
        "query": "select * from uptime;",
        "timeout": 120
      }
    ],
    "type": "INPUT_ACTION",
    "user_id": "elastic"
  }
}

Authentication

Request body { }

Response

Request body