{"openapi":"3.1.0","info":{"title":"Apizie","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:cisco/get-security-advisories-cvrf-advisory-advisory-id":{"get":{"operationId":"security_cisco_get_security_advisories_cvrf_advisory_advisory_id","summary":"Used to obtain an advisory in CVRF format for a given advisory ID `advisory_id` (i.e., cisco-sa-20150819-pcp)","description":"GET /security/advisories/cvrf/advisory/{advisory_id}","tags":["security"],"parameters":[{"name":"advisory_id","in":"query","required":true,"description":"advisory ID","schema":{"type":"string","description":"advisory ID"}}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:cisco/get-security-advisories-cvrf-all":{"get":{"operationId":"security_cisco_get_security_advisories_cvrf_all","summary":"Used to obtain all advisories in Common Vulnerability Reporting Format (CVRF). For more information about…","description":"GET /security/advisories/cvrf/all","tags":["security"],"parameters":[],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:cisco/get-security-advisories-cvrf-cve-cve-id":{"get":{"operationId":"security_cisco_get_security_advisories_cvrf_cve_cve_id","summary":"Used to obtain an advisory in CVRF format for a given Common Vulnerability Enumerator (CVE). The `cve_id`…","description":"GET /security/advisories/cvrf/cve/{cve_id}","tags":["security"],"parameters":[{"name":"cve_id","in":"query","required":true,"description":"CVE Identifier (i.e., CVE-YYYY-NNNN)","schema":{"type":"string","description":"CVE Identifier (i.e., CVE-YYYY-NNNN)"}}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:cisco/get-security-advisories-cvrf-latest-number":{"get":{"operationId":"security_cisco_get_security_advisories_cvrf_latest_number","summary":"Used to obtain all the latest security advisories in CVRF format given an absolute number. For instance, the…","description":"GET /security/advisories/cvrf/latest/{number}","tags":["security"],"parameters":[{"name":"number","in":"query","required":true,"description":"An absolute number to obtain the latest security advisories.","schema":{"type":"integer","description":"An absolute number to obtain the latest security advisories."}}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:cisco/get-security-advisories-cvrf-product":{"get":{"operationId":"security_cisco_get_security_advisories_cvrf_product","summary":"Used to obtain all the advisories that affects the given product name.","description":"GET /security/advisories/cvrf/product","tags":["security"],"parameters":[{"name":"product","in":"query","required":true,"description":"An product name to obtain security advisories that matches given product name.","schema":{"type":"string","description":"An product name to obtain security advisories that matches given product name."}}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:cisco/get-security-advisories-cvrf-severity-severity":{"get":{"operationId":"security_cisco_get_security_advisories_cvrf_severity_severity","summary":"Used to obtain all security advisories for a given security impact rating (critical, high, medium, or low)…","description":"GET /security/advisories/cvrf/severity/{severity}","tags":["security"],"parameters":[{"name":"severity","in":"query","required":true,"description":"Critical, High, Medium, Low","schema":{"type":"string","enum":["critical","high","medium","low"],"description":"Critical, High, Medium, Low"}}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:cisco/get-security-advisories-cvrf-severity-severity-firstpublishe":{"get":{"operationId":"security_cisco_get_security_advisories_cvrf_severity_severity_firstpublishe","summary":"Used to obtain all security advisories for a given security impact rating (critical, high, medium, or low)…","description":"GET /security/advisories/cvrf/severity/{severity}/firstpublished","tags":["security"],"parameters":[{"name":"severity","in":"query","required":true,"description":"Used to obtain all advisories that have a security impact rating of critical","schema":{"type":"string","enum":["critical","high","medium","low"],"description":"Used to obtain all advisories that have a security impact rating of critical"}},{"name":"startDate","in":"query","required":true,"schema":{"type":"string"}},{"name":"endDate","in":"query","required":true,"schema":{"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:cisco/get-security-advisories-cvrf-severity-severity-lastpublished":{"get":{"operationId":"security_cisco_get_security_advisories_cvrf_severity_severity_lastpublished","summary":"Used to obtain all security advisories for a given security impact rating (critical, high, medium, or low)…","description":"GET /security/advisories/cvrf/severity/{severity}/lastpublished","tags":["security"],"parameters":[{"name":"severity","in":"query","required":true,"description":"Used to obtain all advisories that have a security impact rating of critical","schema":{"type":"string","enum":["critical","high","medium","low"],"description":"Used to obtain all advisories that have a security impact rating of critical"}},{"name":"startDate","in":"query","required":true,"schema":{"type":"string"}},{"name":"endDate","in":"query","required":true,"schema":{"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:cisco/get-security-advisories-cvrf-year-year":{"get":{"operationId":"security_cisco_get_security_advisories_cvrf_year_year","summary":"Used to obtain all security advisories that have were orginally published in a specific year `YYYY`.","description":"GET /security/advisories/cvrf/year/{year}","tags":["security"],"parameters":[{"name":"year","in":"query","required":true,"description":"The four digit year.","schema":{"type":"string","description":"The four digit year."}}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:cisco/get-security-advisories-ios":{"get":{"operationId":"security_cisco_get_security_advisories_ios","summary":"Used to obtain all advisories that affects the given ios version","description":"GET /security/advisories/ios","tags":["security"],"parameters":[{"name":"version","in":"query","required":true,"description":"IOS version to obtain security advisories","schema":{"type":"string","description":"IOS version to obtain security advisories"}}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:cisco/get-security-advisories-iosxe":{"get":{"operationId":"security_cisco_get_security_advisories_iosxe","summary":"Used to obtain all advisories that affects the given ios version","description":"GET /security/advisories/iosxe","tags":["security"],"parameters":[{"name":"version","in":"query","required":true,"description":"IOS version to obtain security advisories","schema":{"type":"string","description":"IOS version to obtain security advisories"}}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:cisco/get-security-advisories-oval-advisory-advisory-id":{"get":{"operationId":"security_cisco_get_security_advisories_oval_advisory_advisory_id","summary":"Used to obtain OVAL definitions for a given advisory ID `advisory_id` (i.e., cisco-sa-20150819-pcp)","description":"GET /security/advisories/oval/advisory/{advisory_id}","tags":["security"],"parameters":[{"name":"advisory_id","in":"query","required":true,"description":"advisory ID","schema":{"type":"string","description":"advisory ID"}}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:cisco/get-security-advisories-oval-all":{"get":{"operationId":"security_cisco_get_security_advisories_oval_all","summary":"Used to obtain all Open Vulnerability and Assessment Language (OVAL) definitions available for Cisco…","description":"GET /security/advisories/oval/all","tags":["security"],"parameters":[],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:cisco/get-security-advisories-oval-cve-cve-id":{"get":{"operationId":"security_cisco_get_security_advisories_oval_cve_cve_id","summary":"Used to obtain OVAL definitions for a given CVE Identifier. The `cve_id` format is CVE-YYYY-NNNN.","description":"GET /security/advisories/oval/cve/{cve_id}","tags":["security"],"parameters":[{"name":"cve_id","in":"query","required":true,"description":"CVE Identifier (i.e., CVE-YYYY-NNNN)","schema":{"type":"string","description":"CVE Identifier (i.e., CVE-YYYY-NNNN)"}}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:cisco/get-security-advisories-oval-latest-number":{"get":{"operationId":"security_cisco_get_security_advisories_oval_latest_number","summary":"Used to obtain all the latest OVAL definitions given an absolute number. For instance, the latest 10 or…","description":"GET /security/advisories/oval/latest/{number}","tags":["security"],"parameters":[{"name":"number","in":"query","required":true,"description":"The latest OVAL definitions (absolute number).","schema":{"type":"integer","description":"The latest OVAL definitions (absolute number)."}}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:cisco/get-security-advisories-oval-product":{"get":{"operationId":"security_cisco_get_security_advisories_oval_product","summary":"Used to obtain all the oval advisories that affects the given product name.","description":"GET /security/advisories/oval/product","tags":["security"],"parameters":[{"name":"product","in":"query","required":true,"description":"An product name to obtain security advisories that matches given product name.","schema":{"type":"string","description":"An product name to obtain security advisories that matches given product name."}}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:cisco/get-security-advisories-oval-severity-severity":{"get":{"operationId":"security_cisco_get_security_advisories_oval_severity_severity","summary":"Used to obtain all OVAL definitions for a given security impact rating (critical, high, medium, or low).","description":"GET /security/advisories/oval/severity/{severity}","tags":["security"],"parameters":[{"name":"severity","in":"query","required":true,"description":"Used to obtain all OVAL definitions for advisories that have a security impact rating of critical","schema":{"type":"string","enum":["critical","high","medium","low"],"description":"Used to obtain all OVAL definitions for advisories that have a security impact rating of critical"}}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:cisco/get-security-advisories-oval-severity-severity-firstpublishe":{"get":{"operationId":"security_cisco_get_security_advisories_oval_severity_severity_firstpublishe","summary":"Used to obtain all security advisories for a given security impact rating (critical, high, medium, or low)…","description":"GET /security/advisories/oval/severity/{severity}/firstpublished","tags":["security"],"parameters":[{"name":"severity","in":"query","required":true,"description":"Critical, High, Medium, Low","schema":{"type":"string","enum":["critical","high","medium","low"],"description":"Critical, High, Medium, Low"}},{"name":"startDate","in":"query","required":true,"schema":{"type":"string"}},{"name":"endDate","in":"query","required":true,"schema":{"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/security:cisco/get-security-advisories-oval-severity-severity-lastpublished":{"get":{"operationId":"security_cisco_get_security_advisories_oval_severity_severity_lastpublished","summary":"Used to obtain all security advisories for a given security impact rating (critical, high, medium, or low)…","description":"GET /security/advisories/oval/severity/{severity}/lastpublished","tags":["security"],"parameters":[{"name":"severity","in":"query","required":true,"description":"Critical, High, Medium, Low","schema":{"type":"string","enum":["critical","high","medium","low"],"description":"Critical, High, Medium, Low"}},{"name":"startDate","in":"query","required":true,"schema":{"type":"string"}},{"name":"endDate","in":"query","required":true,"schema":{"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"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"}}}}}}}