blocky API

Base URL: /api/, Version:

blocky API

Schemes:

Summary

Tag: blocking

Operation Description
GET /blocking/disable

Disable blocking

GET /blocking/enable

Enable blocking

GET /blocking/status

Blocking status

Tag: lists

Operation Description
POST /lists/refresh

List refresh

Tag: query

Operation Description
POST /query

Performs DNS query

Paths

Disable blocking

GET /blocking/disable

Tags: blocking

disable the blocking status

duration

duration of blocking (Example: 300s, 5m, 1h, 5m30s)

query string (duration)
groups

groups to disable (comma separated). If empty, disable all groups

query string (string)
200 OK

Blocking is disabled

400 Bad Request

Unknown group

Enable blocking

GET /blocking/enable

Tags: blocking

enable the blocking status

200 OK

Blocking is enabled

Blocking status

GET /blocking/status

Tags: blocking

get current blocking status

application/json

200 OK

Returns current blocking status

List refresh

POST /lists/refresh

Tags: lists

Refresh all lists

200 OK

Lists were reloaded

Performs DNS query

POST /query

Tags: query

Performs DNS query

application/json

query data

application/json

200 OK

query was executed

400 Bad Request

Wrong request format

Schema definitions

api.BlockingStatus: object

autoEnableInSec: integer

If blocking is temporary disabled: amount of seconds until blocking will be enabled

disabledGroups: string[]

Disabled group names

string
enabled: boolean

True if blocking is enabled

api.QueryRequest: object

query: string

query for DNS request

type: string

request type (A, AAAA, ...)

api.QueryResult: object

reason: string

blocky reason for resolution

response: string

actual DNS response

responseType: string

response type (CACHED, BLOCKED, ...)

returnCode: string

DNS return code (NOERROR, NXDOMAIN, ...)