API Reference

Alerting

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Silences

List Silences

client.alerting.silences.list(SilenceListParams { account_id } params, RequestOptionsoptions?): SinglePage<SilenceListResponse { id, created_at, end_time, 3 more } >

GET/accounts/{account_id}/alerting/v3/silences

Get Silence

client.alerting.silences.get(stringsilenceId, SilenceGetParams { account_id } params, RequestOptionsoptions?): SilenceGetResponse { id, created_at, end_time, 3 more }

GET/accounts/{account_id}/alerting/v3/silences/{silence_id}

Create Silences

client.alerting.silences.create(SilenceCreateParams { account_id, body } params, RequestOptionsoptions?): SilenceCreateResponse { errors, messages, success }

POST/accounts/{account_id}/alerting/v3/silences

Update Silences

client.alerting.silences.update(SilenceUpdateParams { account_id, body } params, RequestOptionsoptions?): SinglePage<SilenceUpdateResponse { id, created_at, end_time, 3 more } >

PUT/accounts/{account_id}/alerting/v3/silences

Delete Silence

client.alerting.silences.delete(stringsilenceId, SilenceDeleteParams { account_id } params, RequestOptionsoptions?): SilenceDeleteResponse { errors, messages, success }

DELETE/accounts/{account_id}/alerting/v3/silences/{silence_id}

ModelsExpand Collapse

SilenceListResponse { id, created_at, end_time, 3 more }

id?: string

Silence ID

maxLength32

created_at?: string

When the silence was created.

end_time?: string

When the silence ends.

policy_id?: string

The unique identifier of a notification policy

maxLength32

start_time?: string

When the silence starts.

updated_at?: string

When the silence was modified.

SilenceGetResponse { id, created_at, end_time, 3 more }

id?: string

Silence ID

maxLength32

created_at?: string

When the silence was created.

end_time?: string

When the silence ends.

policy_id?: string

The unique identifier of a notification policy

maxLength32

start_time?: string

When the silence starts.

updated_at?: string

When the silence was modified.

SilenceCreateResponse { errors, messages, success }

errors: Array<Error>

message: string

code?: number

minimum1000

messages: Array<Message>

message: string

code?: number

minimum1000

success: true

Whether the API call was successful

SilenceUpdateResponse { id, created_at, end_time, 3 more }

id?: string

Silence ID

maxLength32

created_at?: string

When the silence was created.

end_time?: string

When the silence ends.

policy_id?: string

The unique identifier of a notification policy

maxLength32

start_time?: string

When the silence starts.

updated_at?: string

When the silence was modified.

SilenceDeleteResponse { errors, messages, success }

errors: Array<Error>

message: string

code?: number

minimum1000

messages: Array<Message>

message: string

code?: number

minimum1000

success: true

Whether the API call was successful