Add domain list entry

POST 
/domains/:domain/lists/:listname

Add an entry to a domain blocklist or safelist.

Request

Path Parameters

domain hostnamerequired

The domain name.

listname stringrequired

Possible values: [blocklist, safelist, blacklist, whitelist]

The name of the list to add an entry to. One of 'safelist' or 'blocklist'. 'whitelist' and 'blacklist' are deprecated

application/json

Body

required

itemstringrequired

The value of the entry. The type of the entry is automatically determined based on the value.

Responses

201

Successfully created the entry.

application/json

Schema

Schema

itemstring

The value of this entry. The meaning of this value depends on the item_type.

item_typestring

The item type.

actionstring

Which list this entry is on, e.g. safelist or blocklist.

Example (from schema)

{
  "item": "string",
  "item_type": "string",
  "action": "string"
}

400

Bad Request, returned in the case that an error occurs while converting an A-label domain to a U-label domain name, or that the list item is not a valid ip address, email address or domain.

application/json

Schema

Schema

codeinteger
messagestring
errorsstring[]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    "string"
  ]
}

403

Returned in the case that the domain is associated with an api key that is different than the one in the request, the domain is associated with a different customer, or the domain in the request is an alias domain.

application/json

Schema

Schema

codeinteger
messagestring
errorsstring[]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    "string"
  ]
}

404

The domain does not exist.

application/json

Schema

Schema

codeinteger
messagestring
errorsstring[]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    "string"
  ]
}

500

Internal Server Error

application/json

Schema

Schema

codeinteger
messagestring
errorsstring[]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    "string"
  ]
}