{"id":610,"date":"2025-02-28T17:39:38","date_gmt":"2025-02-28T16:39:38","guid":{"rendered":"https:\/\/digitalmaterial.ch\/blog\/?p=610"},"modified":"2025-02-28T17:49:54","modified_gmt":"2025-02-28T16:49:54","slug":"cisco-meraki-gather-license-information-through-the-api","status":"publish","type":"post","link":"https:\/\/digitalmaterial.ch\/blog\/cisco-meraki-gather-license-information-through-the-api\/","title":{"rendered":"Cisco Meraki – Gather license information through the API"},"content":{"rendered":"\n

When managing multiple organizations and networks, it can be difficult to get an overview of all licenses. Instead of manually reviewing each organization, you can leverage the API to gather the necessary information. For example, this can be used to store and track license expirations as assets in a CRM.<\/p>\n\n\n\n

API User<\/h2>\n\n\n\n

Create an administrator account with read privileges for the organization and add it to the networks you want to gather information from. In the profile settings, generate a new API key and securely store it for later use.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

License overview<\/h2>\n\n\n\n

Using PowerShell, we can easily export all license-related information to a CSV. Save this script as a .ps1<\/code> file in a directory.<\/p>\n\n\n\n

ShellScript<\/span><\/path><\/path><\/svg><\/span>
Param(<\/span><\/span>\n    [Parameter(Mandatory = <\/span>$true<\/span>)]<\/span><\/span>\n    [string]<\/span>$BearerToken<\/span><\/span>\n)<\/span><\/span>\n<\/span>\n# Define API headers<\/span><\/span>\n$headers<\/span> = New-Object <\/span>"System.Collections.Generic.Dictionary[[String],[String]]"<\/span><\/span>\n$headers<\/span>.Add(<\/span>"datatype"<\/span>,<\/span> <\/span>"json"<\/span>)<\/span><\/span>\n$headers<\/span>.Add(<\/span>"Authorization"<\/span>,<\/span> <\/span>"Bearer <\/span>$BearerToken<\/span>"<\/span>)  <\/span><\/span>\n<\/span>\n# Get all organizations<\/span><\/span>\n$orgs<\/span> = Invoke-WebRequest <\/span>`<\/span><\/span>\n    <\/span>-UseBasicParsing<\/span> `<\/span><\/span>\n    <\/span>-Uri<\/span> <\/span>"https:\/\/api.meraki.com\/api\/v1\/organizations"<\/span> <\/span>`<\/span><\/span>\n    <\/span>-Method<\/span> GET `<\/span><\/span>\n    <\/span>-Headers<\/span> <\/span>$headers<\/span> | <\/span>ConvertFrom-Json<\/span><\/span>\n<\/span>\n# Initialize list to store results<\/span><\/span>\n$licenseList<\/span> = <\/span>@<\/span>()<\/span><\/span>\n<\/span>\n# Loop through each organization to get license info<\/span><\/span>\nforeach (<\/span>$org<\/span> <\/span>in<\/span> <\/span>$orgs<\/span>) {<\/span><\/span>\n    <\/span>$orgId<\/span> <\/span>=<\/span> <\/span>$org<\/span>.id<\/span><\/span>\n    <\/span>Write-Host<\/span> <\/span>"Fetching license info for Organization ID: <\/span>$orgId<\/span>"<\/span><\/span>\n<\/span>\n    <\/span># Fetch licenses overview<\/span><\/span>\n    <\/span>try<\/span> <\/span>{<\/span><\/span>\n        <\/span>$licensesOverview<\/span> <\/span>=<\/span> <\/span>Invoke-WebRequest<\/span> <\/span>`<\/span><\/span>\n            <\/span>-UseBasicParsing<\/span> `<\/span><\/span>\n            <\/span>-Uri<\/span> <\/span>"https:\/\/api.meraki.com\/api\/v1\/organizations\/<\/span>$orgId<\/span>\/licenses\/overview"<\/span> <\/span>`<\/span><\/span>\n            <\/span>-Method<\/span> GET `<\/span><\/span>\n            <\/span>-Headers<\/span> <\/span>$headers<\/span> | <\/span>ConvertFrom-Json<\/span><\/span>\n    }<\/span><\/span>\n    <\/span>catch<\/span> <\/span>{<\/span><\/span>\n        <\/span>Write-Host<\/span> <\/span>"Failed to fetch licenses overview for Org ID <\/span>$orgId<\/span>. Skipping..."<\/span><\/span>\n        <\/span>continue<\/span><\/span>\n    }<\/span><\/span>\n<\/span>\n    <\/span># Parse Date<\/span><\/span>\n    <\/span>$expirationDateRaw<\/span> <\/span>=<\/span> <\/span>$licensesOverview<\/span>.expirationDate<\/span><\/span>\n    <\/span># fallback if parsing fails<\/span><\/span>\n    <\/span>$expirationDateFormatted<\/span> <\/span>=<\/span> <\/span>$expirationDateRaw<\/span><\/span>\n<\/span>\n    <\/span>if<\/span> (<\/span>$expirationDateRaw<\/span>) {<\/span><\/span>\n        <\/span># Remove trailing ' UTC' if present<\/span><\/span>\n        <\/span>$expirationDateTrimmed<\/span> <\/span>=<\/span> <\/span>$expirationDateRaw<\/span> <\/span>-replace<\/span> <\/span>' UTC$',<\/span> <\/span>''<\/span><\/span>\n        <\/span>try<\/span> <\/span>{<\/span><\/span>\n            <\/span># Let PowerShell parse the date automatically (handles single\/double digit days)<\/span><\/span>\n            <\/span>$parsedDate<\/span> <\/span>=<\/span> [DateTime]::Parse(<\/span>$expirationDateTrimmed<\/span>)<\/span><\/span>\n            <\/span>$expirationDateFormatted<\/span> <\/span>=<\/span> <\/span>$parsedDate<\/span>.ToString<\/span>(<\/span>"yyyy-MM-dd HH:mm:ss"<\/span>)<\/span><\/span>\n        }<\/span><\/span>\n        <\/span>catch<\/span> <\/span>{<\/span><\/span>\n            <\/span># If parsing fails, just keep $expirationDateFormatted as the raw string<\/span><\/span>\n        }<\/span><\/span>\n    }<\/span><\/span>\n<\/span>\n    <\/span># Fetch coterm licenses<\/span><\/span>\n    <\/span>try<\/span> <\/span>{<\/span><\/span>\n        <\/span>$cotermLicenses<\/span> <\/span>=<\/span> <\/span>Invoke-WebRequest<\/span> <\/span>`<\/span><\/span>\n            <\/span>-UseBasicParsing<\/span> `<\/span><\/span>\n            <\/span>-Uri<\/span> <\/span>"https:\/\/api.meraki.com\/api\/v1\/organizations\/<\/span>$orgId<\/span>\/licensing\/coterm\/licenses"<\/span> <\/span>`<\/span><\/span>\n            <\/span>-Method<\/span> GET `<\/span><\/span>\n            <\/span>-Headers<\/span> <\/span>$headers<\/span> | <\/span>ConvertFrom-Json<\/span><\/span>\n    }<\/span><\/span>\n    <\/span>catch<\/span> <\/span>{<\/span><\/span>\n        <\/span>Write-Host<\/span> <\/span>"Failed to fetch coterm licenses for Org ID <\/span>$orgId<\/span>. Skipping..."<\/span><\/span>\n        <\/span>continue<\/span><\/span>\n    }<\/span><\/span>\n<\/span>\n    <\/span># Filter valid license keys: where expired is false and invalidated is false<\/span><\/span>\n    <\/span>$validLicenseKeys<\/span> <\/span>=<\/span> <\/span>$cotermLicenses<\/span> |<\/span><\/span>\n    <\/span>Where-Object<\/span> <\/span>{<\/span> <\/span>$_<\/span>.expired<\/span> <\/span>-eq<\/span> <\/span>$false<\/span> <\/span>-and<\/span> <\/span>$_<\/span>.invalidated<\/span> <\/span>-eq<\/span> <\/span>$false<\/span> <\/span>}<\/span> |<\/span><\/span>\n    <\/span>Select-Object<\/span> <\/span>-ExpandProperty<\/span> <\/span>key<\/span> <\/span>-ErrorAction<\/span> <\/span>SilentlyContinue<\/span><\/span>\n    <\/span># Convert $null to empty array to avoid errors<\/span><\/span>\n    <\/span>$validLicenseKeys<\/span> <\/span>=<\/span> <\/span>@<\/span>(<\/span>$validLicenseKeys<\/span>)<\/span><\/span>\n    <\/span>$validLicenseKeysString<\/span> <\/span>=<\/span> [string]::Join(<\/span>", "<\/span>,<\/span> <\/span>$validLicenseKeys<\/span>)<\/span><\/span>\n<\/span>\n    <\/span># Filter expired\/invalid license keys: where expired is true or invalidated is true<\/span><\/span>\n    <\/span>$invalidLicenseKeys<\/span> <\/span>=<\/span> <\/span>$cotermLicenses<\/span> |<\/span><\/span>\n    <\/span>Where-Object<\/span> <\/span>{<\/span> <\/span>$_<\/span>.expired<\/span> <\/span>-eq<\/span> <\/span>$true<\/span> <\/span>-or<\/span> <\/span>$_<\/span>.invalidated<\/span> <\/span>-eq<\/span> <\/span>$true<\/span> <\/span>}<\/span> |<\/span><\/span>\n    <\/span>Select-Object<\/span> <\/span>-ExpandProperty<\/span> <\/span>key<\/span> <\/span>-ErrorAction<\/span> <\/span>SilentlyContinue<\/span><\/span>\n    <\/span># Convert $null to empty array to avoid errors<\/span><\/span>\n    <\/span>$invalidLicenseKeys<\/span> <\/span>=<\/span> <\/span>@<\/span>(<\/span>$invalidLicenseKeys<\/span>)<\/span><\/span>\n    <\/span>$invalidLicenseKeysString<\/span> <\/span>=<\/span> [string]::Join(<\/span>", "<\/span>,<\/span> <\/span>$invalidLicenseKeys<\/span>)<\/span><\/span>\n<\/span>\n    <\/span># Create a custom object to store the desired details<\/span><\/span>\n    <\/span>$licenseData<\/span> <\/span>=<\/span> [PSCustomObject]@{<\/span><\/span>\n        <\/span>OrgId<\/span>                <\/span>=<\/span> <\/span>$orgId<\/span><\/span>\n        <\/span>OrgName<\/span>              <\/span>=<\/span> <\/span>$org<\/span>.name<\/span><\/span>\n        <\/span>OverviewStatus<\/span>       <\/span>=<\/span> <\/span>$licensesOverview<\/span>.status<\/span><\/span>\n        <\/span>ExpirationDate<\/span>       <\/span>=<\/span> <\/span>$expirationDateFormatted<\/span><\/span>\n        <\/span>LicensedDeviceCounts<\/span> <\/span>=<\/span> ($licensesOverview.licensedDeviceCounts | <\/span>ConvertTo-Json<\/span> <\/span>-Compress<\/span>)<\/span><\/span>\n        <\/span>ValidLicenseKeys<\/span>     <\/span>=<\/span> <\/span>$validLicenseKeysString<\/span><\/span>\n        <\/span>InvalidLicenseKeys<\/span>   <\/span>=<\/span> <\/span>$invalidLicenseKeysString<\/span><\/span>\n    }<\/span><\/span>\n<\/span>\n    <\/span>$licenseList<\/span> <\/span>+=<\/span> <\/span>$licenseData<\/span><\/span>\n}<\/span><\/span>\n<\/span>\n# Export to CSV<\/span><\/span>\n$csvPath<\/span> = <\/span>"<\/span>$PSScriptRoot<\/span>\\meraki_license.csv"<\/span><\/span>\n$licenseList<\/span> | <\/span>Export-Csv<\/span> <\/span>-Path<\/span> <\/span>$csvPath<\/span> <\/span>-NoTypeInformation<\/span> <\/span>-Encoding<\/span> <\/span>UTF8<\/span><\/span>\n<\/span>\nWrite-Host<\/span> <\/span>"Export complete! CSV saved to <\/span>$csvPath<\/span>"<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
To run the script, open PowerShell and navigate to the directory where the script is located. Use the -BearerToken<\/code> parameter to pass the API token.<\/p>\n\n\n\n
ShellScript<\/span><\/path><\/path><\/svg><\/span>
.<\/span>\\get_all_devices_claimed_at.ps1 <\/span>-BearerToken<\/span> <\/span>YOURTOKENHERE<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
The script will generate a .csv<\/code> file in the same directory where the script is stored. The CSV will include the OrgID, Name, Status, Expiration Date, Device Count, Valid Licenses, and Invalid Licenses.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
<\/p>\n","protected":false},"excerpt":{"rendered":"
When managing multiple organizations and networks, it can be difficult to get an overview of all licenses. Instead of manually reviewing each organization, you can leverage the API to gather the necessary information. For example, this can be used to store and track license expirations as assets in a CRM. API User Create an administrator […]<\/p>\n","protected":false},"author":4,"featured_media":640,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-610","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-allgemein"],"_links":{"self":[{"href":"https:\/\/digitalmaterial.ch\/blog\/wp-json\/wp\/v2\/posts\/610","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/digitalmaterial.ch\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/digitalmaterial.ch\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/digitalmaterial.ch\/blog\/wp-json\/wp\/v2\/users\/4"}],"replies":[{"embeddable":true,"href":"https:\/\/digitalmaterial.ch\/blog\/wp-json\/wp\/v2\/comments?post=610"}],"version-history":[{"count":4,"href":"https:\/\/digitalmaterial.ch\/blog\/wp-json\/wp\/v2\/posts\/610\/revisions"}],"predecessor-version":[{"id":639,"href":"https:\/\/digitalmaterial.ch\/blog\/wp-json\/wp\/v2\/posts\/610\/revisions\/639"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/digitalmaterial.ch\/blog\/wp-json\/wp\/v2\/media\/640"}],"wp:attachment":[{"href":"https:\/\/digitalmaterial.ch\/blog\/wp-json\/wp\/v2\/media?parent=610"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/digitalmaterial.ch\/blog\/wp-json\/wp\/v2\/categories?post=610"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/digitalmaterial.ch\/blog\/wp-json\/wp\/v2\/tags?post=610"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}