POST
/
firework
/
v4
/
events
/
tenant
/
_search
curl --request POST \
  --url https://api.flare.io/firework/v4/events/tenant/_search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "query": {},
  "size": 123,
  "from": "<string>",
  "order": "<string>",
  "filters": {
    "severity": [
      "<string>"
    ],
    "type": [
      "<string>"
    ],
    "estimated_created_at": {
      "gt": "<string>",
      "gte": "<string>",
      "lt": "<string>",
      "lte": "<string>"
    }
  }
}'
{
    "items": [
        {
            "metadata": {
                "estimated_created_at": "2019-09-20T16:30:37.589388Z",
                "type": "listing",
                "uid": "listing/apollon_market/9861",
                "severity": "critical"
            },
            "tenant_metadata": {
                "severity": {
                    "original": "low",
                    "override": "critical"
                },
                "tags": [
                    "important",
                ],
                "notes": "This reason why this is tagged as 'important' is: ..."
            },
            "identifiers": [
                {
                    "id": 1,
                    "name": "An identifier"
                }
            ],
            "highlights": {
                "description": [
                    "Bank Statement PSD <mark>Template</mark>\r\n\r\nWe promise:\r\n- Your order will be delivered instantly."
                ],
                "title": [
                    "Bank Statement PSD <mark>Template</mark>"
                ]
            }
        }
    ],
    "next": "WzE1Njg5OTcwMzc1ODksICJsaXN0aW5nL2Fwb2xsb25fbWFya2V0Lzk4NjEiXQ%3D%3D"
}

Returns a list of events matching the identifiers of the current tenant.

​
Guides

See the guide for using this endpoint: Exporting a Tenant’s Events .

{
    "items": [
        {
            "metadata": {
                "estimated_created_at": "2019-09-20T16:30:37.589388Z",
                "type": "listing",
                "uid": "listing/apollon_market/9861",
                "severity": "critical"
            },
            "tenant_metadata": {
                "severity": {
                    "original": "low",
                    "override": "critical"
                },
                "tags": [
                    "important",
                ],
                "notes": "This reason why this is tagged as 'important' is: ..."
            },
            "identifiers": [
                {
                    "id": 1,
                    "name": "An identifier"
                }
            ],
            "highlights": {
                "description": [
                    "Bank Statement PSD <mark>Template</mark>\r\n\r\nWe promise:\r\n- Your order will be delivered instantly."
                ],
                "title": [
                    "Bank Statement PSD <mark>Template</mark>"
                ]
            }
        }
    ],
    "next": "WzE1Njg5OTcwMzc1ODksICJsaXN0aW5nL2Fwb2xsb25fbWFya2V0Lzk4NjEiXQ%3D%3D"
}

​
Paging

This endpoint supports the Flare standard paging pattern .

​
Body Parameters

​
query
object

One of the supported queries. 

{
  "type": "domain",
  "fqdn": "<string>"
}
​
size
number

Limit number of events that will be returned. (Max 10)

​
from
string

The next value from the last response.

​
order
string
default:
"desc"

The order in which the results will be returned.

​
filters
object
​
severity
string[]

If a string value is specified, results will contain events that have a greater than or equal severity. Otherwise, if an array of severities is specified, results will only contain events that exactly match one of them.

​
type
string[]

Learn more about Event Source Filters .

​
estimated_created_at
object

Was this page helpful?

Suggest editsRaise issue
Event actions (ignore, remediate, etc.)
Previous
List Tenant Credentials
Next