Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetBlacklistReports

Retrieve a list of the blacklists that your dedicated IP addresses appear on.

Request Syntax


GET /v1/email/deliverability-dashboard/blacklist-report?BlacklistItemNames=BlacklistItemNames HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

BlacklistItemNames

A list of IP addresses that you want to retrieve blacklist information about. You can only specify the dedicated IP addresses that you use to send email using Amazon Pinpoint or Amazon SES.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "BlacklistReport": { 
      "string" : [ 
         { 
            "Description": "string",
            "ListingTime": number,
            "RblName": "string"
         }
      ]
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

BlacklistReport

An object that contains information about a blacklist that one of your dedicated IP addresses appears on.

Type: String to array of BlacklistEntry objects map

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429