PSS API Developer's Guide

PSIRT Service

The PSIRTService has two API calls associated to this service:

getPSIRT
getPSIRTDetails

getPSIRT

This API service call gets all PSIRT Alerts for the specified customer, inventory and devices.

The input data (Customer ID, Inventory ID, and Device ID) were obtained from the data returned in the first two Inventory API service calls (for more information see the "Manual Process Overview for API Service Calls" section).

It is recommended to use Device ID as a parameter for request.

Request Parameter(s)

Parameter	Required	Type	Description
customerID	Yes	string	This parameter is returned in the API service call getCustomersInventoryIds. customerId is the ID of the Entitlement Company.
inventoryId	Yes	string	This parameter is returned in the API service call getCustomersInventoryIds. inventoryId identifies the inventory whose data will be accessed for the chassis & card level details.
deviceIds	Optional	string	The deviceIds input can be zero or more. When not providing the deviceIds, the api will return a full collection of data for that given InventoryID, for that given CustomerId, of that given PartyGUID; all the devices collected for that inventory will be returned.

Response Parameter(s)

Parameter	Type	Length	Description
deviceId	string	22	ID of the device.
psirtId	string	22	PSIRT id of the device.
matchConfidence	string	30	Match confidence factor for the PSIRT item.
matchReason	string	NA*	Match reason factor for the PSIRT item.
softwareType	string	50	Software type of the device in the PSIRT item.
softwareVersion	string	50	Software version of the device in the PSIRT item.

responseTimestamp

Parameter	Type	Length	Description
	date	DATE	The time stamp indicates when this service call was performed.

message[ ]

Parameter	Type	Length	Description
			See Message Format section for more details.
messageType	string	255
messageDetail	string	255

*NA = Not available

SOAP Request


    POST https://api.cisco.com/pss/v1.0/PSIRTAlertService HTTP/1.1
    Accept-Encoding: gzip,deflate
    Content-Type: text/xml;charset=UTF-8
    SOAPAction: "getPSIRT"
    Authorization: Bearer pmx57ukvwwfwswff2c2fweer
    
    ‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
    xmlns:psir="http://www.cisco.com/PSIRTAlertService"›
        ‹soapenv:Header/›
        ‹soapenv:Body›
            ‹psir:PSIRTRequestInput›
                ‹psir:customerId›109757‹/psir:customerId›
                ‹psir:inventoryId›15224‹/psir:inventoryId›
                ‹!--Zero or more repetitions:--›
                ‹psir:deviceIds›‹/psir:deviceIds›
            ‹/psir:PSIRTRequestInput›
        ‹/soapenv:Body›
    ‹/soapenv:Envelope›

SOAP Response


    HTTP/1.1 200 OK
    Date: Tue, 02 Apr 2013 20:19:32 GMT
    Server: IBM_HTTP_Server
    X-Mashery-Responder: APIX-PROD-01
    Cache-Control: private
    Pragma: private
    Content-Type: text/xml; charset=UTF-8
    Content-Language: en-US
    Cache-Control: max-age=0
    Expires: Tue, 02 Apr 2013 20:19:32 GMT
    Set-Cookie: TOOLS-Loc=tools1.cisco.com; path=/; domain=.cisco.com
    Connection: close
    Transfer-Encoding: chunked
        
    ‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"›
        ‹soapenv:Body›
            ‹psirt:PSIRTResponseOutput xmlns:psirt="http://www.cisco.com/PSIRTAlertService" 
            xmlns:fn="http://www.cisco.com/FNAlertService" 
            xmlns:hweox="http://www.cisco.com/HwEoxAlertService"
            xmlns:inv="http://www.cisco.com/InventoryService" 
            xmlns:sweox="http://www.cisco.com/SwEoxAlertService" 
            xmlns:w3c="http://www.w3.org/2001/XMLSchema-instance" 
            xmlns:is="http://www.cisco.com/ISAlertService" 
            xmlns:con="http://www.cisco.com/ContractService"›
                ‹psirt:DevicePSIRTResponseDTO›
                    ‹psirt:deviceId›3617990‹/psirt:deviceId›
                    ‹psirt:devicePSIRT›
                        ‹psirt:psirtId›308‹/psirt:psirtId›
                        ‹psirt:matchConfidence›Vulnerable‹/psirt:matchConfidence›
                        ‹psirt:matchReason/›
                        ‹psirt:softwareType›IOS‹/psirt:softwareType›
                        ‹psirt:softwareVersion›15.0(1)M4‹/psirt:softwareVersion›
                    ‹/psirt:devicePSIRT›
                ‹/psirt:DevicePSIRTResponseDTO›
                ‹psirt:DevicePSIRTResponseDTO›
                    ‹psirt:deviceId›3617991‹/psirt:deviceId›
                    ‹psirt:devicePSIRT›
                        ‹psirt:psirtId›148‹/psirt:psirtId›
                        ‹psirt:matchConfidence›Vulnerable‹/psirt:matchConfidence›
                        ‹psirt:matchReason/›
                        ‹psirt:softwareType›IOS‹/psirt:softwareType›
                        ‹psirt:softwareVersion›12.4(9)T7‹/psirt:softwareVersion›
                    ‹/psirt:devicePSIRT›
    ...
    ‹psirt:responseTimestamp›2013-04-02T13:19:33.010-07:00‹/psirt:responseTimestamp›
                ‹psirt:message›
                    ‹psirt:messageType›SUCCESS‹/psirt:messageType›
                    ‹psirt:messageDetail›Request processed successfully‹/psirt:messageDetail›
                ‹/psirt:message›
            ‹/psirt:PSIRTResponseOutput›
        ‹/soapenv:Body›
    ‹/soapenv:Envelope›

getPSIRTDetails

This API call fetches the details for a specific PSIRT.

Request Parameter(s)

Parameter	Required	Type	Description
psirtIds	Yes	string	Id of the PSIRT item. Can be one or any number of PSIRT id's.

Response Parameter(s)

Parameter	Type	Length	Description
psirtId	string	22	PSIRT id of the PSIRT item.
distributionType	string	24	Type of distribution for the PSIRT.
documentNumber	string	30	Document number for the PSIRT.
externalURL	string	4000	External url for the PSIRT.
firstPublished	date	DATE	Date the PSIRT was first published.
headline	string	200	Headline for the PSIRT.
lastUpdated	date	DATE	Date the PSIRT was last updated.
revisionNumber	string	24	Revision number for the PSIRT.

responseTimestamp

Parameter	Type	Length	Description
	date	DATE	The time stamp indicates when this service call was performed.

message[ ]

Parameter	Type	Length	Description
			See Message Format section for more details.
messageType	string	255
messageDetail	string	255

SOAP Request


    POST https://api.cisco.com/pss/v1.0/PSIRTAlertService HTTP/1.1
    Accept-Encoding: gzip,deflate
    Content-Type: text/xml;charset=UTF-8
    SOAPAction: "getPSIRTDetails"
    Authorization: Bearer pmx57ukvwwfwswff2c2fweer
    
    ‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
    xmlns:psir="http://www.cisco.com/PSIRTAlertService"›
        ‹soapenv:Header/›
        ‹soapenv:Body›
            ‹psir:PSIRTDetailsRequestInput›
                ‹psir:psirtIds›
                    ‹!--1 or more repetitions:--›
                    ‹psir:psirtId›308‹/psir:psirtId›
                ‹/psir:psirtIds›
            ‹/psir:PSIRTDetailsRequestInput›
        ‹/soapenv:Body›
    ‹/soapenv:Envelope›

SOAP Response


    HTTP/1.1 200 OK
    Date: Tue, 02 Apr 2013 20:23:18 GMT
    Server: IBM_HTTP_Server
    X-Mashery-Responder: APIX-PROD-01
    Cache-Control: private
    Pragma: private
    Content-Type: text/xml; charset=UTF-8
    Content-Language: en-US
    Cache-Control: max-age=0
    Expires: Tue, 02 Apr 2013 20:23:18 GMT
    Set-Cookie: TOOLS-Loc=tools1.cisco.com; path=/; domain=.cisco.com
    Connection: close
    Transfer-Encoding: chunked
    
    ‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"›
        ‹soapenv:Body›
            ‹psirt:PSIRTDetailsResponseOutput 
            xmlns:psirt="http://www.cisco.com/PSIRTAlertService" 
            xmlns:fn="http://www.cisco.com/FNAlertService" 
            xmlns:hweox="http://www.cisco.com/HwEoxAlertService" 
            xmlns:inv="http://www.cisco.com/InventoryService" 
            xmlns:sweox="http://www.cisco.com/SwEoxAlertService" 
            xmlns:w3c="http://www.w3.org/2001/XMLSchema-instance" 
            xmlns:is="http://www.cisco.com/ISAlertService" 
            xmlns:con="http://www.cisco.com/ContractService"›
                ‹psirt:PSIRTDetailsList›
                    ‹psirt:psirtId›308‹/psirt:psirtId›
                    ‹psirt:distributionType›Security Advisory‹/psirt:distributionType›
                    ‹psirt:documentNumber›112248‹/psirt:documentNumber›
	‹psirt:externalURL›http://www.cisco.com/en/US/products/products_security_advisory09186a0080b95d5a.shtml‹/psirt:externalURL›
                    ‹psirt:firstPublished›2011-09-28T00:00:00.000‹/psirt:firstPublished›
                    ‹psirt:headline›Cisco IOS Software Session Initiation Protocol Denial of Service Vulnerabilities‹/psirt:headline›
                    ‹psirt:lastUpdated›2011-09-30T00:00:00.000‹/psirt:lastUpdated›
                    ‹psirt:revisionNumber›1.1‹/psirt:revisionNumber›
                ‹/psirt:PSIRTDetailsList›

	‹psirt:responseTimestamp›2013-04-02T13:23:18.831-07:00‹/psirt:responseTimestamp›
                ‹psirt:message›
                    ‹psirt:messageType›SUCCESS‹/psirt:messageType›
                    ‹psirt:messageDetail›Request processed successfully‹/psirt:messageDetail›
                ‹/psirt:message›
            ‹/psirt:PSIRTDetailsResponseOutput›
        ‹/soapenv:Body›
    ‹/soapenv:Envelope›

PSS API Services - PSIRT Service

PSIRT Service

getPSIRT

Request Parameter(s)

Response Parameter(s)

SOAP Request

SOAP Response

getPSIRTDetails

Request Parameter(s)

Response Parameter(s)

SOAP Request

SOAP Response