Exceptions (Intrusion Prevention)

Updates the specified IPS signature exception.

put/v1/configuration/{accountid}/exceptions/ips/{objectid}

Request

Base URL
https://api.usa.cloud.watchguard.com/rest/firecloud/management
Auth
API key in header WatchGuard-API-Key and HTTP bearer
TypeScript
https://skmtc.dev/watchguard/apis/firecloud-management-api/docs/v1/configuration/:accountid/exceptions/ips/:objectid/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

objectidstring required

ID of the IPS signature exception to update in your FireCloud account .

Request body

idstring required

Unique ID that identifies this object.

objectstring required

Type of object.

versioninteger required

Version number of the object.

accountstring required

Your WatchGuard Cloud account ID.

createdinteger required

Time that the object was created, specified in Unix epoch time format.

device'firewan' required

Device this object applies to.

authorstring required

Author of the object. This is always empty for objects added or updated with the FireCloud Management API.

action'allow' | 'block' required

Specifies the action to take for the specified signature, either allow or block.

alarmboolean

Specifies whether the FireCloud sends an alarm for the IPS exception.

descriptionstring

Specifies the description of the IPS signature exception. Maximum: 127 characters.

signature_idstring required

Specifies the IPS signature ID. Must contain only numbers. Maximum: 31 characters.

Example request

{
  "version": 1,
  "account": "WGC-1-123abc456",
  "created": 1579907960,
  "device": "firewan",
  "alarm": true,
  "description": "Block signature 1055124"
}

Response

The updated IPS signature exception object.