{"type":"api","title":"/OSType/{OSType}","meta":{"id":"/apps/pubhub/media/psirt-docs/89eb7ed57114b0017dfd4232666ca8a01095e144/77abf0dd-caf5-31f5-9198-1d2476135141","info":{"version":"2.0.1","title":"Cisco PSIRT openVuln API","description":"The Cisco Product Security Incident Response Team (PSIRT) openVuln API is a RESTful API that allows customers to obtain Cisco Security Vulnerability information in different machine-consumable formats. APIs are important for customers because they allow their technical staff and programmers to build tools that help them do their job more effectively (in this case, to keep up with security vulnerability information).\n","termsOfService":"https://github.com/CiscoPSIRT/openVulnAPI/blob/master/LICENSE.md","contact":{"name":"Cisco PSIRT","url":"https://tools.cisco.com/security/center/publicationListing.x","email":"openvuln@cisco.com"}},"security":[{"psirt_openvuln_api_auth":[]}],"tags":[{"name":"Current Endpoints","description":"Current supported API endpoints."},{"name":"Sunset Endpoints","description":"The \"security/advisories\" basepath will be deprecated in the future. These API endpoints have changed with the introduction of v2 basepath. Migrate the below endpoints to current endpoint calls. The below endpoints only work with \"security/advisories\" basepath."},{"name":"Obsolete Endpoints","description":"These API endpoints are no longer available. Migrate to current version calls."}],"openapi":"3.0.3","servers":[{"url":"https://apix.cisco.com/{basePath}","description":"OpenVuln API - Applications created post March 1, 2023","variables":{"basePath":{"default":"security/advisories/v2"}}},{"url":"https://api.cisco.com/{basePath}","description":"OpenVuln API - Applications created prior March 1, 2023; expires Sep 30, 2023","variables":{"basePath":{"default":"security/advisories/v2","enum":["security/advisories","security/advisories/v2"]}}}],"securitySchemes":{"psirt_openvuln_api_auth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"spec":{"description":"Used to obtain all advisories that affects the given network operating system version.","tags":["Current Endpoints"],"parameters":[{"in":"path","name":"OSType","description":"Network Operating System requested","required":true,"schema":{"description":"List of supported Network Operating Systems","type":"array","items":{"type":"string","enum":["aci","ios","iosxe","nxos","asa","ftd","fmc","fxos"]},"$$ref":"#/components/schemas/OSTypes"}},{"in":"query","name":"version","description":"Network Operating System version to obtain security advisories","required":true,"schema":{"type":"string","format":"string"}},{"in":"query","name":"platformAlias","description":"The Platform Alias to query by (Used only for nxos, asa, ftd and fxos)","required":false,"schema":{"description":"List of supported Platform Aliases","type":"array","items":{"type":"string","enum":["ASA5500","ASA5500X","ASASM","ASAV","FPR1000","FPR2100","FPR4100","FPR9000","FPRNGFW","FWL3100","ISA3000","MDS9000","NEXUS1000V","NEXUS3000","NEXUS5000","NEXUS6000","NEXUS7000","NEXUS9000"]},"$$ref":"#/components/schemas/PlatformAliases"},"explode":false},{"in":"query","name":"advisoryId","description":"Enter advisory ID for individual advisory.","required":false,"schema":{"type":"string","format":"cisco-sa-XXX"}},{"in":"query","name":"summaryDetails","description":"Include the Advisory Summary Description or not","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"productNames","description":"Include the ProductNames or not","required":false,"schema":{"type":"boolean"}},{"name":"startDate","description":"Format example Year-Month-Day 2022-05-12","in":"query","required":false,"schema":{"type":"string","format":"string","pattern":"^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01])$"}},{"name":"endDate","in":"query","description":"Format example Year-Month-Day 2022-05-12","required":false,"schema":{"type":"string","format":"string","pattern":"^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01])$"}},{"in":"query","name":"pageIndex","description":"The pageIndex field is an integer representing the current page index out of total number of pages","required":false,"schema":{"type":"integer"}},{"in":"query","name":"pageSize","description":"The pageSize field is an integer representing the maximum number of items requested by the client for the current page. The maximum pageSize limit is 100.","required":false,"schema":{"type":"integer"}}],"security":[{"psirt_openvuln_api_auth":["read:advisories"]}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"oneOf":[{"description":"Successful pull of advisory information","properties":{"advisoryId":{"type":"string","example":"cisco-sa-lsplus-Z6AQEOjk"},"advisoryTitle":{"type":"string","example":"Cisco IOS XR Software for ASR 9000 Series Routers Lightspeed-Plus Line Cards Denial of Service Vulnerability"},"bugIDs":{"type":"string","example":"CSCvy48962"},"ipsSignatures":{"type":"string","example":"NA"},"cves":{"type":"string","example":"CVE-2022-20714"},"cvrfUrl":{"type":"string","example":"https://tools.cisco.com/security/center/contentxml/CiscoSecurityAdvisory/cisco-sa-lsplus-Z6AQEOjk/cvrf/cisco-sa-lsplus-Z6AQEOjk_cvrf.xml"},"csafUrl":{"type":"string","example":"https://tools.cisco.com/security/center/contentjson/CiscoSecurityAdvisory/cisco-sa-lsplus-Z6AQEOjk/csaf/cisco-sa-lsplus-Z6AQEOjk_csaf.json"},"cvssBaseScore":{"type":"number","example":8.6},"cwe":{"type":"string","example":"CWE-12"},"firstPublished":{"type":"string","format":"date-time","example":"2022-04-13T23:00:00"},"lastUpdated":{"type":"string","format":"date-time","example":"2022-04-29T04:28:53"},"status":{"type":"string","example":"Final"},"version":{"type":"number","example":1.1},"productNames":{"type":"string","example":"Cisco IOS XR Software"},"publicationUrl":{"type":"string","example":"https://tools.cisco.com/security/center/content/CiscoSecurityAdvisory/cisco-sa-lsplus-Z6AQEOjk"},"sir":{"type":"string","example":"High"},"summary":{"type":"string","example":"\\r\\n\u003cp\u003eA vulnerability in the data plane microcode of Lightspeed-Plus line cards for \u003cspan class=\\\"mce-annotation tox-comment\\\" data-mce-annotation-uid=\\\"CONV-0005559\\\" data-mce-annotation=\\\"tinycomments\\\"\u003eCisco ASR 9000 Series Aggregation Services Routers\u003c/span\u003e, ASR 9902 Compact High-Performance Routers, and ASR 9903 Compact High-Performance Routers could allow an unauthenticated, remote attacker to cause the line card to reset.\u003c/p\u003e..."}},"$$ref":"#/components/schemas/Advisories"},{"description":"Data Query informs of data information. Use endpoint /OS_version/OS_data to retrive valid OS versions.","properties":{"errorCode":{"type":"string","example":"NO_IOS_AFFECTING_ADVISORIES_FOUND; INVALID_IOS_VERSION"},"errorMessage":{"type":"string","example":"No Cisco Security Advisories affect the Cisco IOS Software release; IOS version not found"}},"$$ref":"#/components/schemas/AdvisoriesErrors"}]}},"application/xml":{"schema":{"oneOf":[{"description":"Successful pull of advisory information","properties":{"advisoryId":{"type":"string","example":"cisco-sa-lsplus-Z6AQEOjk"},"advisoryTitle":{"type":"string","example":"Cisco IOS XR Software for ASR 9000 Series Routers Lightspeed-Plus Line Cards Denial of Service Vulnerability"},"bugIDs":{"type":"string","example":"CSCvy48962"},"ipsSignatures":{"type":"string","example":"NA"},"cves":{"type":"string","example":"CVE-2022-20714"},"cvrfUrl":{"type":"string","example":"https://tools.cisco.com/security/center/contentxml/CiscoSecurityAdvisory/cisco-sa-lsplus-Z6AQEOjk/cvrf/cisco-sa-lsplus-Z6AQEOjk_cvrf.xml"},"csafUrl":{"type":"string","example":"https://tools.cisco.com/security/center/contentjson/CiscoSecurityAdvisory/cisco-sa-lsplus-Z6AQEOjk/csaf/cisco-sa-lsplus-Z6AQEOjk_csaf.json"},"cvssBaseScore":{"type":"number","example":8.6},"cwe":{"type":"string","example":"CWE-12"},"firstPublished":{"type":"string","format":"date-time","example":"2022-04-13T23:00:00"},"lastUpdated":{"type":"string","format":"date-time","example":"2022-04-29T04:28:53"},"status":{"type":"string","example":"Final"},"version":{"type":"number","example":1.1},"productNames":{"type":"string","example":"Cisco IOS XR Software"},"publicationUrl":{"type":"string","example":"https://tools.cisco.com/security/center/content/CiscoSecurityAdvisory/cisco-sa-lsplus-Z6AQEOjk"},"sir":{"type":"string","example":"High"},"summary":{"type":"string","example":"\\r\\n\u003cp\u003eA vulnerability in the data plane microcode of Lightspeed-Plus line cards for \u003cspan class=\\\"mce-annotation tox-comment\\\" data-mce-annotation-uid=\\\"CONV-0005559\\\" data-mce-annotation=\\\"tinycomments\\\"\u003eCisco ASR 9000 Series Aggregation Services Routers\u003c/span\u003e, ASR 9902 Compact High-Performance Routers, and ASR 9903 Compact High-Performance Routers could allow an unauthenticated, remote attacker to cause the line card to reset.\u003c/p\u003e..."}},"$$ref":"#/components/schemas/Advisories"},{"description":"Data Query informs of data information. Use endpoint /OS_version/OS_data to retrive valid OS versions.","properties":{"errorCode":{"type":"string","example":"NO_IOS_AFFECTING_ADVISORIES_FOUND; INVALID_IOS_VERSION"},"errorMessage":{"type":"string","example":"No Cisco Security Advisories affect the Cisco IOS Software release; IOS version not found"}},"$$ref":"#/components/schemas/AdvisoriesErrors"}]}}}},"404":{"description":"No data found","content":{"application/json":{"schema":{"oneOf":[{"description":"Error Code and Message for VERSION_ID_IS_MANDATORY","properties":{"errorCode":{"type":"string","example":"VERSION_ID_IS_MANDATORY"},"errorMessage":{"type":"string","example":"Version ID is mandatory"}},"$$ref":"#/components/schemas/errorCode_VERSION_ID_IS_MANDATORY"},{"description":"Error Code and Message for NO_DATA_FOUND","properties":{"errorCode":{"type":"string","example":"NO_DATA_FOUND"},"errorMessage":{"type":"string","example":"No data found"}},"$$ref":"#/components/schemas/errorCode_NO_DATA_FOUND"},{"description":"Error Code and Message for ADVISORYID_NOT_FOUND","properties":{"errorCode":{"type":"string","example":"ADVISORYID_NOT_FOUND"},"errorMessage":{"type":"string","example":"Advisory-id not found"}},"$$ref":"#/components/schemas/errorCode_ADVISORYID_NOT_FOUND"}]}},"application/xml":{"schema":{"oneOf":[{"description":"Error Code and Message for VERSION_ID_IS_MANDATORY","properties":{"errorCode":{"type":"string","example":"VERSION_ID_IS_MANDATORY"},"errorMessage":{"type":"string","example":"Version ID is mandatory"}},"$$ref":"#/components/schemas/errorCode_VERSION_ID_IS_MANDATORY"},{"description":"Error Code and Message for NO_DATA_FOUND","properties":{"errorCode":{"type":"string","example":"NO_DATA_FOUND"},"errorMessage":{"type":"string","example":"No data found"}},"$$ref":"#/components/schemas/errorCode_NO_DATA_FOUND"},{"description":"Error Code and Message for ADVISORYID_NOT_FOUND","properties":{"errorCode":{"type":"string","example":"ADVISORYID_NOT_FOUND"},"errorMessage":{"type":"string","example":"Advisory-id not found"}},"$$ref":"#/components/schemas/errorCode_ADVISORYID_NOT_FOUND"}]}}}},"406":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"oneOf":[{"description":"Error Code and Message for INVALID_PAGEINDEX","properties":{"errorCode":{"type":"string","example":"INVALID_PAGEINDEX"},"errorMessage":{"type":"string","example":"Incorrect page index value"}},"$$ref":"#/components/schemas/errorCode_INVALID_PAGEINDEX"},{"description":"Error Code and Message for MIN_PAGESIZE , MAX_PAGESIZE","properties":{"errorCode":{"type":"string","example":"MIN_PAGESIZE , MAX_PAGESIZE"},"errorMessage":{"type":"string","example":"Minimum page size value = 1 and Maximum page size = 100"}},"$$ref":"#/components/schemas/errorCode_MIN_PAGESIZE"},{"description":"Error Code and Message for INVALID_DATE_FORMAT","properties":{"errorCode":{"type":"string","example":"INVALID_DATE_FORMAT"},"errorMessage":{"type":"string","example":"Invalid date format, please enter date in yyyy-mm-dd format"}},"$$ref":"#/components/schemas/errorCode_INVALID_DATE_FORMAT"},{"description":"Error Code and Message for INVALID_SEVERITY","properties":{"errorCode":{"type":"string","example":"INVALID_SEVERITY"},"errorMessage":{"type":"string","example":"Invalid Severity. Supported severities are critical, high, medium, low and informational"}},"$$ref":"#/components/schemas/errorCode_INVALID_SEVERITY"},{"description":"Error Code and Message for START_DATE_AND_END_DATE_MANDATORY","properties":{"errorCode":{"type":"string","example":"START_DATE_AND_END_DATE_MANDATORY"},"errorMessage":{"type":"string","example":"Start Date and End Date are mandatory"}},"$$ref":"#/components/schemas/errorCode_START_DATE_AND_END_DATE_MANDATORY"}]}},"application/xml":{"schema":{"oneOf":[{"description":"Error Code and Message for INVALID_PAGEINDEX","properties":{"errorCode":{"type":"string","example":"INVALID_PAGEINDEX"},"errorMessage":{"type":"string","example":"Incorrect page index value"}},"$$ref":"#/components/schemas/errorCode_INVALID_PAGEINDEX"},{"description":"Error Code and Message for MIN_PAGESIZE , MAX_PAGESIZE","properties":{"errorCode":{"type":"string","example":"MIN_PAGESIZE , MAX_PAGESIZE"},"errorMessage":{"type":"string","example":"Minimum page size value = 1 and Maximum page size = 100"}},"$$ref":"#/components/schemas/errorCode_MIN_PAGESIZE"},{"description":"Error Code and Message for INVALID_DATE_FORMAT","properties":{"errorCode":{"type":"string","example":"INVALID_DATE_FORMAT"},"errorMessage":{"type":"string","example":"Invalid date format, please enter date in yyyy-mm-dd format"}},"$$ref":"#/components/schemas/errorCode_INVALID_DATE_FORMAT"},{"description":"Error Code and Message for INVALID_SEVERITY","properties":{"errorCode":{"type":"string","example":"INVALID_SEVERITY"},"errorMessage":{"type":"string","example":"Invalid Severity. Supported severities are critical, high, medium, low and informational"}},"$$ref":"#/components/schemas/errorCode_INVALID_SEVERITY"},{"description":"Error Code and Message for START_DATE_AND_END_DATE_MANDATORY","properties":{"errorCode":{"type":"string","example":"START_DATE_AND_END_DATE_MANDATORY"},"errorMessage":{"type":"string","example":"Start Date and End Date are mandatory"}},"$$ref":"#/components/schemas/errorCode_START_DATE_AND_END_DATE_MANDATORY"}]}}}}},"method":"get","path":"/OSType/{OSType}"}}