API Insights properties

  • Release version: Yokohama
  • 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 enable you to configure how the API Insights application behaves within your ServiceNow instance. These system properties allow you to control API import settings, machine learning recommendations, search limits, workflow executions, preferred tools, and dashboard displays for API management and analysis.

    Show full answer Show less

    Key Features

    • API Import Controls: Enable or disable importing different types of APIs—outbound REST, outbound SOAP, scripted REST, and scripted SOAP—from your instance into the API Insights workspace. You can also specify whether to include custom APIs, ServiceNow APIs, and set timeframes for recent activity imports.
    • Machine Learning Recommendations: Configure the minimum cluster quality threshold for ML recommendations and enable or disable clustering recommendations for orphan API components.
    • Search Limits: Set limits on the number of results returned for API and API component searches to optimize performance.
    • Relationship Modeling: Define the relationship model between APIs and business context, such as using the Common Service Data Model (CSDM).
    • Access Request Workflow: Specify the workflow executed when an access request is submitted within API Insights to automate approval processes.
    • Preferred API Authoring Tool: Choose your preferred tool for creating new APIs in API Insights and set its URL for quick access.
    • Dashboard Customization: Set which Configuration Item [cmdbci] table column represents the support group, and enable or disable metric base widgets on overview pages.

    Practical Use for ServiceNow Customers

    By adjusting these properties, you can tailor the API Insights application to align with your organization's API management strategy and operational workflows. This ensures that relevant APIs are imported and analyzed, machine learning recommendations are meaningful, and access requests are seamlessly handled. Setting preferred tools and dashboard options enhances usability and visibility into your API ecosystem.

    To modify these settings, access the System Properties [sysproperties] table by entering sysproperties.list in the navigation filter and look for properties prefixed with snapiinsightsws.

    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