This document describes how to fetch CMDB data using the public API.
Authentication is done via an apiKey header.

The process consists of three steps:

1. Get CMDB types
2. Get tables for a selected type
3. Export a selected table as CSV

Base URL: https://<xormon host>:8443 (or port 443, basically same port as the UI is)
Authentication: All requests require the following HTTP header: --header 'apiKey: <api-key>'
apiKey: <yourKey>

Step 1 – Get list of CMDB types

This endpoint returns all available CMDB types.
One of these types is required to retrieve the list of CMDB tables in the next step.

Request: GET /api/public/v1/cmdb/types

curl example:

curl --location 'https://<xormon host>:8443/api/public/v1/cmdb/types' \
  --header 'apiKey: yourKey'

Example response:
{
    "statusCode": 200,
    "data": [
        "storage",
        "san",
        "lan",
        "tape",
        "virtualization_proxmox",
        "virtualization_nutanix",
        "virtualization_linux",
        "virtualization_power",
        "virtualization_vmware",
        "virtualization_ovirt",
        "virtualization_xenserver",
        "virtualization_windows",
        "virtualization_solaris",
        "virtualization_oraclevm",
        "virtualization_cloudstack",
        "virtualization_mainframe",
        "virtualization_fusioncompute",
        "virtualization_as400",
        "cloud_azure",
        "cloud_aws",
        "cloud_gcloud",
        "cloud_ibmcloud",
        "cloud_skytap",
        "database_postgres",
        "database_db2",
        "database_oracledb",
        "database_sqlserver",
        "database_timescaledb",
        "database_mongodb",
        "container_docker",
        "container_kubernetes",
        "container_openshift",
        "container_tanzu",
        "backup_ibmtsm",
        "backup_netbackup",
        "backup_veeam",
        "backup_commvault",
        "serversp_didrac",
        "serversp_hpeilo",
        "serversp_lxclarity"
    ]
}

Selected CMDB type for next step: storage

Step 2 – Get CMDB tables for a specific type

This endpoint returns all CMDB tables available under the selected CMDB type.
One of these tables is required for exporting CMDB data.

Request: GET /api/public/v1/cmdb/tables/{cmdb_type}

curl example (using "storage"):

curl --location 'https://<xormon host>:8443/api/public/v1/cmdb/tables/storage' \
  --header 'apiKey: yourKey'

Example response:
{
    "statusCode": 200,
    "data": [
        "HW",
        "Volume",
        "Snapshot"
    ]
}

Selected CMDB table for export: HW

Step 3 – Export CMDB table as CSV

This endpoint exports the selected CMDB table in CSV format.
The export contains raw/base values without any GUI transformations (for example, values are in bytes instead of GB).

Request: GET /api/public/v1/cmdb/table/{cmdb_type}/{cmdb_table}

curl example (storage + HW):

curl --location 'https://<xormon host>:8443/api/public/v1/cmdb/table/storage/HW' \
  --header 'apiKey: yourKey'

Optional: Save CSV directly to a file
curl --location 'https://<xormon host>:8443/api/public/v1/cmdb/table/storage/HW' \
  --header 'apiKey: yourKey' \
  --output storage_HW.csv

Summary

1. Fetch CMDB types: GET /api/public/v1/cmdb/types
2. Fetch CMDB tables for a type: GET /api/public/v1/cmdb/tables/storage
3. Export CMDB table as CSV: GET /api/public/v1/cmdb/table/storage/HW

List of all tables

To list your actual type,table and path combinations, run this script
For it it work you will need to change script variables to your url and working API key:
BASE_URL="https://<xormon host>:8443/api/public/v1/cmdb"
API_KEY="e69403787286d3a78002eeef995bf38f"

#!/bin/bash

BASE_URL="https://<xormon host>:8443/api/public/v1/cmdb"
API_KEY="e69403787286d3a78002eeef995bf38f"

OUTPUT_FILE="cmdb_tables.csv"

# Truncate output file
> "$OUTPUT_FILE"

# Get CMDB types
types=$(curl -k \
  --header "apiKey: $API_KEY" \
  "$BASE_URL/types" \
  | jq -r '.data[]')

for type in $types; do
  tables=$(curl -k \
    --header "apiKey: $API_KEY" \
    "$BASE_URL/tables/$type" \
    | jq -r '.data[]')

  for table in $tables; do
    echo "$type;$table;/api/public/v1/cmdb/table/$type/$table" >> "$OUTPUT_FILE"
  done
done

This is valid for XorMon v2.2.0.