Blocklists
List blocklist entries
List suppressed addresses for a list
get/v1/blocklist/{listId}
Request
- Base URL: https://your-emailengine-host
- URL: https://your-emailengine-host/v1/blocklist/{listId}
- Auth: HTTP bearer
Path parameters
listIdstring required
List ID. Must use a subdomain name format. Lists are registered ad-hoc, so a new identifier defines a new list.
Example:test-list
Query parameters
pageinteger
Page number (zero indexed, so use 0 for first page)
pageSizeinteger
How many entries per page
Example:20
Headers
x-ee-timeoutinteger
Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect
Example:30000
Response
Returns a page of entries on the blocklist.
Example response
{
"listId": "example",
"total": 120,
"pages": 24,
"addresses": [
{
"recipient": "user@example.com",
"account": "user123",
"messageId": "<test123@example.com>",
"source": "api",
"reason": "block",
"remoteAddress": "198.51.100.24",
"userAgent": "Mozilla/5.0 (Macintosh)",
"created": "2021-02-17T13:43:18.860Z"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.