API Endpoints

Overview 

This guide documents currently available Nuclei API endpoints, including: 

• GET /v2
• GET /v2/events
• GET /v2/me

Status API

The Status API endpoint can be used to confirm the availability of the Nuclei API.  

Endpoint

GET /v2

Request Attributes

None

Response Object

{
    "message": "Nuclei Firehose API v2.0"
}

Account API

The Account API can be used to retrieve your account settings. 

Endpoint

GET /v2/me

Request Attributes

None

Response Object

{
    "customer_name": "Contoso, Inc"
}

Events API

The Events API can be used to retrieve a list of Nuclei events.

Endpoint

GET /v2/events

Request Attributes

start_date (string)

The start of the time period from which to retrieve events. Must use the ISO 8601 date and time format. 

end_date (string)

The end of the time period from which to retrieve events. Must use the ISO 8601 date and time format. 

include_source (boolean)

Optional. If enabled, the response will include extended metadata from the source platform.  

next_page (string)

Optional. A token that has been provided by the Nuclei API that can be used to retrieve the next page of results.  

Example

GET /v2/events?start_date={start_date}&end_date={end_date}&next_page={next_page}

Response Object

{
    "count": 1,
    "events": [
        {
            "archive_id": "3cecc7f3-954f-40bd-9967-4d9be79953c3",
            "event_metadata": {
                "event_start": "2022-02-09T23:45:10",
                "network_name": "Zoom Chat",
                "participants": [
                    {
                        "participant_display_name": "John Smith",
                        "participant_email_address": "john@contoso.com",
                        "participant_first_name": null,
                        "participant_id": "john@contoso.com",
                        "participant_last_name": null,
                        "participant_phone_number": null,
                        "participant_type": "Sender",
                        "participant_user_name": null
                    },
                    {
                        "participant_display_name": "Jill Price",
                        "participant_email_address": "jill@contoso.com",
                        "participant_first_name": null,
                        "participant_id": "jill@contoso.com",
                        "participant_last_name": null,
                        "participant_phone_number": null,
                        "participant_type": "Recipient",
                        "participant_user_name": null
                    }
                ],
                "source_event_id": "8E1C7677-0C87-4A1B-A0B7-781B9BF41576",
                "source_thread_id": "w5JyRv5o2aaTNS1xo9FUK7GfmocINSpKD3yxiASS82La7CrTJheDEV3zj4jE0cVr"
            },
            "event_state": "ARCHIVED",
            "feed_id": "FEED#46HJeM7wXgZvDGyRgqXSvt",
            "id": "da05d988-a1ae-42a1-ac23-10b605a58117"
        }
    ],
    "next_page": "eyJHU0kyUEsiOiAiQ1VTV"
}

Response Attributes

count (integer)

The number of events that were included in the response. 

events (array)

A list of events that were included include in the response. 

next_page (string, or None)

A token that can be used to retrieve the next page of results. The value of the next_page attribute is None when no additional results are available.

Resources

Documentation - Nuclei API - Introduction

Documentation - Nuclei API - Changelog

Documentation - Nuclei API - Using Nuclei APIs

More Information

For more information on working with Nuclei APIs please contact Nuclei's support team at support@nuclei.ai.