{"type":"api","title":"/platforms","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":"To obtain the platform types for the networking operating system.","tags":["Current Endpoints"],"parameters":[{"name":"OSType","in":"query","description":"(Use with v2 basepath)","required":false,"schema":{"description":"List of supported Network Operating Systems which support Platforms","type":"array","items":{"type":"string","enum":["asa","ftd","fxos","nxos"]},"$$ref":"#/components/schemas/OSTypesPlatforms"},"explode":false},{"name":"nos_type","in":"query","description":"(Use with \"security/advisories\" basepath. This is a sunsetting parameter)","required":false,"schema":{"type":"string","enum":["nxOS"],"format":"enum"}}],"security":[{"psirt_openvuln_api_auth":["read:advisories"]}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"description":"Data Query informs of platform aliases for a given OS.","properties":{"platformAlias":{"type":"string","example":"MDS9000"},"id":{"type":"integer","example":265086},"name":{"type":"string","example":"Cisco MDS 9000 Multilayer Directors and Fabric Switches"}},"$$ref":"#/components/schemas/PlatformData"}},"application/xml":{"schema":{"description":"Data Query informs of platform aliases for a given OS.","properties":{"platformAlias":{"type":"string","example":"MDS9000"},"id":{"type":"integer","example":265086},"name":{"type":"string","example":"Cisco MDS 9000 Multilayer Directors and Fabric Switches"}},"$$ref":"#/components/schemas/PlatformData"}}}},"404":{"description":"OSType not found","content":{"application/json":{"schema":{"description":"Error Code and Message for OS_TYPE_NOT_FOUND","properties":{"errorCode":{"type":"string","example":"OS_TYPE_NOT_FOUND"},"errorMessage":{"type":"string","example":"OS Type is mandatory"}},"$$ref":"#/components/schemas/errorCode_OS_TYPE_NOT_FOUND"}},"application/xml":{"schema":{"description":"Error Code and Message for OS_TYPE_NOT_FOUND","properties":{"errorCode":{"type":"string","example":"OS_TYPE_NOT_FOUND"},"errorMessage":{"type":"string","example":"OS Type is mandatory"}},"$$ref":"#/components/schemas/errorCode_OS_TYPE_NOT_FOUND"}}}},"406":{"description":"Invalid OS Type presented.","content":{"application/json":{"schema":{"description":"Error Code and Message for INVALID_OS_TYPE","properties":{"errorCode":{"type":"string","example":"INVALID_OS_TYPE"},"errorMessage":{"type":"string","example":"OS Type is Invalid"}},"$$ref":"#/components/schemas/errorCode_INVALID_OS_TYPE"}},"application/xml":{"schema":{"description":"Error Code and Message for INVALID_OS_TYPE","properties":{"errorCode":{"type":"string","example":"INVALID_OS_TYPE"},"errorMessage":{"type":"string","example":"OS Type is Invalid"}},"$$ref":"#/components/schemas/errorCode_INVALID_OS_TYPE"}}}}},"method":"get","path":"/platforms"}}