# Silences ## List Silences `alerting.silences.list(SilenceListParams**kwargs) -> SyncSinglePage[SilenceListResponse]` **get** `/accounts/{account_id}/alerting/v3/silences` Gets a list of silences for an account. ### Parameters - `account_id: str` The account id ### Returns - `class SilenceListResponse: …` - `id: Optional[str]` Silence ID - `created_at: Optional[str]` When the silence was created. - `end_time: Optional[str]` When the silence ends. - `policy_id: Optional[str]` The unique identifier of a notification policy - `start_time: Optional[str]` When the silence starts. - `updated_at: Optional[str]` When the silence was modified. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) page = client.alerting.silences.list( account_id="023e105f4ecef8ad9ca31a8372d0c353", ) page = page.result[0] print(page.id) ``` #### Response ```json { "errors": [ { "message": "message", "code": 1000 } ], "messages": [ { "message": "message", "code": 1000 } ], "success": true, "result": [ { "id": "f878e90c23f44126ae3cfc399f646977", "created_at": "2022-01-01T00:00:00Z", "end_time": "2022-01-01T00:00:00Z", "policy_id": "0da2b59ef118439d8097bdfb215203c9", "start_time": "2022-01-01T00:00:00Z", "updated_at": "2022-01-01T00:00:00Z" } ] } ``` ## Get Silence `alerting.silences.get(strsilence_id, SilenceGetParams**kwargs) -> SilenceGetResponse` **get** `/accounts/{account_id}/alerting/v3/silences/{silence_id}` Gets a specific silence for an account. ### Parameters - `account_id: str` The account id - `silence_id: str` Silence ID ### Returns - `class SilenceGetResponse: …` - `id: Optional[str]` Silence ID - `created_at: Optional[str]` When the silence was created. - `end_time: Optional[str]` When the silence ends. - `policy_id: Optional[str]` The unique identifier of a notification policy - `start_time: Optional[str]` When the silence starts. - `updated_at: Optional[str]` When the silence was modified. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) silence = client.alerting.silences.get( silence_id="f878e90c23f44126ae3cfc399f646977", account_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(silence.id) ``` #### Response ```json { "errors": [ { "message": "message", "code": 1000 } ], "messages": [ { "message": "message", "code": 1000 } ], "success": true, "result": { "id": "f878e90c23f44126ae3cfc399f646977", "created_at": "2022-01-01T00:00:00Z", "end_time": "2022-01-01T00:00:00Z", "policy_id": "0da2b59ef118439d8097bdfb215203c9", "start_time": "2022-01-01T00:00:00Z", "updated_at": "2022-01-01T00:00:00Z" } } ``` ## Create Silences `alerting.silences.create(SilenceCreateParams**kwargs) -> SilenceCreateResponse` **post** `/accounts/{account_id}/alerting/v3/silences` Creates a new silence for an account. ### Parameters - `account_id: str` The account id - `body: Iterable[Body]` - `end_time: Optional[str]` When the silence ends. - `policy_id: Optional[str]` The unique identifier of a notification policy - `start_time: Optional[str]` When the silence starts. ### Returns - `class SilenceCreateResponse: …` - `errors: List[Error]` - `message: str` - `code: Optional[int]` - `messages: List[Message]` - `message: str` - `code: Optional[int]` - `success: Literal[true]` Whether the API call was successful - `true` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) silence = client.alerting.silences.create( account_id="023e105f4ecef8ad9ca31a8372d0c353", body=[{}], ) print(silence.errors) ``` #### Response ```json { "errors": [ { "message": "message", "code": 1000 } ], "messages": [ { "message": "message", "code": 1000 } ], "success": true } ``` ## Update Silences `alerting.silences.update(SilenceUpdateParams**kwargs) -> SyncSinglePage[SilenceUpdateResponse]` **put** `/accounts/{account_id}/alerting/v3/silences` Updates existing silences for an account. ### Parameters - `account_id: str` The account id - `body: Iterable[Body]` - `id: Optional[str]` Silence ID - `end_time: Optional[str]` When the silence ends. - `start_time: Optional[str]` When the silence starts. ### Returns - `class SilenceUpdateResponse: …` - `id: Optional[str]` Silence ID - `created_at: Optional[str]` When the silence was created. - `end_time: Optional[str]` When the silence ends. - `policy_id: Optional[str]` The unique identifier of a notification policy - `start_time: Optional[str]` When the silence starts. - `updated_at: Optional[str]` When the silence was modified. ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) page = client.alerting.silences.update( account_id="023e105f4ecef8ad9ca31a8372d0c353", body=[{}], ) page = page.result[0] print(page.id) ``` #### Response ```json { "errors": [ { "message": "message", "code": 1000 } ], "messages": [ { "message": "message", "code": 1000 } ], "success": true, "result": [ { "id": "f878e90c23f44126ae3cfc399f646977", "created_at": "2022-01-01T00:00:00Z", "end_time": "2022-01-01T00:00:00Z", "policy_id": "0da2b59ef118439d8097bdfb215203c9", "start_time": "2022-01-01T00:00:00Z", "updated_at": "2022-01-01T00:00:00Z" } ] } ``` ## Delete Silence `alerting.silences.delete(strsilence_id, SilenceDeleteParams**kwargs) -> SilenceDeleteResponse` **delete** `/accounts/{account_id}/alerting/v3/silences/{silence_id}` Deletes an existing silence for an account. ### Parameters - `account_id: str` The account id - `silence_id: str` Silence ID ### Returns - `class SilenceDeleteResponse: …` - `errors: List[Error]` - `message: str` - `code: Optional[int]` - `messages: List[Message]` - `message: str` - `code: Optional[int]` - `success: Literal[true]` Whether the API call was successful - `true` ### Example ```python import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) silence = client.alerting.silences.delete( silence_id="f878e90c23f44126ae3cfc399f646977", account_id="023e105f4ecef8ad9ca31a8372d0c353", ) print(silence.errors) ``` #### Response ```json { "errors": [ { "message": "message", "code": 1000 } ], "messages": [ { "message": "message", "code": 1000 } ], "success": true } ``` ## Domain Types ### Silence List Response - `class SilenceListResponse: …` - `id: Optional[str]` Silence ID - `created_at: Optional[str]` When the silence was created. - `end_time: Optional[str]` When the silence ends. - `policy_id: Optional[str]` The unique identifier of a notification policy - `start_time: Optional[str]` When the silence starts. - `updated_at: Optional[str]` When the silence was modified. ### Silence Get Response - `class SilenceGetResponse: …` - `id: Optional[str]` Silence ID - `created_at: Optional[str]` When the silence was created. - `end_time: Optional[str]` When the silence ends. - `policy_id: Optional[str]` The unique identifier of a notification policy - `start_time: Optional[str]` When the silence starts. - `updated_at: Optional[str]` When the silence was modified. ### Silence Create Response - `class SilenceCreateResponse: …` - `errors: List[Error]` - `message: str` - `code: Optional[int]` - `messages: List[Message]` - `message: str` - `code: Optional[int]` - `success: Literal[true]` Whether the API call was successful - `true` ### Silence Update Response - `class SilenceUpdateResponse: …` - `id: Optional[str]` Silence ID - `created_at: Optional[str]` When the silence was created. - `end_time: Optional[str]` When the silence ends. - `policy_id: Optional[str]` The unique identifier of a notification policy - `start_time: Optional[str]` When the silence starts. - `updated_at: Optional[str]` When the silence was modified. ### Silence Delete Response - `class SilenceDeleteResponse: …` - `errors: List[Error]` - `message: str` - `code: Optional[int]` - `messages: List[Message]` - `message: str` - `code: Optional[int]` - `success: Literal[true]` Whether the API call was successful - `true`