Get domain list entries

GET 
/domains/:domain/lists/:listname

Get all of the blocklist or safelist entries for a domain.

Request

Path Parameters

domain hostnamerequired

The domain name to be removed.

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

Responses

200

Successfully retrieved the items

application/json

Schema

Schema

• Array [

item string

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

item_type string

The item type.

action string

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.

application/json

Schema

Schema

code integer
message string
errors string[]

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

code integer
message string
errors string[]

Example (from schema)

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

404

This domain does not exist.

application/json

Schema

Schema

code integer
message string
errors string[]

Example (from schema)

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

500

Internal Server Error

application/json

Schema

Schema

code integer
message string
errors string[]

Example (from schema)

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

Loading...