Delete an exception

URI - POST

To use this endpoint, send a POST request to delete an existing exception with specific type (excType) and ID: /exceptions/{excType}/delete/{excId}

Request

The request includes the HTTP headers (obtained in the authentication/authorization process and used to sign the request) with request parameters posted on the request body.

Request Headers

Header	Type	Required	Format	Description/Sample
x-av-req-id	String	Yes	UUID – Generated and supplied on the request.	d290f1ee-6c54-4b01-90e6-d701748f085 1
Authorization	Bearer Token	Yes	Bearer <API Access Token>	A string Bearer followed by the API Access Token. See Generating API Access Token. For example, assuming that the API Access Token is 1234, the Bearer Token will be Bearer 1234

Header

Type

Required

Format

Description/Sample

x-av-req-id

String

Yes

UUID – Generated and supplied on the request.

d290f1ee-6c54-4b01-90e6-d701748f085 1

Authorization

Bearer Token

Yes

Bearer <API Access Token>

A string Bearer followed by the API Access Token. See Generating API Access Token.

For example, assuming that the API Access Token is 1234, the Bearer Token will be Bearer 1234

Request String Parameters

Parameter	Type	Required	Format	Description/Sample
excType	String	Yes		Exception type: Whitelist Blocklist
excId	String	Yes		Exception entity ID

Parameter

Type

Required

Format

Description/Sample

excType

String

Yes

Exception type:

Whitelist
Blocklist

excId

String

Yes

Exception entity ID

Request Body

No request body

Request Body Parameters

No request body parameters

Request sample (CURL) format

This request sample shows URI base in USA region. For URI base in other regions, see URLs and URL Base.

Copy

curl -X POST -H "Accept: application/json" \
    -H "x-av-req-id: d290f1ee-6c54-4b01-90e6-d701748f3351" \
    -H "Authorization: Bearer 2462b23346ab0642b65d7d094aca5fb4c29fd96d0468deceae2704d258e81497" \
    https://cloudinfra-gw-us.portal.checkpoint.com/app/hec-api/v1.0/exceptions/whitelist/126802091

This sample deletes the existing whitelist exception rule.

Response

The response obtained from the service includes HTTP response code and JSON formatted structure.

Response Structure

No response data structure

Response Parameters

The response parameters:

Parameter		Type	Description
responseEnvelope		Object	A container of metadata properties
	requestId	String	Request ID (from the request header x-av-req-id value)
	responseCode	Integer	0 = Success Other values = Failure
	responseTest	String	The text value of the response
	additionalText	String	Additional information
	recordsNumber	Integer	Number of records in response
	totalRecordsNumber	Integer	Total number of records
	scrollId	String	Unique ID used for scrolling

Response Sample

A valid response from the service:

Copy

{
    "responseEnvelope":
    {
        "requestId": "d290f1ee-6c54-4b01-90e6",
        "responseCode": 204,
        "responseText": "",
        "additionalText": "", 
        "recordsNumber": 0, 
        "scrollId": ""
    },
    "responseData": []
}