PowerShell Requires Chilkat v11.0.0+

REST through SSH Tunnel

See more REST Examples

Demonstrates how to connect through an SSH Tunnel (via port-forwarding) to make REST API calls. PowerShell

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $false

#  This example requires the Chilkat API to have been previously unlocked.
#  See Global Unlock Sample for sample code.

$tunnel = New-Object Chilkat.Socket

$sshHostname = "sftp.example.com"
$sshPort = 22

#  Connect to an SSH server and establish the SSH tunnel:
$success = $tunnel.SshOpenTunnel($sshHostname,$sshPort)
if ($success -eq $false) {
    $($tunnel.LastErrorText)
    exit
}

#  Authenticate with the SSH server via a login/password
#  or with a public key.
#  This example demonstrates SSH password authentication.
$success = $tunnel.SshAuthenticatePw("mySshLogin","mySshPassword")
if ($success -eq $false) {
    $($tunnel.LastErrorText)
    exit
}

#   OK, the SSH tunnel is setup.  Now open a channel within the tunnel.
#   (Any number of channels may be created from the same SSH tunnel.
#   Multiple channels may coexist at the same time.)

#  This example connects to a REST server through the SSH tunnel.
#  It will connect to the Amazon AWS service for this example.
$rest = New-Object Chilkat.Rest

$bTls = $true
$port = 443
$maxWaitMs = 5000

#  This returns a socket object that is a single channel within the SSH tunnel.
$channel = New-Object Chilkat.Socket
$success = $tunnel.SshNewChannel("s3.amazonaws.com",$port,$bTls,$maxWaitMs,$channel)
if ($success -eq $false) {
    $($tunnel.LastErrorText)
    exit
}

#  Use the connection.  (This connection is a TLS running on an SSH channel through an SSH tunnel.
#  In other words, TLS is wrapped within the SSH tunnel.)
$success = $rest.UseConnection($channel,$true)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

#  Provide AWS credentials for the REST call.
$authAws = New-Object Chilkat.AuthAws
$authAws.AccessKey = "AWS_ACCESS_KEY"
$authAws.SecretKey = "AWS_SECRET_KEY"
$authAws.ServiceName = "s3"
$success = $rest.SetAuthAws($authAws)

#  List all buckets for the account...
$responseXml = $rest.FullRequestNoBody("GET","/")
if ($rest.LastMethodSuccess -ne $true) {
    $($rest.LastErrorText)
    exit
}

$xml = New-Object Chilkat.Xml
$success = $xml.LoadXml($responseXml)

#  Show the full XML returned.
$($xml.GetXml())

#  Iterate over the buckets, showing each bucket name.
$success = $xml.FindChild2("Buckets")
if ($xml.FirstChild2() -eq $true) {
    $($xml.GetChildContent("Name"))
    while (($xml.NextSibling2() -eq $true)) {
        $($xml.GetChildContent("Name"))
    }

}

#  Move the internal pointer back to the root node.
$xml.GetRoot2()