Collections API

Search for devices in the enterprise using Esper Query Language(EQL). EQL is a domain-specific language to query the devices in the enterprise.

API to search using EQL.

API to search using EQL(Esper Query Language)

Request
path Parameters
enterprise_id
required
string <uuid>

The id of the enterprise

query Parameters
limit
integer

The numbers of items to return

offset
integer

The number of items to skip before starting to collect the result set

id
boolean

Returns only ID in the search results

q
string

EQL query to search for devices

Responses
200

successful operation

get/v0/enterprise/{enterprise_id}/collection/search/
Response samples
application/json
{
  • "total": 0,
  • "total_ms": 0,
  • "results": [
    ]
}

Get collection information.

Get complete information related to the collection

Request
path Parameters
enterprise_id
required
string <uuid>

The id of the enterprise

collection_id
required
string <uuid>

The id of collections

query Parameters
limit
integer

The numbers of items to return

offset
integer

The number of items to skip before starting to collect the result set

Responses
200

successful operation

get/v0/enterprise/{enterprise_id}/collection/{collection_id}/
Response samples
application/json
{
  • "id": 0,
  • "enterprise_id": "2dbe425a-b3bc-4170-8bae-9e5391aafea6",
  • "name": "string",
  • "description": "string",
  • "eql": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update the collection.

Update the information of collection

Request
path Parameters
enterprise_id
required
string <uuid>

The id of the enterprise

collection_id
required
string <uuid>

The id of collections

query Parameters
limit
integer

The numbers of items to return

offset
integer

The number of items to skip before starting to collect the result set

Responses
200

successful operation

patch/v0/enterprise/{enterprise_id}/collection/{collection_id}/
Response samples
application/json
{
  • "id": 0,
  • "enterprise_id": "2dbe425a-b3bc-4170-8bae-9e5391aafea6",
  • "name": "string",
  • "description": "string",
  • "eql": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete a collection.

Delete any collection

Request
path Parameters
enterprise_id
required
string <uuid>

The id of the enterprise

collection_id
required
string <uuid>

The id of collections

query Parameters
limit
integer

The numbers of items to return

offset
integer

The number of items to skip before starting to collect the result set

Responses
204

Deleted succesfully

delete/v0/enterprise/{enterprise_id}/collection/{collection_id}/

List all the collections for the enterprise.

List all the collections for the enterprise

Request
path Parameters
enterprise_id
required
string <uuid>

The id of the enterprise

Responses
200

successful operation

get/v0/enterprise/{enterprise_id}/collection/
Response samples
application/json
{
  • "count": 0,
  • "results": [
    ]
}

Save a collection.

Save a collection

Request
path Parameters
enterprise_id
required
string <uuid>

The id of the enterprise

Responses
200

successful operation

post/v0/enterprise/{enterprise_id}/collection/
Response samples
application/json
{
  • "id": 0,
  • "enterprise_id": "2dbe425a-b3bc-4170-8bae-9e5391aafea6",
  • "name": "string",
  • "description": "string",
  • "eql": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}