Managing Exceptions

Get all existing exceptions

URI - GET

To use this endpoint, send a GET request to get the exceptions list: /exceptions/{excType}

Request

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

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

x-av-token

String

Yes

Token

Token obtained in the authentication sequence.

tkn8546ffffggd9d8934593

x-av-app-id

String

Yes

Avanan Application ID

US:myapp29

x-av-date

String

Yes

Date-time in GMT

'2021-04-10T00:00:00.000Z'

x-av-sig

String

Yes

Calculated signature

tkn8jmveolrrtertr9d8934593

For more details, see Managing Exceptions.

Request String Parameters

Parameter

Type

Required

Format

Description/Sample

excType

String

Yes

 

Exception type:

  • Whitelist

  • Blacklist
Query String

Query

Type

Required

Format

Description/Sample

scope

String

No

 

Single scope string

Request Body

Not applicable for GET method.

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 GET -H "Accept: application/json" \
    -H “"-av-req-id: d290f1ee-6c54-4b01-90e6-d701748f0851" \
    -H "x-av-token: tkn8546ffffggd9d8934593" \
    -H "x-av-app-id: myapp29" \
    -H "x-av-date: 2016-08-29T09:12:33.001Z" \
    -H "x-av-sig: tkn8jmveolrrtertr9d8934593" \
    https://smart-api-production-1-us.avanan.net/v1.0/exceptions/whitelist

Response

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

Response Structure

A valid response obtained from the service (JSON format):

Copy 
[{
    "entityId": "string",
    "attachmentMd5": "string",
    "senderEmail": "string", 
    "senderName": "string", 
    "recipient": "string", 
    "senderClientIp": "string", 
    "senderDomain": "string", 
    "senderIp": "string", 
    "linkDomains": "string",
    "subject": "string",
    "comment": "string", 
    "actionNeeded": "string",
    "matchOnlyFuture": "string",
    "quarantineAll": "string", 
    "ignoringSpfCheck": "boolean", 
    "subjectMatching": "string", 
    "linkDomainMatching": "string",
    "senderNameMatching": "string",
    "senderDomainMatching": "string",
    "senderEmailMatching": "string",
    "recipientMatching": "string", 
    "addedBy": "integer",
    "editedBy": "integer", 
    "updateTime": "string"
}]

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

responseData

Object

Array of exception entities

 

entityId

String

Entity ID

 

attachmentMd5

String

Attachment MD5 hash

 

senderEmail

String

Sender's email

 

senderName

String

Sender's name

 

recipient

String

Recipient

 

senderClientIp

String

Sender client IP

 

senderDomain

String

Sender domain

 

senderIp

String

Sender IP

 

linkDomains

String

Link to domains

 

subject

String

Subject

 

comment

String

Exception comment

 

actionNeeded

String

Detection type that would be generated by the rule:

  • spam

  • phishing

Note - This parameter applies only to Blacklist.

 

subjectMatching

String

Subject matching type:

  • contains

  • match

 

linkDomainMatching

String

Link to domains matching type:

  • contains

  • match

 

senderNameMatching

String

Sender name matching type:

  • contains

  • match

 

senderDomainMatching

String

Sender domain matching type:

  • endswith

  • match

 

recipientMatching

String

Recipient matching type:

  • contains

  • match

Response Sample

A valid response from the service:

Copy 
{
    "responseEnvelope": 
    {
        "requestId": "07070caa-b73a-4125-820d-8509d83e004e", 
        "responseCode": 200,
        "responseText": "",
        "additionalText": "", 
        "recordsNumber": 1, 
        "scrollId": ""
    },
    "responseData": [
    {
        "entityId": "121775995", 
        "attachmentMd5": null,
        "senderEmail": "user@email.com", 
        "senderName": null,
        "recipient": null,
        "senderClientIp": null,
        "senderDomain": null,
        "senderIp": null, 
        "linkDomains": null,
        "subject": "AUT-phish-prod3-17-_200923_23_11_3",
        "comment": "",
        "actionNeeded": "", 
        "matchOnlyFuture": "",
        "quarantineAll": null, 
        "ignoringSpfCheck": false,
        "subjectMatching": "contains", 
        "linkDomainMatching": null,
        "senderNameMatching": "", 
        "senderDomainMatching": "", 
        "senderEmailMatching": "",
        "recipientMatching": "", 
        "addedBy": "5",
        "editedBy": null,
        "updateTime": "2020-09-25T21:54:17.706787"
    }
    ]
}