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

Unique identifier for the event.

 

responseCode

Integer

Status code HTTP API code response.

 

responseTest

String

Human-readable message about the response status.

 

additionalText

String

Additional information.

 

recordsNumber

Integer

Number of records found.

 

totalRecordsNumber

Integer

Total number of records

 

scrollId

String

Pagination id to get next batch of records.

responseData

Object

Array of exception entities.

 

entityId

String

Unique identifier for the entity.

 

attachmentMd5

String

MD5 hash of the attachment, if present.

 

senderEmail

String

Email address of the sender.

 

senderName

String

Display name of the sender.

 

recipient

String

Recipient's email address.

 

senderClientIp

String

IP address of the sender's client.

 

senderDomain

String

Domain of the sender's email address.

 

senderIp

String

IP address of the sender.

 

linkDomains

String

Comma-separated list of domains found in email links.

 

subject

String

Subject line of the email.

 

comment

String

Comment added by the creator of the exception.

 

actionNeeded

String

Any action that needs to be taken.

 

ignoringSpfCheck

Boolean

Indicates if SPF check was ignored.

 

subjectMatching

String

Information about subject matching criteria.

 

linkDomainMatching

String

Information about matching of link domains.

 

senderNameMatching

String

Information about sender name matching.

 

senderDomainMatchi ng

String

Information about sender domain matching.

 

senderEmailMatching

String

Information about sender email matching.

 

recipientMatching

String

Information about recipient matching.

 

addedBy

String

User who added this entry.

 

editedBy

String

User who last edited this entry.

 

updateTime

String

Timestamp of the last update.

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"
    }
    ]
}