Create pack APIedit

[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Create packs.

Requestedit

POST <kibana host>:<port>/api/osquery/packs

POST <kibana host>:<port>/s/<space_id>/api/osquery/packs

Path parametersedit

space_id
(Optional, string) The space identifier. When space_id is not provided in the URL, the default space is used.

Request bodyedit

name
(Required, string) The pack name.
description
(Optional, string) The pack description.
enabled
(Optional, boolean) Enables the pack.
policy_ids
(Optional, array) A list of agents policy IDs.
queries
(Required, object) An object of queries.

Response codeedit

200
Indicates a successful call.

Examplesedit

Create a pack:

$ curl -X POST api/osquery/packs \
{
  "name": "my_pack",
  "description": "My pack",
  "enabled": true,
  "policy_ids": [
    "my_policy_id"
  ],
  "queries": {
    "my_query": {
      "query": "SELECT * FROM listening_ports;",
      "interval": 60,
      "ecs_mapping": {
        "client.port": {
          "field": "port"
        },
        "tags": {
          "value": ["tag1", "tag2"]
        }
      }
    }
  }
}

The API returns the pack object:

{
    "data": {...}
}