Struct EventsAPI

pub struct EventsAPI { /* private fields */ }

The Event Management API allows you to programmatically post events to the Events Explorer and fetch events from the Events Explorer. See the Event Management page for more information.

Update to Datadog monitor events aggregation_key starting March 1, 2025: The Datadog monitor events aggregation_key is unique to each Monitor ID. Starting March 1st, this key will also include Monitor Group, making it unique per Monitor ID and Monitor Group. If you’re using monitor events aggregation_key in dashboard queries or the Event API, you must migrate to use @monitor.id. Reach out to support if you have any question.

Implementations

impl EventsAPI

pub fn new() -> Self

pub fn with_config(config: Configuration) -> Self

Examples found in repository

examples/v1_events_GetEvent.rs (line 8)

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = EventsAPI::with_config(configuration);
    let resp = api.get_event(9223372036854775807).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

examples/v1_events_ListEvents.rs (line 9)

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = EventsAPI::with_config(configuration);
    let resp = api
        .list_events(
            9223372036854775807,
            9223372036854775807,
            ListEventsOptionalParams::default(),
        )
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

examples/v1_events_CreateEvent.rs (line 11)

async fn main() {
    let body = EventCreateRequest::new("A text message.".to_string(), "Example-Event".to_string())
        .tags(vec!["test:ExampleEvent".to_string()]);
    let configuration = datadog::Configuration::new();
    let api = EventsAPI::with_config(configuration);
    let resp = api.create_event(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

examples/v1_events_CreateEvent_19927815.rs (line 14)

async fn main() {
    let body =
        EventCreateRequest::new(
            "A text message.".to_string(),
            "Example-Event very very very looooooooong looooooooooooong loooooooooooooooooooooong looooooooooooooooooooooooooong title with 100+ characters".to_string(),
        ).tags(vec!["test:ExampleEvent".to_string()]);
    let configuration = datadog::Configuration::new();
    let api = EventsAPI::with_config(configuration);
    let resp = api.create_event(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub fn with_client_and_config( config: Configuration, client: ClientWithMiddleware, ) -> Self

pub async fn create_event( &self, body: EventCreateRequest, ) -> Result<EventCreateResponse, Error<CreateEventError>>

This endpoint allows you to post events to the stream. Tag them, set priority and event aggregate them with other events.

Examples found in repository

examples/v1_events_CreateEvent.rs (line 12)

async fn main() {
    let body = EventCreateRequest::new("A text message.".to_string(), "Example-Event".to_string())
        .tags(vec!["test:ExampleEvent".to_string()]);
    let configuration = datadog::Configuration::new();
    let api = EventsAPI::with_config(configuration);
    let resp = api.create_event(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

examples/v1_events_CreateEvent_19927815.rs (line 15)

async fn main() {
    let body =
        EventCreateRequest::new(
            "A text message.".to_string(),
            "Example-Event very very very looooooooong looooooooooooong loooooooooooooooooooooong looooooooooooooooooooooooooong title with 100+ characters".to_string(),
        ).tags(vec!["test:ExampleEvent".to_string()]);
    let configuration = datadog::Configuration::new();
    let api = EventsAPI::with_config(configuration);
    let resp = api.create_event(body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub async fn create_event_with_http_info( &self, body: EventCreateRequest, ) -> Result<ResponseContent<EventCreateResponse>, Error<CreateEventError>>

This endpoint allows you to post events to the stream. Tag them, set priority and event aggregate them with other events.

pub async fn get_event( &self, event_id: i64, ) -> Result<EventResponse, Error<GetEventError>>

This endpoint allows you to query for event details.

Note: If the event you’re querying contains markdown formatting of any kind, you may see characters such as %,\,n in your output.

Examples found in repository

examples/v1_events_GetEvent.rs (line 9)

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = EventsAPI::with_config(configuration);
    let resp = api.get_event(9223372036854775807).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub async fn get_event_with_http_info( &self, event_id: i64, ) -> Result<ResponseContent<EventResponse>, Error<GetEventError>>

This endpoint allows you to query for event details.

Note: If the event you’re querying contains markdown formatting of any kind, you may see characters such as %,\,n in your output.

pub async fn list_events( &self, start: i64, end: i64, params: ListEventsOptionalParams, ) -> Result<EventListResponse, Error<ListEventsError>>

The event stream can be queried and filtered by time, priority, sources and tags.

Notes:

• If the event you’re querying contains markdown formatting of any kind, you may see characters such as %,\,n in your output.

• This endpoint returns a maximum of 1000 most recent results. To return additional results, identify the last timestamp of the last result and set that as the end query time to paginate the results. You can also use the page parameter to specify which set of 1000 results to return.

Examples found in repository

examples/v1_events_ListEvents.rs (lines 11-15)

async fn main() {
    let configuration = datadog::Configuration::new();
    let api = EventsAPI::with_config(configuration);
    let resp = api
        .list_events(
            9223372036854775807,
            9223372036854775807,
            ListEventsOptionalParams::default(),
        )
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub async fn list_events_with_http_info( &self, start: i64, end: i64, params: ListEventsOptionalParams, ) -> Result<ResponseContent<EventListResponse>, Error<ListEventsError>>

The event stream can be queried and filtered by time, priority, sources and tags.

Notes:

• If the event you’re querying contains markdown formatting of any kind, you may see characters such as %,\,n in your output.

• This endpoint returns a maximum of 1000 most recent results. To return additional results, identify the last timestamp of the last result and set that as the end query time to paginate the results. You can also use the page parameter to specify which set of 1000 results to return.

Trait Implementations

impl Clone for EventsAPI

fn clone(&self) -> EventsAPI

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EventsAPI

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for EventsAPI

fn default() -> Self

Returns the “default value” for a type.