Privacy Exclusions API

MaxMind maintains a list of Do Not Sell My Personal Information requests. This API provides a simple way to retrieve privacy exclusion requests in an automated fashion.

Request

Request URI

API calls should be made with HTTP GET request to: https://api.maxmind.com/privacy/exclusions

Authorization/Security

We use basic HTTP authentication. The HTTP Authorization header is required for authorization. The username is your MaxMind account ID. The password is your MaxMind license key. The authorization realm is privacy-exclusion.

The API is only available via HTTPS. The credentials are never transmitted unencrypted. If you attempt to access this service via HTTP, you will receive a 403 Forbidden HTTP response.

We require TLS 1.2 or greater for all requests to our servers to keep your data secure.

Request Parameters

The query string may include the following parameter:

Example Request URL

https://api.maxmind.com/privacy/exclusions?updates_after=2020-04-12T23:20:50.52Z

Response

Response Headers

The Content-Type header will vary based on whether the request was successful or not, and is detailed further in each of the two Response Body sections below.

The response will always include a Content-Length header.

Response Body (for successful requests)

Example

 1{
 2    "exclusions": [
 3        {
 4            "exclusion_type": "ccpa_do_not_sell",
 5            "data_type": "network",
 6            "value": "10.0.26.166/32",
 7            "last_updated":"2020-01-08T18:58:38Z"
 8        },
 9        ...
10    ]
11}

Description

The Content-Type header for a successful response will be application/vnd.maxmind.com-privacy-exclusions+json; charset=UTF-8; version=1.0

Data will be returned as a JSON document in UTF-8 encoding. The document will be a JSON object including the exclusions key. Additional keys may be added in the future.

The value for the exclusions key is an array of objects, each representing one exclusion request.

Each exclusion object in the exclusions array includes the following keys:

Please note that additional keys may be added in the future.

Response Body (for unsuccessful requests)

In the event an error occurs (the response indicates a 4xx or 5xx HTTP status), the response may include a JSON document in the body. An error in content negotiation will not include a body nor will many 5xx errors. Before attempting to decode the body as JSON, you should verify that the Content-Type of the error response is application/vnd.maxmind.com-error+json; charset=UTF-8; version=1.0.

If the JSON document is included in the response body, it will be an object with the keys code and error. The code field is a static error code for machine use. The value of any given code will never change, but codes can be added or removed. The error field is a human-readable description of the error and may change at any time.

In addition to the errors documented below, client code should also be prepared to handle any valid HTTP 4xx or 5xx status code.

Example Response (for an unsuccessful request)

1{
2    "code": "ACCOUNT_ID_REQUIRED",
3    "error": "You have not supplied a MaxMind account ID in the Authorization header"
4}