@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api hashlookup CIRCL API
@version 1.3
@endpoints 11
@toc bulk(2), children(1), info(1), lookup(3), parents(1), session(2), stats(1)

@group bulk
@endpoint POST /bulk/md5
@returns(200)
@errors {404}

@endpoint POST /bulk/sha1
@returns(200)
@errors {404}

@endgroup

@group children
@endpoint GET /children/{sha1}/{count}/{cursor}
@returns(200)
@errors {400, 404}

@endgroup

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

@endgroup

@group lookup
@endpoint GET /lookup/md5/{md5}
@returns(200)
@errors {400, 404}

@endpoint GET /lookup/sha1/{sha1}
@returns(200)
@errors {400, 404}

@endpoint GET /lookup/sha256/{sha256}
@returns(200)
@errors {400, 404}

@endgroup

@group parents
@endpoint GET /parents/{sha1}/{count}/{cursor}
@returns(200)
@errors {400, 404}

@endgroup

@group session
@endpoint GET /session/create/{name}
@returns(200)
@errors {400, 500}

@endpoint GET /session/get/{name}
@returns(200)
@errors {400, 500}

@endgroup

@group stats
@endpoint GET /stats/top
@returns(200)
@errors {400}

@endgroup

@end