API to API Scripts

RyanTomsHelpDesk

Looking at the API it should be pretty straight forward to create either PowerShell or python scripts that store information gotten from one set of API's and then use it to generate Assets in IT Flow for each customer. So, while the path is there, it can definitely be a bit boggling when you're not used to or have never made such scripts before.

I'm making this thread to be as much a request thread as it will be where I post what I'm coming up with for others to look at and comment on.

Right now, I'm looking at Ubiquiti's API and MSP360's. UniFi API Version 0.1 | UniFi API (ui.com) Managed BackupAPI (mspbackups.com). I if I can get those two going to start, I can later work on other services I use.

I should also probably mention I will likely focus on Python scripts so I can run them in an LXC. But then I guess powershell is multiplatform now as well so that may not be necessary.

wrongecho

Hey @RyanTomsHelpDesk

Please do share any scripts you create as they will no doubt be useful for others 🙂

We currently have this repo too - itflow-org/itflow-api-powershell/tree/main/assets

RyanTomsHelpDesk

Thanks wrongecho!

I started their first figuring that's where the fun starts. Depending how things go and what people think I may do a pull request to add any scripts I work on.

RyanTomsHelpDesk

Modified the existing Script from the repo.

This works with Unifi's API. Definitely requires more tweaking. I commented out the section for asset checking, when I ran with it not commented out it overwrote some assets I had imported using a CSV. Need to assess what that's about.

I also just noticed there isn't a delete asset button, only archive. A delete button should be added.

IF I can figure a good way of retrieve the host ids and then line it up with Client IDs in IT Flow this can be setup to update any and all controllers in a unifi.ui.com.

# UniFi API access

# Example script to sync data from a single site into a single ITFlow client

# This could be adapted to sync multiple sites to multiple clients, but would need a way to define which UniFi site ID relates to which client

# (see: https://gcits.com/knowledge-base/sync-unifi-sites-with-it-glue/ for inspiration)

#######################################################################################################

# Functions

# Function to check if a string ($itfAssetID) contains only numbers

function Is-Numeric ($Value) {

return $Value -match "^[\d\.]+$"

}

#######################################################################################################

# Unifi Controller Login Base URI

$unfURL = 'https://api.ui.com/ea'

# Identifier of the site in UniFi.

$unfHostID = ''

# UniFi Auth Key

$unfauthkey = ''

$unfheader = @{

'X-API-KEY' = $unfauthkey

'Accept' = 'application/json'

}

#######################################################################################################

# ITFlow Settings

# https://itflow.org/docs.php?doc=api

# ITFlow Base URL

$itfBaseURL = ''

# ITFlow API Key

$itfAPIKey = ''

# ITFlow Client ID (for adding assets)

$itfClientID = '2'

$itfReadURL = $itfBaseURL + "/api/v1/assets/read.php?api_key=" + $itfAPIKey

$itfCreateURL = $itfBaseURL + "/api/v1/assets/create.php"

$itfUpdateURL = $itfBaseURL + "/api/v1/assets/update.php"

######################################################################################################

# UniFi Login

#$unfLogin = Invoke-RestMethod -Method GET -Uri "$unfURL/hosts" -Headers $unfheader -ErrorAction Stop

# Check UniFi login success

#if($unfLogin.meta.rc -notContains "ok" -or $unfLogin.meta.rc -contains "error"){

#Write-Host "UNIFI - Something went wrong connecting to $($unfURL) as $($unfUsername)"

#Write-Host $unfLogin

#Exit

#}

Write-Host -ForegroundColor Green "UNIFI - Successfully authenticated."

# ITFlow credential check

$iftLoginTest = Invoke-RestMethod -Method GET -Uri $itfReadURL -ErrorAction Stop

if(!$?){

Write-Host "ITFLOW - Something went wrong connecting to $itfReadURL"

Exit

}

Write-Host -ForegroundColor Green "ITFLOW - Successfully authenticated."

Write-Host

Write-Host "------"

Write-Host

# Get all Devices for this site

$unfDevices = Invoke-RestMethod -Method Get -Uri "$unfURL/devices?hostIds[]=$unfHostID" -Headers $unfheader

foreach ($AP in $unfDevices.data.devices) {

$urlName = $itfReadURL + "&asset_name=" + $AP.name

$urlSerial = $itfReadURL + "&asset_serial=" + $AP.serial

# Variables

$itfAssetID = $false

$name = $AP.name

$serial = $AP.id

$model = $AP.model

$os = $AP.version

$ip = $AP.ip

$mac = $AP.mac

# ITFlow - query via asset serial number

$itfAssetSN = Invoke-RestMethod -Method GET -Uri "$urlSerial"

# ITFlow - query via asset name

$itfAssetName = Invoke-RestMethod -Method GET -Uri "$urlName"

# Checks to determine the ITFlow asset ID

# if($itfAssetSN.success -eq "True"){

# $itfAssetID = $itfAssetSN.data.asset_id

# $itfAssetClientID = $itfAssetSN.data.asset_client_id

# #Write-Host -ForegroundColor Green $AP.Name "lookup success via SN. ITFlow ID" $itfAssetID

# }

# elseif($itfAssetName.success -eq "True"){

# $itfAssetID = $itfAssetName.data.asset_id

# $itfAssetClientID = $itfAssetName.data.asset_client_id

# #Write-Host -ForegroundColor Green $AP.Name "lookup success via name. ITFlow ID:" $itfAssetID

# }

#

# # Check if asset already exists (if ITFlow knows about the AP)

#

# if(Is-Numeric $itfAssetID){

# # We found the asset - update details

#

# Write-Host -ForegroundColor Green "Found asset" $name $serial "as ITFlow ID" $itfAssetID " - updating it.."

#

# # Asset attributes to be updated

# $body = @"

# {

# "api_key" : "$itfAPIKey",

# "asset_id" : "$itfAssetID",

# "asset_name" : "$name",

# "asset_type" : "Access Point",

# "asset_make" : "UniFi",

# "asset_model" : "$model",

# "asset_serial" : "$serial",

# "asset_os" : "$os",

# "asset_ip" : "$ip",

# "asset_mac" : "$mac",

# "client_id" : "$itfAssetClientID"

# }

#"@ # This seemingly cannot be indented..

#

# # Update asset

# Invoke-RestMethod -Method Post -Uri $itfUpdateURL -Body $body

# }

# else{

# Couldn't find asset, add it

Write-Host -ForegroundColor Yellow "Could not find asset" $AP.Name $AP.Serial "- adding it.."

# New asset attributes

$body = @"

{

"api_key" : "$itfAPIKey",

"asset_name" : "$name",

"asset_type" : "Access Point",

"asset_make" : "UniFi",

"asset_model" : "$model",

"asset_serial" : "$serial",

"asset_os" : "$os",

"asset_ip" : "$ip",

"asset_mac" : "$mac",

"asset_notes" : "Added via script",

"client_id" : "$itfClientID"

}

"@ # This seemingly cannot be indented..

# Add asset

Invoke-RestMethod -Method Post -Uri $itfCreateURL -Body $body

}

RyanTomsHelpDesk

There's also probably some way to dynamically set the type of item it is based on the model number by being clever with @ groupings and other such things I am less familiar with.

What I do know is by copying scripts from other people and basing new scripts on them. Making a note for myself here that this may be a script I can pull some inspiration, configuration from knowledge-base/ITGlue/UniFiSync/UniFiITGlueSync.ps1 at master · GCITS/knowledge-base · GitHub

RyanTomsHelpDesk

It looks like trying to run the script on a Software controller host id does not work. This appears to be a limitation on Unifi's API.

If invoke request is run manually and recorded to a file, no devices are listed from the get command for a software controller. It works fine on a hardware controller however.

RyanTomsHelpDesk

Before I commit the ultimate sacrilege of unlimited if else statements for determining what type a device is by model here is the fixed script with updating assets re-enabled. I figured out I forget to change serial to mac in other place which is why things broke last time. Also for updates I removed it setting the type to Access Points if it gets changed after the initial add it will just change it back.

# UniFi API access

# Example script to sync data from a single site into a single ITFlow client

# This could be adapted to sync multiple sites to multiple clients, but would need a way to define which UniFi site ID relates to which client

# (see: https://gcits.com/knowledge-base/sync-unifi-sites-with-it-glue/ for inspiration)

#######################################################################################################

# Functions

# Function to check if a string ($itfAssetID) contains only numbers

function Is-Numeric ($Value) {

return $Value -match "^[\d\.]+$"

}

#######################################################################################################

# UniFi Settings

# https://blog.darrenjrobinson.com/accessing-your-ubiquiti-unifi-network-configuration-with-powershell/

# Unifi Controller Login Base URI

$unfURL = 'https://api.ui.com/ea'

# Identifier of the site in UniFi. Set to default for the default site

$unfHostID = ''

# UniFi Admin Username

$unfauthkey = ''

$unfheader = @{

'X-API-KEY' = $unfauthkey

'Accept' = 'application/json'

}

#######################################################################################################

# ITFlow Settings

# https://itflow.org/docs.php?doc=api

# ITFlow Base URL

$itfBaseURL = ''

# ITFlow API Key

$itfAPIKey = ''

# ITFlow Client ID (for adding assets)

$itfClientID = ''

$itfReadURL = $itfBaseURL + "/api/v1/assets/read.php?api_key=" + $itfAPIKey

$itfCreateURL = $itfBaseURL + "/api/v1/assets/create.php"

$itfUpdateURL = $itfBaseURL + "/api/v1/assets/update.php"

######################################################################################################

# UniFi Login

#$unfLogin = Invoke-RestMethod -Method GET -Uri "$unfURL/hosts" -Headers $unfheader -ErrorAction Stop

# Check UniFi login success

#if($unfLogin.meta.rc -notContains "ok" -or $unfLogin.meta.rc -contains "error"){

#Write-Host "UNIFI - Something went wrong connecting to $($unfURL) as $($unfUsername)"

#Write-Host $unfLogin

#Exit

#}

Write-Host -ForegroundColor Green "UNIFI - Successfully authenticated."

# ITFlow credential check

$iftLoginTest = Invoke-RestMethod -Method GET -Uri $itfReadURL -ErrorAction Stop

if(!$?){

Write-Host "ITFLOW - Something went wrong connecting to $itfReadURL"

Exit

}

Write-Host -ForegroundColor Green "ITFLOW - Successfully authenticated."

Write-Host

Write-Host "------"

Write-Host

# Get all Devices for this site

$unfDevices = Invoke-RestMethod -Method Get -Uri "$unfURL/devices?hostIds[]=$unfHostID" -Headers $unfheader

foreach ($AP in $unfDevices.data.devices) {

$urlName = $itfReadURL + "&asset_name=" + $AP.name

$urlSerial = $itfReadURL + "&asset_serial=" + $AP.id

# Variables

$itfAssetID = $false

$name = $AP.name

$serial = $AP.id

$model = $AP.model

$os = $AP.version

$ip = $AP.ip

$mac = $AP.mac

# ITFlow - query via asset serial number

$itfAssetSN = Invoke-RestMethod -Method GET -Uri "$urlSerial"

# ITFlow - query via asset name

$itfAssetName = Invoke-RestMethod -Method GET -Uri "$urlName"

# Checks to determine the ITFlow asset ID

if($itfAssetSN.success -eq "True"){

$itfAssetID = $itfAssetSN.data.asset_id

$itfAssetClientID = $itfAssetSN.data.asset_client_id

#Write-Host -ForegroundColor Green $AP.Name "lookup success via SN. ITFlow ID" $itfAssetID

}

elseif($itfAssetName.success -eq "True"){

$itfAssetID = $itfAssetName.data.asset_id

$itfAssetClientID = $itfAssetName.data.asset_client_id

#Write-Host -ForegroundColor Green $AP.Name "lookup success via name. ITFlow ID:" $itfAssetID

}

# Check if asset already exists (if ITFlow knows about the AP)

if(Is-Numeric $itfAssetID){

# We found the asset - update details

Write-Host -ForegroundColor Green "Found asset" $name $serial "as ITFlow ID" $itfAssetID " - updating it.."

# Asset attributes to be updated

$body = @"

{

"api_key" : "$itfAPIKey",

"asset_id" : "$itfAssetID",

"asset_name" : "$name",

"asset_make" : "UniFi",

"asset_model" : "$model",

"asset_serial" : "$serial",

"asset_os" : "$os",

"asset_ip" : "$ip",

"asset_mac" : "$mac",

"client_id" : "$itfAssetClientID"

}

"@ # This seemingly cannot be indented..

# Update asset

Invoke-RestMethod -Method Post -Uri $itfUpdateURL -Body $body

}

else{

# Couldn't find asset, add it

Write-Host -ForegroundColor Yellow "Could not find asset" $AP.Name $AP.Serial "- adding it.."

# New asset attributes

$body = @"

{

"api_key" : "$itfAPIKey",

"asset_name" : "$name",

"asset_type" : "Access Point",

"asset_make" : "UniFi",

"asset_model" : "$model",

"asset_serial" : "$serial",

"asset_os" : "$os",

"asset_ip" : "$ip",

"asset_mac" : "$mac",

"asset_notes" : "Added via script",

"client_id" : "$itfClientID"

}

"@ # This seemingly cannot be indented..

# Add asset

Invoke-RestMethod -Method Post -Uri $itfCreateURL -Body $body

}

# Blank line for console output readability

Write-Host

}

MMRHC

@RRyanTomsHelpDesk

Was curious if you were still pursuing this. I'm trying to create a script to pull user info from 365 and write to ITFlow as contacts. The push/pull part I think I am able to get but the new vs update logic is over my head. I'm attempting to do this in Powershell.

wrongecho

@MMRHC - Is this helpful?

Contact that doesn't exist:

https://demo.itflow.org/api/v1/contacts/read.php?contact_email=someone@example.com&api_key=RY8Js4xzg2bZu0HnzbMsGOelCUyv5wJQzSA9SCuH1O80NHuf8Lv0vDdDlVmv0n9KKmI0BzKgnezO4fQc0IyuTGx2KwMnCp0OxlBnHyjeMcjnL0JWfRrvvi7OqBX6wt2BadT2pa8zj0EIqsXI1lE1B2zySTPp

{"success":"False","message":"No resource (for this client and company) with the specified parameter(s)."}

==================

Contact that does exist:

https://demo.itflow.org/api/v1/contacts/read.php?contact_email=does-exist@example.com&api_key=RY8Js4xzg2bZu0HnzbMsGOelCUyv5wJQzSA9SCuH1O80NHuf8Lv0vDdDlVmv0n9KKmI0BzKgnezO4fQc0IyuTGx2KwMnCp0OxlBnHyjeMcjnL0JWfRrvvi7OqBX6wt2BadT2pa8zj0EIqsXI1lE1B2zySTPp

{"success":"True","count":1,"data":[
 {"0":"273","contact_id":"273","1":"Does exist","contact_name":"Does exist",