lists

Add an entry to the block list

Adds a URL, host, domain or IP to the block list. A blocked URL, host, domain or IP is always returned as malicious (BLOCK_LIST_MATCH). Adding an entry that already exists returns the existing entry. Requires a key with the admin scope. Available on every plan. Takes effect within about a minute.

post/v1/block-list

Request

  • Base URL: https://api.skanqrcode.com
  • URL: https://api.skanqrcode.com/v1/block-list
  • Auth: HTTP bearer

Request body

matchType'url' | 'host' | 'domain' | 'ip' required

What the entry matches: an exact URL, a hostname, a registrable domain (including its subdomains), or an IP address.

valuestring required

Example request

{
  "value": "malicious-example.com"
}

Response

The entry already existed.

idstring required
matchType'url' | 'host' | 'domain' | 'ip' required

What the entry matches: an exact URL, a hostname, a registrable domain (including its subdomains), or an IP address.

valuestring required

The host, domain or IP as entered. For URL entries only the registrable domain and a short hash hint are shown.

createdAtstring required

RFC 3339, UTC.

Changes

No recorded changes to this operation across all 1 revision of this API.