README.md

Alerts

(Alerts)

Overview

Operations related to Alerts

Available Operations

• List - List alerts
• Get - Get an alert
• ListForIncident - List alerts for an incident
• Create - Attach alerts to an incident
• ListProcessingLogs - List alert processing log entries

List

Retrieve all alerts from third parties

Example Usage

package main

import(
	"firehydrant"
	"context"
	"firehydrant/models/operations"
	"log"
)

func main() {
    s := firehydrant.New(
        firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    ctx := context.Background()
    res, err := s.Alerts.List(ctx, operations.ListAlertsRequest{})
    if err != nil {
        log.Fatal(err)
    }
    if res.AlertsAlertEntityPaginated != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.ListAlertsRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.ListAlertsResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
sdkerrors.Unauthorized	401, 403, 407, 511	application/json
sdkerrors.NotFound	404, 501, 505	application/json
sdkerrors.Timeout	408, 504	application/json
sdkerrors.RateLimited	429	application/json
sdkerrors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
sdkerrors.SDKError	4XX, 5XX	*/*

Get

Retrieve a single alert

Example Usage

package main

import(
	"firehydrant"
	"context"
	"log"
)

func main() {
    s := firehydrant.New(
        firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    ctx := context.Background()
    res, err := s.Alerts.Get(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.AlertsAlertEntity != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
alertID	string	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.GetAlertResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
sdkerrors.Unauthorized	401, 403, 407, 511	application/json
sdkerrors.NotFound	404, 501, 505	application/json
sdkerrors.Timeout	408, 504	application/json
sdkerrors.RateLimited	429	application/json
sdkerrors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
sdkerrors.SDKError	4XX, 5XX	*/*

ListForIncident

List alerts that have been attached to an incident

Example Usage

package main

import(
	"firehydrant"
	"context"
	"log"
)

func main() {
    s := firehydrant.New(
        firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    ctx := context.Background()
    res, err := s.Alerts.ListForIncident(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.IncidentsAlertEntityPaginated != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
incidentID	string	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.ListIncidentAlertsResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
sdkerrors.Unauthorized	401, 403, 407, 511	application/json
sdkerrors.NotFound	404, 501, 505	application/json
sdkerrors.Timeout	408, 504	application/json
sdkerrors.RateLimited	429	application/json
sdkerrors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
sdkerrors.SDKError	4XX, 5XX	*/*

Create

Add an alert to an incident. FireHydrant needs to have ingested the alert from a third party system in order to attach it to the incident.

Example Usage

package main

import(
	"firehydrant"
	"context"
	"log"
)

func main() {
    s := firehydrant.New(
        firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    ctx := context.Background()
    res, err := s.Alerts.Create(ctx, "<id>", []string{
        "<value>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
incidentID	string	✔️	N/A
requestBody	[]string	✔️	Array of alert IDs to be assigned to the incident
opts	[]operations.Option	➖	The options for this request.

Response

*operations.CreateIncidentAlertsResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
sdkerrors.Unauthorized	401, 403, 407, 511	application/json
sdkerrors.NotFound	404, 501, 505	application/json
sdkerrors.Timeout	408, 504	application/json
sdkerrors.RateLimited	429	application/json
sdkerrors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
sdkerrors.SDKError	4XX, 5XX	*/*

ListProcessingLogs

Processing Log Entries for a specific alert

Example Usage

package main

import(
	"firehydrant"
	"context"
	"firehydrant/models/operations"
	"log"
)

func main() {
    s := firehydrant.New(
        firehydrant.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    ctx := context.Background()
    res, err := s.Alerts.ListProcessingLogs(ctx, operations.ListAlertProcessingLogsRequest{})
    if err != nil {
        log.Fatal(err)
    }
    if res.AlertsProcessingLogEntryEntityPaginated != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.ListAlertProcessingLogsRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.ListAlertProcessingLogsResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
sdkerrors.Unauthorized	401, 403, 407, 511	application/json
sdkerrors.NotFound	404, 501, 505	application/json
sdkerrors.Timeout	408, 504	application/json
sdkerrors.RateLimited	429	application/json
sdkerrors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
sdkerrors.SDKError	4XX, 5XX	*/*