API Insights properties

  • Release version: Washingtondc
  • 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 are integral to configuring the behavior of the API Insights application within ServiceNow. These system properties allow users to control various aspects of API data import and machine learning functionalities, enhancing the management and visibility of APIs in the workspace.

    Show full answer Show less

    Key Features

    • Import Control: Properties like snapiinsightsws.importoutboundrestapi and snapiinsightsws.importoutboundsoapapi enable or disable the import of outbound REST and SOAP APIs, respectively.
    • Scripted API Import: The properties snapiinsightsws.importscriptedrestapi and snapiinsightsws.importscriptedsoapapi manage scripted API imports and recent activity timeframes.
    • Machine Learning Settings: snapiinsightsws.mlminclusterquality sets the minimum quality for displaying machine learning recommendations, while snapiinsightsws.showmlclusteringrecs controls visibility of clustering recommendations.
    • Search Limit: The snapiinsightsws.searchapilimit property sets a limit on the results returned for API searches.
    • Access and Workflow Management: Properties like snapiinsightsws.settingsgrantaccessworkflow define the workflow for access requests in API Insights.
    • Preferred Tools: Define the preferred tool for creating APIs and its URL through snapiinsightsws.settingspreferredtool and snapiinsightsws.settingspreferredtoolurl.
    • Support Group Representation: The snapiinsightsws.settingssupportgroupcolumn indicates the support group column on the Configuration item table for dashboards.
    • Metrics Display: The snapiinsightsws.showoverviewmetricswidgets property enables metrics widgets display on overview pages.

    Key Outcomes

    By configuring these properties, ServiceNow customers can optimize API management processes, enhance visibility into API usage and performance, and ensure that their API Insights workspace aligns with organizational needs. This control leads to improved decision-making based on data-driven insights and efficient API governance.

    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