API Insights properties

  • Release version: Zurich
  • Updated July 31, 2025
  • 2 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 Insights properties

    API Insights properties configure how the API Insights application behaves within your ServiceNow instance. These properties control the import settings for different API types, machine learning (ML) recommendations, search limits, workflow execution, and dashboard displays. Managing these properties allows you to tailor API Insights to your organizational requirements and improve API governance and visibility.

    Show full answer Show less

    Key properties and their practical use

    • API Import Controls: Properties like importoutboundrestapi, importoutboundsoapapi, importscriptedrestapi, and importscriptedsoapapi enable or disable importing various API types into the API Insights workspace. These settings help you decide which APIs from your instance are analyzed and tracked.
    • Activity Timeframe Settings: For scripted APIs, you can specify if only APIs active in the last number of days (default 90) are imported, helping focus on relevant APIs.
    • Machine Learning Recommendations: The mlminclusterquality property sets the minimum quality threshold (0-100) for ML clustering recommendations, enabling better control over the relevance of suggested API component groupings.
    • Search Limits: The searchapilimit defines the maximum number of results returned for API and component searches, optimizing performance and usability.
    • Relationship Model: The settingsapitobusinessappservice property defines the relationship model (e.g., CSDM) used to link APIs to business context, supporting accurate impact analysis and governance.
    • Access Request Workflow: The settingsgrantaccessworkflow property points to the workflow executed when an API access request is submitted, automating and controlling access management.
    • Preferred API Authoring Tool: Set via settingspreferredtool and settingspreferredtoolurl, this defines which external or internal tool is used for creating new APIs, streamlining authoring processes.
    • Support Group Representation: The settingssupportgroupcolumn selects which CMDB column represents the support group in API Insights dashboards, ensuring accurate operational ownership visibility.
    • UI Display Toggles: Properties like showmlclusteringrecs (default true) enable or disable ML clustering recommendations for orphan API components, while showoverviewmetricswidgets (default false) controls the display of metric widgets on overview pages.

    How to access and configure these properties

    All API Insights system properties reside in the System Properties [sysproperties] table. You can access and modify them by entering sysproperties.list in the ServiceNow navigation filter. Adjusting these settings allows you to customize API Insights behavior to match your governance, monitoring, and operational needs.

    API Insights properties control the behavior of the application.

    System properties

    These system properties are available for API Insights.
    Note:
    To open the System Properties [sys_properties] table, enter sys_properties.list in the navigation filter.
    Table 1. System properties for API Insights
    Property Description

    sn_api_insights_ws.import_outbound_rest_api

    		 Set the property to enable or disable the import of outbound REpresentational State Transfer (REST) APIs from your ServiceNow instance to the API Insights workspace.
    • Type: string
    • Default value: {"custom_api":false,"servicenow_api":false}
    • Location: System Property [sys_properties] table

    sn_api_insights_ws.import_outbound_soap_api

    		 Set the property to enable or disable the import of outbound Simple Object Access Protocol Application Programming Interface (SOAP) APIs from your ServiceNow instance to the API Insights workspace.
    • Type: string
    • Default value: {"custom_api":false,"servicenow_api":false}
    • Location: System Property [sys_properties] table

    sn_api_insights_ws.import_scripted_rest_api

    		 Set the property to enable or disable the import of scripted REST APIs from your ServiceNow instance to the API Insights workspace, and set the timeframe for recent activity.
    • Type: string
    • Default value: {"custom_api":false,"servicenow_api":true,"active_in_last":false,"active_in_last_number_of_days":90}
    • Location: System Property [sys_properties] table

    sn_api_insights_ws.import_scripted_soap_api

    		 Set the property to enable or disable the import of scripted SOAP APIs from your ServiceNow instance to the API Insights workspace, and set the timeframe for recent activity.
    • Type: string
    • Default value: {"custom_api":false,"servicenow_api":false,"active_in_last":false,"active_in_last_number_of_days":90}
    • Location: System Property [sys_properties] table

    sn_api_insights_ws.ml_min_cluster_quality

    		 Enter the minimum cluster quality to display in machine learning recommendations, ranging from 0 to 100.
    • Type: integer
    • Default value: 80
    • Location: System Property [sys_properties] table

    sn_api_insights_ws.search_api_limit

    		 Enter the desired limit on results for API and API component searches.
    • Type: integer
    • Default value: 1000
    • Location: System Property [sys_properties] table

    sn_api_insights_ws.settings_api_to_business_app_service

    		 Set the property to the relationship model between APIs and business context.
    • Type: choice list
    • Default value: CSDM
    • Location: System Property [sys_properties] table

    sn_api_insights_ws.settings_grant_access_workflow

    		 Set the property to the sys ID of the workflow to be executed when an access request is submitted in API Insights.
    • Type: string
    • Default value: API Grant/Reject Access Template
    • Location: System Property [sys_properties] table

    sn_api_insights_ws.settings_preferred_tool

    		 Set the preferred tool for the creation of new APIs in API Insights.
    • Type: choice list
    • Default value: Authoring tool
    • Location: System Property [sys_properties] table

    sn_api_insights_ws.settings_preferred_tool_url

    		 Set the URL for the preferred API authoring tool inAPI Insights. This property value is used when the settings_preferred_tool property is set to API Authoring Tool.
    • Type: string
    • Default value: http://www.postman.com
    • Location: System Property [sys_properties] table

    sn_api_insights_ws.settings_support_group_column

    		 Set the column on the Configuration item [cmdb_ci] table that will represent the support group in the API Insights dashboards.
    • Type: choice list
    • Default value: managed_by_group
    • Location: System Property [sys_properties] table

    sn_api_insights_ws.show_ml_clustering_recs

    		 Set the property to false to disable the clustering recommendations for orphan API components.
    • Type: true | false
    • Default value: true
    • Location: System Property [sys_properties] table

    sn_api_insights_ws.show_overview_metrics_widgets

    		 Set the property to true to enable showing the Metric Base widgets on the API and API Component Overview pages.
    • Type: true | false
    • Default value: false
    • Location: System Property [sys_properties] table