{"openapi":"3.1.0","info":{"title":"sysadmin.lk diagnostics API","version":"0.1.0","description":"Free DNS, email authentication, SSL/TLS, HTTP, network and reputation checks. Every response uses the envelope {success, data, meta} or {success, error, meta}. Anonymous use is rate limited; see https://sysadmin.lk/developers for limits and API keys."},"paths":{"/api/v1/network/ping":{"post":{"tags":["network"],"summary":"Start Ping","operationId":"start_ping_api_v1_network_ping_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TargetRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanCreated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/network/traceroute":{"post":{"tags":["network"],"summary":"Start Traceroute","operationId":"start_traceroute_api_v1_network_traceroute_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TargetRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanCreated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/network/port-checker":{"post":{"tags":["network"],"summary":"Start Port Checker","operationId":"start_port_checker_api_v1_network_port_checker_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortCheckerRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanCreated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/network/ip-lookup":{"post":{"tags":["network"],"summary":"Start Ip Lookup","operationId":"start_ip_lookup_api_v1_network_ip_lookup_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TargetRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanCreated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/network/scans/{scan_id}":{"get":{"tags":["network"],"summary":"Get Scan","operationId":"get_scan_api_v1_network_scans__scan_id__get","parameters":[{"name":"scan_id","in":"path","required":true,"schema":{"type":"string","title":"Scan Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanStatusOut"}}}},"404":{"description":"Scan not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dns/a":{"get":{"tags":["dns"],"summary":"Dns A","operationId":"dns_a_api_v1_dns_a_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dns/aaaa":{"get":{"tags":["dns"],"summary":"Dns Aaaa","operationId":"dns_aaaa_api_v1_dns_aaaa_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dns/cname":{"get":{"tags":["dns"],"summary":"Dns Cname","operationId":"dns_cname_api_v1_dns_cname_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dns/mx":{"get":{"tags":["dns"],"summary":"Dns Mx","operationId":"dns_mx_api_v1_dns_mx_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dns/ns":{"get":{"tags":["dns"],"summary":"Dns Ns","operationId":"dns_ns_api_v1_dns_ns_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dns/txt":{"get":{"tags":["dns"],"summary":"Dns Txt","operationId":"dns_txt_api_v1_dns_txt_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dns/soa":{"get":{"tags":["dns"],"summary":"Dns Soa","operationId":"dns_soa_api_v1_dns_soa_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dns/caa":{"get":{"tags":["dns"],"summary":"Dns Caa","operationId":"dns_caa_api_v1_dns_caa_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dns/srv":{"get":{"tags":["dns"],"summary":"Dns Srv","operationId":"dns_srv_api_v1_dns_srv_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dns/ds":{"get":{"tags":["dns"],"summary":"Dns Ds","operationId":"dns_ds_api_v1_dns_ds_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dns/whois":{"get":{"tags":["dns"],"summary":"Dns Whois","operationId":"dns_whois_api_v1_dns_whois_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dns/dnssec":{"get":{"tags":["dns"],"summary":"Dns Dnssec","operationId":"dns_dnssec_api_v1_dns_dnssec_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dns/rdns":{"get":{"tags":["dns"],"summary":"Dns Rdns","operationId":"dns_rdns_api_v1_dns_rdns_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dns/zone-transfer":{"get":{"tags":["dns"],"summary":"Dns Zone-Transfer","operationId":"dns_zone_transfer_api_v1_dns_zone_transfer_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dns/propagation":{"get":{"tags":["dns"],"summary":"Dns Propagation","operationId":"dns_propagation_api_v1_dns_propagation_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}},{"name":"record_type","in":"query","required":false,"schema":{"enum":["A","AAAA","CNAME","MX","NS","TXT","SOA","CAA"],"type":"string","default":"A","title":"Record Type"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/email/spf":{"get":{"tags":["email"],"summary":"Email Spf","operationId":"email_spf_api_v1_email_spf_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/email/dmarc":{"get":{"tags":["email"],"summary":"Email Dmarc","operationId":"email_dmarc_api_v1_email_dmarc_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/email/bimi":{"get":{"tags":["email"],"summary":"Email Bimi","operationId":"email_bimi_api_v1_email_bimi_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/email/tls-rpt":{"get":{"tags":["email"],"summary":"Email Tls-Rpt","operationId":"email_tls_rpt_api_v1_email_tls_rpt_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/email/mta-sts":{"get":{"tags":["email"],"summary":"Email Mta-Sts","operationId":"email_mta_sts_api_v1_email_mta_sts_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/email/dkim":{"get":{"tags":["email"],"summary":"Email Dkim","operationId":"email_dkim_api_v1_email_dkim_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}},{"name":"selector","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":63,"title":"Selector"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/http/check":{"get":{"tags":["http"],"summary":"Http Check","operationId":"http_check_api_v1_http_check_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/http/security-headers":{"get":{"tags":["http"],"summary":"Http Security-Headers","operationId":"http_security_headers_api_v1_http_security_headers_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/http/hsts-preload":{"get":{"tags":["http"],"summary":"Http Hsts-Preload","operationId":"http_hsts_preload_api_v1_http_hsts_preload_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tls/certificate":{"get":{"tags":["tls"],"summary":"Tls Certificate","operationId":"tls_certificate_api_v1_tls_certificate_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/security/blacklist":{"get":{"tags":["security"],"summary":"Security Blacklist","operationId":"security_blacklist_api_v1_security_blacklist_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/security/takeover":{"get":{"tags":["security"],"summary":"Security Takeover","operationId":"security_takeover_api_v1_security_takeover_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"target","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":253,"title":"Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ScanResultOut_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/scanner/super-scan":{"post":{"tags":["scanner"],"summary":"Start Super Scan","operationId":"start_super_scan_api_v1_scanner_super_scan_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuperScanRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanCreated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/scanner/super-scan/{scan_id}":{"get":{"tags":["scanner"],"summary":"Get Super Scan","operationId":"get_super_scan_api_v1_scanner_super_scan__scan_id__get","parameters":[{"name":"scan_id","in":"path","required":true,"schema":{"type":"string","title":"Scan Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuperScanStatusOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/mailtest/generate":{"post":{"tags":["mailtest"],"summary":"Generate Mail Test","operationId":"generate_mail_test_api_v1_mailtest_generate_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailTestCreated"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/mailtest/{token}":{"get":{"tags":["mailtest"],"summary":"Get Mail Test","operationId":"get_mail_test_api_v1_mailtest__token__get","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","title":"Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailTestStatusOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/csr/generate":{"post":{"tags":["csr"],"summary":"Generate","operationId":"generate_api_v1_csr_generate_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CsrRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CsrOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/smtp-test":{"post":{"tags":["smtp-test"],"summary":"Smtp Test","operationId":"smtp_test_api_v1_smtp_test_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmtpTestRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmtpTestOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/whoami":{"get":{"tags":["whoami"],"summary":"Whoami","operationId":"whoami_api_v1_whoami_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_WhoAmIOut_"}}}}}}},"/api/v1/regions":{"get":{"tags":["regions"],"summary":"List Regions","description":"Which regional worker pools scans can be routed to (see\napp.config.Settings.available_regions) — lets the frontend build a\nregion picker without hardcoding the list.","operationId":"list_regions_api_v1_regions_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RegionOut"},"type":"array","title":"Response List Regions Api V1 Regions Get"}}}}}}}},"components":{"schemas":{"CsrOut":{"properties":{"csr_pem":{"type":"string","title":"Csr Pem"},"private_key_pem":{"type":"string","title":"Private Key Pem"}},"type":"object","required":["csr_pem","private_key_pem"],"title":"CsrOut"},"CsrRequest":{"properties":{"common_name":{"type":"string","maxLength":253,"minLength":1,"title":"Common Name"},"organization":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Organization"},"organizational_unit":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Organizational Unit"},"locality":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Locality"},"state":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"State"},"country":{"anyOf":[{"type":"string","maxLength":2,"minLength":2},{"type":"null"}],"title":"Country"},"email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Email"},"san_domains":{"items":{"type":"string"},"type":"array","maxItems":100,"title":"San Domains"},"key_size":{"type":"integer","title":"Key Size","default":2048}},"type":"object","required":["common_name"],"title":"CsrRequest"},"FindingOut":{"properties":{"code":{"type":"string","title":"Code"},"severity":{"type":"string","title":"Severity"},"title":{"type":"string","title":"Title"},"description":{"type":"string","title":"Description"},"recommendation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recommendation"},"documentation_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Documentation Url"}},"type":"object","required":["code","severity","title","description"],"title":"FindingOut"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"MailTestCreated":{"properties":{"token":{"type":"string","title":"Token"},"test_address":{"type":"string","title":"Test Address"},"expires_at":{"type":"string","format":"date-time","title":"Expires At"}},"type":"object","required":["token","test_address","expires_at"],"title":"MailTestCreated"},"MailTestStatusOut":{"properties":{"token":{"type":"string","title":"Token"},"status":{"type":"string","title":"Status"},"score":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Score"},"findings":{"items":{"$ref":"#/components/schemas/FindingOut"},"type":"array","title":"Findings"},"sender_ip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender Ip"},"from_domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From Domain"},"spf_result":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Spf Result"},"dkim_valid":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Dkim Valid"},"dmarc_aligned":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Dmarc Aligned"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"received_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Received At"},"expires_at":{"type":"string","format":"date-time","title":"Expires At"}},"type":"object","required":["token","status","created_at","expires_at"],"title":"MailTestStatusOut"},"Meta":{"properties":{"request_id":{"type":"string","title":"Request Id"}},"type":"object","required":["request_id"],"title":"Meta"},"PortCheckerRequest":{"properties":{"target":{"type":"string","maxLength":253,"minLength":1,"title":"Target"},"ports":{"anyOf":[{"items":{"type":"integer"},"type":"array","maxItems":25},{"type":"null"}],"title":"Ports"}},"type":"object","required":["target"],"title":"PortCheckerRequest"},"RegionOut":{"properties":{"id":{"type":"string","title":"Id"},"is_default":{"type":"boolean","title":"Is Default"}},"type":"object","required":["id","is_default"],"title":"RegionOut"},"ScanCreated":{"properties":{"scan_id":{"type":"string","title":"Scan Id"},"tool_id":{"type":"string","title":"Tool Id"},"target":{"type":"string","title":"Target"},"status":{"type":"string","title":"Status"},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Region"}},"type":"object","required":["scan_id","tool_id","target","status"],"title":"ScanCreated"},"ScanResultOut":{"properties":{"tool":{"type":"string","title":"Tool"},"status":{"type":"string","title":"Status"},"severity":{"type":"string","title":"Severity"},"score":{"type":"integer","title":"Score"},"summary":{"type":"string","title":"Summary"},"data":{"type":"object","title":"Data"},"findings":{"items":{"$ref":"#/components/schemas/FindingOut"},"type":"array","title":"Findings"},"duration_ms":{"type":"integer","title":"Duration Ms"}},"type":"object","required":["tool","status","severity","score","summary","data","findings","duration_ms"],"title":"ScanResultOut"},"ScanStatusOut":{"properties":{"scan_id":{"type":"string","title":"Scan Id"},"tool_id":{"type":"string","title":"Tool Id"},"target":{"type":"string","title":"Target"},"status":{"type":"string","title":"Status"},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Message"},"result":{"anyOf":[{"$ref":"#/components/schemas/ScanResultOut"},{"type":"null"}]}},"type":"object","required":["scan_id","tool_id","target","status"],"title":"ScanStatusOut"},"SmtpTestOut":{"properties":{"success":{"type":"boolean","title":"Success"},"log":{"items":{"type":"string"},"type":"array","title":"Log"}},"type":"object","required":["success","log"],"title":"SmtpTestOut"},"SmtpTestRequest":{"properties":{"host":{"type":"string","maxLength":253,"minLength":1,"title":"Host"},"port":{"type":"integer","maximum":65535,"minimum":1,"title":"Port","default":587},"username":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Username"},"password":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Password"},"tls_mode":{"type":"string","title":"Tls Mode","default":"starttls"},"sender_email":{"anyOf":[{"type":"string","format":"email"},{"type":"null"}],"title":"Sender Email"},"receiver_email":{"type":"string","format":"email","title":"Receiver Email"}},"type":"object","required":["host","receiver_email"],"title":"SmtpTestRequest"},"SuccessEnvelope_ScanResultOut_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"data":{"$ref":"#/components/schemas/ScanResultOut"},"meta":{"$ref":"#/components/schemas/Meta"}},"type":"object","required":["data","meta"],"title":"SuccessEnvelope[ScanResultOut]"},"SuccessEnvelope_WhoAmIOut_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"data":{"$ref":"#/components/schemas/WhoAmIOut"},"meta":{"$ref":"#/components/schemas/Meta"}},"type":"object","required":["data","meta"],"title":"SuccessEnvelope[WhoAmIOut]"},"SuperScanRequest":{"properties":{"target":{"type":"string","maxLength":253,"minLength":1,"title":"Target"},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Region"}},"type":"object","required":["target"],"title":"SuperScanRequest"},"SuperScanStatusOut":{"properties":{"scan_id":{"type":"string","title":"Scan Id"},"tool_id":{"type":"string","title":"Tool Id"},"target":{"type":"string","title":"Target"},"status":{"type":"string","title":"Status"},"region":{"type":"string","title":"Region"},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Message"},"score":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Score"},"severity":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Severity"},"results":{"items":{"$ref":"#/components/schemas/ScanResultOut"},"type":"array","title":"Results"}},"type":"object","required":["scan_id","tool_id","target","status","region"],"title":"SuperScanStatusOut"},"TargetRequest":{"properties":{"target":{"type":"string","maxLength":253,"minLength":1,"title":"Target"}},"type":"object","required":["target"],"title":"TargetRequest"},"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"},"WhoAmIOut":{"properties":{"ip":{"type":"string","title":"Ip"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country"},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Code"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City"},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Region"},"org":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Org"}},"type":"object","required":["ip"],"title":"WhoAmIOut"}},"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"}}},"servers":[{"url":"https://backend.sysadmin.lk"}]}