{"openapi":"3.1.0","info":{"title":"Apizie: security","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/security:nvd-cve/cve":{"get":{"operationId":"security_nvd_cve_cve","summary":"CVE","description":"One CVE by id.","tags":["security"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"},"example":"CVE-2021-44228"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":21600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/security:nvd-cve/search":{"get":{"operationId":"security_nvd_cve_search","summary":"Search CVEs","description":"Keyword search.","tags":["security"],"parameters":[{"name":"keyword","in":"query","required":true,"schema":{"type":"string"},"example":"openssl"},{"name":"resultsPerPage","in":"query","required":false,"description":"Number of results","schema":{"type":"integer","default":20,"minimum":1,"maximum":2000,"description":"Number of results"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":21600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/security:epss/scores":{"get":{"operationId":"security_epss_scores","summary":"Scores","description":"EPSS score and percentile for CVEs.","tags":["security"],"parameters":[{"name":"cve","in":"query","required":true,"schema":{"type":"string"},"example":"CVE-2023-4863,CVE-2024-3094"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":21600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/security:cisa-kev/search":{"get":{"operationId":"security_cisa_kev_search","summary":"Search catalog","description":"Filter the catalog by CVE, vendor or product.","tags":["security"],"parameters":[{"name":"cve","in":"query","required":false,"schema":{"type":"string"},"example":"CVE-2021-44228"},{"name":"vendor","in":"query","required":false,"schema":{"type":"string"},"example":"Microsoft"},{"name":"product","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Number of results","schema":{"type":"integer","default":50,"minimum":1,"maximum":2000,"description":"Number of results"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":21600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/security:shodan-internetdb/ip":{"get":{"operationId":"security_shodan_internetdb_ip","summary":"IP lookup","description":"What Shodan has seen on an IPv4 address.","tags":["security"],"parameters":[{"name":"ip","in":"query","required":true,"schema":{"type":"string"},"example":"8.8.8.8"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":86400,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/security:pwned-passwords/range":{"get":{"operationId":"security_pwned_passwords_range","summary":"Hash range","description":"Hash suffixes and counts for a 5-character SHA-1 prefix.","tags":["security"],"parameters":[{"name":"prefix","in":"query","required":true,"schema":{"type":"string"},"example":"21BD1"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":86400,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/security:crt-sh/search":{"get":{"operationId":"security_crt_sh_search","summary":"Certificates","description":"Certificates matching a domain (use %.example.com for subdomains).","tags":["security"],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":"%.example.com"},{"name":"limit","in":"query","required":false,"description":"Number of results","schema":{"type":"integer","default":100,"minimum":1,"maximum":1000,"description":"Number of results"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":21600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/security:osv/query":{"post":{"operationId":"security_osv_query","summary":"Query package","description":"Known vulnerabilities affecting a package version.","tags":["security"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ecosystem","name"],"properties":{"ecosystem":{"type":"string","enum":["npm","PyPI","Go","Maven","crates.io","NuGet","RubyGems","Packagist","Debian","Alpine"]},"name":{"type":"string"},"version":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":3600,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/security:osv/vuln":{"get":{"operationId":"security_osv_vuln","summary":"Vulnerability","description":"One advisory by OSV, GHSA or CVE id.","tags":["security"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"},"example":"GHSA-p6mc-m468-83gw"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":86400,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}