Tag api

Alright, so you are interested in managing Syncplify Server! V6 (the upcoming version, currently in development at the time this post is being written) via PowerShell.

You’re in luck. We have a PowerShell Module for that. But how do you get started?

Here’s a bare-bone micro quickstart for you. More will come with the official documentation when it’s ready.

Let’s take a look at the configuration first:

Pretty empty, uh? So, with Get-SS6Configuration you can see what’s in your PowerShell Module’s current configuration. Let’s populate it a little bit.

First of all, you’ll have to set your API base URL, your SuperAdmin (or Admin, it depends on what you want to do) username and password, and – if you’re using a self-signed certificate – you’ll also have to skip the certificate’s validation. You can do all of that with this command:

Set-SS6Configuration -Username "sa" -Password "your_password_here" -BaseUrl "https://127.0.0.1:6443/api/v1" -SkipCertificateCheck

Now let’s see what happens when we call Get-SS6Configuration again:

Good, but we still need an Access Token to call the actual server’s API, and in order to get such Token we need to log in (which returns the token) and then set the token in the above configuration. Fortunately PowerShell allows us to do so with just 2 lines of code:

$res = Invoke-SS6SaLogin
Set-SS6Configuration -AccessToken $res.token

We’re good to go. Since we logged in as a SuperAdmin (by calling Invoke-SS6SaLogin) we can now invoke any SuperAdmin API as documented. Let’s try to acquire our own SuperAdmin profile for example:

This, together with the documentation of every module function you find in our PowerShell Module’s GitHub repository, should get you started very quickly and easily.