SWsoft SiteBuilder Integration API v3.2 Reference

SystemWebService.GetSshKey Method 

 [This is preliminary documentation and subject to change.]

Get SSH key required for VPS publishing procedures. Not used in Windows version, required for integration API compatibility with new versions of SiteBuilder for Unix.

[C#]
public string GetSshKey(
   SshProtocol protocol,
   bool forceGenerate
);

Parameters

protocol
Type of SSH protocol requested key
forceGenerate
true - new key will be generated. false - stored key will be used (if it exists). Otherwise, a new key will be generated

Return Value

Windows version of API always returns null

Example SOAP 1.1

Request
POST /ServiceFacade/version_3_2/SystemWebService.asmx HTTP/1.1
Host: sitebuilder.swsoft.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://swsoft.com/SiteBuilder/SystemService/v_3_2/GetSshKey"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <CredentialsSoapHeader xmlns="http://swsoft.com/SiteBuilder/SystemService/v_3_2">
      <Login>string</Login>
      <Password>string</Password>
    </CredentialsSoapHeader>
  </soap:Header>
  <soap:Body>
    <GetSshKey xmlns="http://swsoft.com/SiteBuilder/SystemService/v_3_2">
      <protocol>SSH or SSH2</protocol>
      <forceGenerate>boolean</forceGenerate>
    </GetSshKey>
  </soap:Body>
</soap:Envelope>
Response
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetSshKeyResponse xmlns="http://swsoft.com/SiteBuilder/SystemService/v_3_2">
      <GetSshKeyResult>string</GetSshKeyResult>
    </GetSshKeyResponse>
  </soap:Body>
</soap:Envelope>

See Also

SystemWebService Web Service | Web services