Skip to content
Sign in

Jira Service Management

API

Jira Service Management is an API integration. Connect it before you export a file. If you can’t, the export at the end of this page uses the JSM Discovery console or the Atlassian Assets REST API to produce a CSV of devices and installed software.

Create an API token for an Atlassian account that can view Assets objects on the site. Open Atlassian account security, create a token, and copy it. It is shown once.

The token can do whatever that account can do. The account needs the Assets User role in AdminHub, and the Object schema users role, or higher, on each schema Licenseware should read. Object viewer is not enough: it only shows object data in the Confluence macro. See Assets roles and permissions. Object reads are documented on the Assets object API.

  1. Open Datasources from the sidebar and click Jira Service Management Assets.
  2. Click Connect. Documentation is at the top right of the source page.
  3. Fill the required fields. Each one is marked with *.
    • Site URL. The placeholder is https://acme.atlassian.net.
    • Email. This is the Atlassian account email.
    • API Token
  4. Verify connection and Save credentials stay disabled until every required field is filled. Click Verify connection first, then Save credentials.

Jira Service Management Assets on Datasources, Connect, with Site URL, Email, API Token, Documentation, Cancel, Verify connection and Save credentials

See Data sources for how to check a connection.

JSM Discovery automatically scans your network to identify hardware and installed software across endpoints. The relevant data sources are:

  • Assets (Configuration Items / CIs): Records of devices and related properties.
  • Discovered Applications: Lists of software installed on each device.
  • Jira Assets (Insight Schema): Central CMDB where discovered data is stored.
  • Jira REST API (Assets/Insight): Enables programmatic retrieval of asset and application data.
  • Access to Jira Service Management with Assets and Discovery modules enabled.
  • Permission to view and export data from the relevant Insight Schema.
  • Completed Discovery scans (ensure all agents have reported recently).
  • Access to Reports or Object View → Export capability.
  • Administrative or API access to Atlassian Assets (formerly Insight).
  • API token or credentials with read-only access.
  • Access to the Atlassian REST API endpoint (e.g. https://yourdomain.atlassian.net/rest/insight/1.0).
  • PowerShell or curl environment to execute API queries.

Recommended Query or Method

You can extract data via the Assets console or the Atlassian REST API.

This is the simplest method for small to medium datasets.

  1. Log in to Jira Service Management (Cloud or Data Center).
  2. Navigate to Assets → Object Schema → [Your Discovery Schema].
  3. Select the Object Type for discovered software (e.g. Discovered Applications or Installed Software).
  4. Click Objects → Export → CSV.
  5. Choose the following attributes:
  • Hostname / Device Name
  • Software Name
  • Version
  • Vendor / Publisher
  1. Save the file as JSM_Discovery_SIM_Export.csv.

Note: If “Vendor” or “Publisher” is not directly available, it may appear as an attribute linked to the application object type (for example, Manufacturer or Vendor relationship).

Section titled “Option 2: Atlassian Assets REST API (recommended for automation)”

For large or automated environments, use the Assets REST API to export software inventory programmatically.

  1. Go to Atlassian API Tokens.
  2. Create a token and store it securely.
  3. Use your Atlassian email and token for Basic Authentication.

PowerShell Script

Terminal window
# Jira Service Management Discovery SIM Template Export Script
# Requires API token and read access to Assets (Insight)
$BaseUrl = "https://yourdomain.atlassian.net"
$Email = "your.email@domain.com"
$ApiToken = "YOUR_API_TOKEN"
$ExportPath = "C:\Exports\JSM_Discovery_SIM_Export.csv"
# Encode credentials
$EncodedAuth = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes("$Email`:$ApiToken"))
$Headers = @{
"Authorization" = "Basic $EncodedAuth"
"Accept" = "application/json"
}
# Replace 123 with your Insight Schema ID and Object Type ID for 'Installed Software'
$SchemaId = 123
$ObjectTypeId = 456
# Retrieve application data
$Url = "$BaseUrl/rest/insight/1.0/objecttype/$ObjectTypeId/objects"
$Response = Invoke-RestMethod -Uri $Url -Headers $Headers -Method Get
# Initialize export data
$ExportData = @()
foreach ($Obj in $Response.objects) {
$DeviceName = ($Obj.attributes | Where-Object {$_.objectTypeAttribute.name -eq "Device Name"}).objectAttributeValues.value
$SoftwareName = ($Obj.attributes | Where-Object {$_.objectTypeAttribute.name -eq "Software Name"}).objectAttributeValues.value
$Version = ($Obj.attributes | Where-Object {$_.objectTypeAttribute.name -eq "Version"}).objectAttributeValues.value
$Publisher = ($Obj.attributes | Where-Object {$_.objectTypeAttribute.name -match "Vendor|Publisher|Manufacturer"}).objectAttributeValues.value
$ExportData += [PSCustomObject]@{
"Device Name" = $DeviceName
"Software Name" = $SoftwareName
"Software Version" = $Version
"Software Publisher" = $Publisher
}
}
# Export to CSV
$ExportData | Export-Csv -Path $ExportPath -NoTypeInformation -Encoding UTF8
Write-Host "Export complete: $ExportPath"

This script connects to your JSM Discovery schema via the API, retrieves software-related asset objects, and exports the results in SIM-ready format.

The CSV header row must be exactly Device Name,Software Name,Software Version,Software Publisher.

  1. Open the Licenseware SIM Template.
  2. Paste the CSV data into the appropriate columns.

Clean any blank or duplicate rows before saving.

Then upload it on the SIM - Template data source. See SIM template.

IssueCauseResolution
Empty exportDiscovery agents not reportingVerify Discovery configuration and recent scan activity.
Missing publisher/vendor fieldAttribute not defined in schemaMap the correct attribute in JSM Assets or fill manually in the SIM Template.
API 403 ForbiddenInsufficient permissionsEnsure API token has access to the Discovery schema.
Pagination / limited resultsAPI returns partial dataAdd ?page= or ?resultPerPage= parameters in the API call loop.
Encoding issuesFile saved in ANSIRe-save the CSV with UTF-8 encoding before import.
Device Name,Software Name,Software Version,Software Publisher
LAPTOP-001,Google Chrome,129.0.6668.90,Google LLC
SERVER-02,Microsoft SQL Server 2022,16.0.432,Microsoft Corporation
LAPTOP-004,Slack,4.39.95,Slack Technologies
IMAC-01,Adobe Acrobat DC,24.002.20933,Adobe Inc.