API Service Graph Connector for Azure API Management

  • Release version: Xanadu
  • Updated October 23, 2025
  • 3 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of API Service Graph Connector for Azure API Management

    The ServiceNow® API Service Graph Connector for Azure API Management enables you to import detailed API information from your Azure API Management applications directly into the Configuration Management Database (CMDB). This integration helps maintain a comprehensive, normalized inventory of your API estate within ServiceNow, improving visibility, governance, and operational management of APIs.

    Show full answer Show less

    Key Features

    • Normalized Data Model: Imports API data into a consistent format, enabling seamless integration with other technologies.
    • API Insights Workspace: Provides a centralized interface for analyzing and interacting with API data without requiring direct Azure API Management access, facilitating collaboration and governance.
    • Support for Multiple ServiceNow Versions: Compatible with Xanadu, Yokohama, and Zurich releases.

    Practical Use Cases

    • Maintain an end-to-end inventory of published and backend APIs, including usage and consumer identification.
    • Track APIs from customer-facing endpoints to backend services to identify impacted endpoints during service changes or failures and assist in incident creation.
    • Manage API-related vulnerabilities and security incidents and enforce compliance requirements on API endpoints.

    Configuration and Management

    Configure the connector connection using the SGC Central view within the CMDB Workspace. This view supports discovering, installing, and managing connectors, including lifecycle tasks such as editing, monitoring, and debugging connections. Note that the guided setup method is deprecated; SGC Central is the recommended configuration approach.

    Data Mapping and Integration

    Data from Azure API Management is ingested using the Robust Transform Engine (RTE) and reconciled into the CMDB using the Identification and Reconciliation Engine (IRE). The connector periodically pulls data into staging tables, which are then mapped to corresponding CMDB Configuration Item (CI) classes, such as Azure API Management, Managed API, API Frontend/Backend, API Consumer, and others. This enables a structured and comprehensive representation of your API components within ServiceNow.

    The IntegrationHub ETL app can be used to view and manage these data maps, facilitating transparency and customization of data flows.

    Record Removal Process

    The connector employs soft deletion for CMDB CI records. Instead of permanently deleting records, any CI not discovered in the latest scheduled data import is marked as Non-Operational. This preserves historical data and supports auditability while keeping the CMDB current.

    Use the ServiceNow® API Service Graph Connector for Azure API Management to import API details from an Azure API Management application into the Configuration Management Database (CMDB).

    Request apps on the Store

    Visit the ServiceNow Store website to view all the available apps and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.

    Key features

    Import data into a normalized data model for consistency across other technologies.

    The API Insights workspace provides a centralized interface where you can analyze and interact with API data, without needing direct access to Azure API Management, enhancing visibility, governance, and collaboration across the API estate. To learn more, see API Insights.

    Supported ServiceNow versions

    • Xanadu
    • Yokohama
    • Zurich

    Use cases

    You can use the API Service Graph Connector for Azure API Management to:
    • Maintain an end-to-end inventory of exposed and backend APIs, identifying what APIs are published, used, and by whom.
    • Track APIs from customer-facing endpoints to the underlying services, identifying impacted endpoints when services change or fail and creating incidents for reported issues.
    • Address vulnerabilities and security incidents related to API endpoints, and create compliance requirements to measure against.

    Configuring a connection for the connector

    You can configure a connection for the connector by using the SGC Central view in the CMDB Workspace. The view enables you to discover and install connectors, and then effectively manage the full life cycle of creating, editing, monitoring, and debugging connections. To configure the connector using SGC Central, see Configure API Service Graph Connector for Azure API Management using SGC Central.

    Important:
    Unless there are configuration issues, use the SGC Central view in the Service Graph Workspace or CMDB Workspace to configure the connection for the connector, as the guided setup method is planned for deprecated.

    Data mapping

    Data from the Azure API Management data sources is mapped and transformed into the CMDB Configuration Item (CI) class definitions using the Robust Transform Engine (RTE). Data is inserted into the CMDB using the Identification and Reconciliation Engine (IRE).

    When you complete setting up the connection, you can configure the integration to periodically pull data from an Azure API Management application.

    The following table lists the data sources in the order they run, the staging tables, and the target tables as CMDB CI and non-CMDB classes for an Azure API Management application.
    Table 1. Data mapping for Azure API Management
    Data source Staging table Target tables
    API Management Services SGA Azure API Management [sn_azure_api_gw_sga_azure_api_management] Azure API Management

    Azure Subscription

    Cloud Service Account

    Resource Group

    DNS Alias
    Managed API SGA Azure Managed API [sn_azure_api_gw_sga_azure_managed_api] Managed API
    API Frontend Backend SGA Azure API Frontend Backend [sn_azure_api_gw_sga_azure_api_frontend_backend_import] API Frontend

    API Backend
    API GraphQL Frontend Backend SGA Azure API GraphQL Frontend Backend [sn_azure_api_gw_sga_azure_api_graphql_frontend_backend] API Frontend

    API Backend
    API Consumer SGA Azure API Consumer [sn_azure_api_gw_sga_azure_api_consumer] API Consumer
    API Product SGA Azure API Product [sn_azure_api_gw_sga_azure_api_product] API Product Bundle
    API Consumer Subscription SGA Azure API Consumer Subscription [sn_azure_api_gw_sga_azure_api_subscription] API Consumer Subscription
    API Tag API Tag [sn_azure_api_gw_api_tag] Key Value
    API Consumer Access SGA Azure API Consumer Access [sn_azure_api_gw_sga_azure_managed_api] API Consumer Access

    For more information on where data is saved when pulling data from an Azure API Management application, see Target tables for storing API Service Graph Connector for Azure API Management data.

    You can use the IntegrationHub ETL app to view the data maps. See IntegrationHub ETL for more information.

    Record removal process

    The connector supports soft deletion for CMDB CI classes only, meaning records are not permanently removed from the system. Instead, any CMDB CI records not discovered during the last scheduled job run are marked as Non-Operational.