{"note":"OpenAPI conversion -- returning structured metadata","name":"circl-lu-hashlookup","description":"hashlookup CIRCL API","version":"1.3","base_url":"","endpoints":11,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api hashlookup CIRCL API\n@version 1.3\n@endpoints 11\n@toc bulk(2), children(1), info(1), lookup(3), parents(1), session(2), stats(1)\n\n@group bulk\n@endpoint POST /bulk/md5\n@desc Bulk search of MD5 hashes in a JSON array with the key 'hashes'.\n@returns(200) Success\n@errors {404: JSON format incorrect. An array of hashes in the key 'hashes' is expected.}\n\n@endpoint POST /bulk/sha1\n@desc Bulk search of SHA1 hashes in a JSON array with the 'hashes'.\n@returns(200) Success\n@errors {404: JSON format incorrect. An array of hashes in the key 'hashes' is expected.}\n\n@endgroup\n\n@group children\n@endpoint GET /children/{sha1}/{count}/{cursor}\n@desc Return children from a given SHA1.  A number of element to return and an offset must be given. If not set it will be the 100 first elements. A cursor must be given to paginate over. The starting cursor is 0.\n@returns(200) Success\n@errors {400: SHA1 value incorrect, expecting a SHA1 value in hex format, 404: The SHA1 value has no known child.}\n\n@endgroup\n\n@group info\n@endpoint GET /info\n@desc Info about the hashlookup database\n@returns(200) Success\n\n@endgroup\n\n@group lookup\n@endpoint GET /lookup/md5/{md5}\n@desc Lookup MD5.\n@returns(200) Success\n@errors {400: MD5 value incorrect, expecting a MD5 value in hex format, 404: Non existing MD5}\n\n@endpoint GET /lookup/sha1/{sha1}\n@desc Lookup SHA-1.\n@returns(200) Success\n@errors {400: SHA1 value incorrect, expecting a SHA1 value in hex format, 404: Non existing SHA1}\n\n@endpoint GET /lookup/sha256/{sha256}\n@desc Lookup SHA-256.\n@returns(200) Success\n@errors {400: SHA-256 value incorrect, expecting a SHA-256 value in hex format, 404: Non existing SHA-256}\n\n@endgroup\n\n@group parents\n@endpoint GET /parents/{sha1}/{count}/{cursor}\n@desc Return parents from a given SHA1. A number of element to return and an offset must be given. If not set it will be the 100 first elements. A cursor must be given to paginate over. The starting cursor is 0.\n@returns(200) Success\n@errors {400: SHA1 value incorrect, expecting a SHA1 value in hex format, 404: The SHA1 value has no known parent.}\n\n@endgroup\n\n@group session\n@endpoint GET /session/create/{name}\n@desc Create a session key to keep search context. The session is attached to a name. After the session is created, the header `hashlookup_session` can be set to the session name.\n@returns(200) Success\n@errors {400: Expecting a name for the session, 500: Session feature is not enabled}\n\n@endpoint GET /session/get/{name}\n@desc Return set of matching and non-matching hashes from a session.\n@returns(200) Success\n@errors {400: Expecting a name for the session, 500: Session feature is not enabled}\n\n@endgroup\n\n@group stats\n@endpoint GET /stats/top\n@desc Return the top 100 of most queried values.\n@returns(200) Success\n@errors {400: Public statistics not enabled}\n\n@endgroup\n\n@end\n"}