Pingdom API / function Auth_logout

Description

Logs out the user and destroys its session.

Arguments

stringAPIKey (Required)

API key. You will find your API key in the 'Pingdom API' section of Pingdom Panel.

stringsessionId (Required)

Session ID obtained by calling Auth_login function.

Return value

Auth_LogoutResponselogoutResponse

Response object of Auth_logout function. It contains only one field for status of the performed operation.

Example request

				
<soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
	<q1:Auth_logout xmlns:q1="urn:methods">
		<APIKey xsi:type="xsd:string">abcdefgh0123456789abcdefgh</APIKey>
		<sessionId xsi:type="xsd:string">9b47ca0d08b030264d516abbf72fe387</sessionId>
	</q1:Auth_logout>
</soap:Body>

Example response

				
<SOAP-ENV:Body>
	<ns1:logoutResponse>
		<return xsi:type="ns2:Auth_LogoutResponse">
			<status xsi:type="xsd:int">0</status>
		</return>
	</ns1:logoutResponse>
</SOAP-ENV:Body>