Archive

API Reference

V1

Alerts

Archive an alert

client.V1.Alerts.Archive(ctx, body) (*DataIDV1AlertArchiveResponse, error)

post/v1/alerts/archive

Archive an existing alert

Parameters

bodyIDfieldReleaseUniquenessKeyfieldV1AlertArchiveParams

Hide ParametersShow Parameters

IDfield

param.Field[string]

The Metronome ID of the alert

formatuuid

ReleaseUniquenessKeyfield

optional

param.Field[bool]

If true, resets the uniqueness key on this alert so it can be re-used

Returns

V1AlertArchiveResponsestruct

Hide ParametersShow Parameters

DataIDstringID

HTTPTypeScriptPythonGoRubyTerraform

package main

import (
  "context"
  "fmt"

  "github.com/Metronome-Industries/metronome-go"
  "github.com/Metronome-Industries/metronome-go/option"
)

func main() {
  client := metronome.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  response, err := client.V1.Alerts.Archive(context.TODO(), metronome.V1AlertArchiveParams{
    ID: metronome.F("8deed800-1b7a-495d-a207-6c52bac54dc9"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Data)
}

200 Example

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}