Archive

API Reference

V1

Alerts

Archive an alert

client.v1.alerts.archive(AlertArchiveParamsbody, RequestOptionsoptions?): dataIDAlertArchiveResponse

post/v1/alerts/archive

Archive an existing alert

Parameters

bodyidstringrelease_uniqueness_keybooleanAlertArchiveParams

Hide ParametersShow Parameters

idstring

The Metronome ID of the alert

formatuuid

release_uniqueness_keyboolean

optional

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

Returns

AlertArchiveResponse

Hide ParametersShow Parameters

dataidstringID

HTTPTypeScriptPythonGoRubyTerraform

import Metronome from '@metronome/sdk';

const client = new Metronome({
  bearerToken: 'My Bearer Token',
});

const response = await client.v1.alerts.archive({ id: '8deed800-1b7a-495d-a207-6c52bac54dc9' });

console.log(response.data);

200 Example

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