@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Domains-Index API
@version 1.0
@auth ApiKey api_key in query
@endpoints 14
@toc domains(9), info(5)

@group domains
@endpoint GET /domains/search
@optional {api_key: any, date: any, page: any, limit: any, domain: any, zone: any, country: any, isDead: any, A: any, NS: any, CNAME: any, MX: any, TXT: any}
@returns(200)
@errors {403, 404}

@endpoint GET /domains/tld/{zone_id}
@optional {api_key: any, date: any, page: any, limit: any, domain: any, country: any, isDead: any, A: any, NS: any, CNAME: any, MX: any, TXT: any}
@returns(200)
@errors {403, 404}

@endpoint GET /domains/tld/{zone_id}/download
@optional {api_key: any, date: any}
@errors {403, 404}

@endpoint GET /domains/tld/{zone_id}/search
@optional {api_key: any, date: any, page: any, limit: any, domain: any, country: any, isDead: any, A: any, NS: any, CNAME: any, MX: any, TXT: any}
@returns(200)
@errors {403, 404}

@endpoint GET /domains/updates/added
@optional {api_key: any, date: any, page: any, limit: any}
@returns(200)
@errors {403, 404}

@endpoint GET /domains/updates/added/download
@optional {api_key: any, date: any}
@errors {403, 404}

@endpoint GET /domains/updates/deleted
@optional {api_key: any, date: any, page: any, limit: any}
@returns(200)
@errors {403, 404}

@endpoint GET /domains/updates/deleted/download
@optional {api_key: any, date: any}
@errors {403, 404}

@endpoint GET /domains/updates/list
@optional {api_key: any}
@returns(200)
@errors {403, 404}

@endgroup

@group info
@endpoint GET /info/api
@optional {api_key: any}
@returns(200)

@endpoint GET /info/stat/
@optional {page: any, limit: any}
@returns(200)

@endpoint GET /info/stat/{zone}
@optional {page: any, limit: any}
@returns(200)
@errors {404}

@endpoint GET /info/tld/
@returns(200)

@endpoint GET /info/tld/{zone}
@optional {page: any, limit: any}
@returns(200)
@errors {404}

@endgroup

@end