openapi.json

{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/":{"get":{"summary":"The default route for the application.","description":"This is the default route for the application. It will display links to resources for the application/API, such\nas the Swagger UI, OpenAPI Spec, and GitHub repository along with a short description. It uses MVP.css for styling.","operationId":"default_route__get","responses":{"200":{"description":"Successful Response","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/search_ip/":{"get":{"summary":"Search for an IP address.","description":"Search for an IP address in a set of known TOR IP addresses. This function will take in an IP address in it's human readable format\nand return a JSON response as to wether or not it is in the IPv4 or IPv6 set.\n\nPlease use the following format for the IP address:\n- IPv4:\n    - 10.10.10.10\n\n- IPv6:\n    - 2001:0db8:85a3:0000:0000:8a2e:0370:7334","operationId":"search_ip_search_ip__get","parameters":[{"name":"ip","in":"query","required":true,"schema":{"type":"string","title":"Ip"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/remove_ip/":{"delete":{"summary":"Remove an IP address from the set.","description":"Remove an IP address from the set of known TOR IP addresses. This function will take in an IP address in it's human readable format.\nThis will also ensure that when the dataset updates every 24 hours, the IP address will not be added back in. Note that this will only\npersist as the machine is running as all sets are stored in volatile memory, a database or similar could be used to persist this data.\n\nPlease use the following format for the IP address:\n- IPv4:\n    - 10.10.10.10\n\n- IPv6:\n    - 2001:0db8:85a3:0000:0000:8a2e:0370:7334","operationId":"remove_ip_remove_ip__delete","parameters":[{"name":"ip","in":"query","required":true,"schema":{"type":"string","title":"Ip"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/refresh_ips/":{"get":{"summary":"Manually refresh the IP addresses in the dataset.","description":"Manually refresh the IP addresses in the dataset. This function will manually refresh the IP addresses in the dataset and return how many\nnew IPv4 and IPv6 addresses were added to the set as JSON.","operationId":"refresh_ips_refresh_ips__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/list_removed_ips/":{"get":{"summary":"List the IPv4 and IPv6 addresses that have been removed from the dataset.","description":"List the IPv4 and IPv6 addresses that have been removed from the dataset.\nThis function will return a JSON response with the IPv4 and IPv6 addresses that have been removed by the user via the \"/remove_ip/\" endpoint.","operationId":"list_removed_ips_list_removed_ips__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/download_ips/":{"get":{"summary":"Download the IPv4 and IPv6 sets as a JSON file.","description":"This function will return a JSON response with the IPv4 and IPv6 sets as a JSON file.\nRespective IPv4 and IPv6 addresses will be stored in a nested structure denoting each type of IP address.\nAdditionally, this will also include the IPv4 and IPv6 addresses that have been removed by the user via API call and store those\nin a nested structure denoting each type of IP address and the addresses themselves.","operationId":"download_ips_download_ips__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}