API Insights properties

  • Rversion finale: Australia
  • Mis à jour 12 mars 2026
  • 2 minutes de lecture

    • API Insights properties control the behavior of the application.

    System properties

    These system properties are available for API Insights.
    Remarque :
    To open the System Properties [sys_properties] table, enter sys_properties.list in the navigation filter.
    Tableau 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