Components installed with API Insights

  • 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 Components Installed with API Insights

    The activation of the API Insights plugin installs several components that enhance API management and monitoring within ServiceNow. This includes user roles, scheduled jobs, tables, and additional plugins that facilitate API usage tracking and analysis.

    Show full answer Show less

    Key Features

    • Roles Installed:
      • Enterprise Architect Administrator: Access to the API Insights workspace for searching APIs and managing data model recommendations.
      • Enterprise Architect: Management of the API lifecycle, monitoring team APIs, and reviewing access requests.
    • Scheduled Jobs Installed:
      • Identifies APIs lacking business context.
      • Imports ServiceNow APIs and their usage data into API Insights and MetricBase, respectively.
      • Synchronizes ownership groups for API versions.
      • Automates validation of API specifications.
      • Applies tag-based mapping between APIs and business applications.
    • Tables Installed:
      • Tracks API records without defined relationships and details of imported APIs.
      • Contains specifications for APIs, validation rules, and configuration for metrics.
    • Plugins Installed:
      • MetricBase for time-series data analysis.
      • Various applications for enhancing data selection, CMDB management, and visual mapping.

    Key Outcomes

    By using these components, ServiceNow customers can effectively manage and analyze their APIs, ensuring better visibility, improved governance, and enhanced operational efficiency. This setup allows for automated processes that simplify API management tasks and improve data-driven decision-making. Customers should expect streamlined API lifecycle management and insightful analytics as a result of these installations.

    Several types of components are installed with activation of the API Insights plugin, including tables, user roles, and scheduled jobs.

    Roles installed

    Role title [name] Description Contains roles

    Enterprise architect administrator

    [sn_api_insights_ws.api_mgmt_architect_admin]

    Accesses the API Insights workspace to search APIs, review data model recommendations, monitors API connections, evaluate metrics on API usage, and set parameters for data model recommendations and de-duplication tasks.

    sn_api_insights_ws.api_mgmt_architect

    Enterprise architect

    [sn_api_insights_ws.api_mgmt_architect]

    		 Accesses the API Insights workspace to search APIs, monitor team APIs, view managed and subscribed APIs, track API activity, review API access requests, and manage API life cycle aspects, including APIs without business context, ownership, product models, or designs.
    • task_editor
    • sn_incident_read
    • sn_vul.vulnerability_read
    • sn_cmdb_editor
    • sn_msi.msi_incident_read

    Scheduled jobs installed

    Scheduled job Description
    Gather APIs without Business App relationship

    Identifies and collects APIs that do not have an associated business context also called as business application.
    Import ServiceNow API to API Insights Retrieves ServiceNow APIs from the ServiceNow registry and imports them into API Insights.
    Import ServiceNow API usage to MetricBase Collects ServiceNow API usage data and pushes it to the MetricBase application.
    SyncOwnershipGroupsOfAPIVersions Synchronizes ownership groups for API versions in API Insights.
    API Specification Validation Performs automated validation of API specifications in an instance.
    Tag based relationship mapping Applies tag-based mapping rules between APIs and application services or business applications.

    Tables installed

    Table Description

    APIs missing relationships

    [sn_api_insights_ws_apis_missing_relationships]

    API records that lack a defined relationship.

    API Specification

    [sn_api_insights_ws_api_specification]

    API specification details, such as OpenAPI definitions.

    Importable ServiceNow APIs

    [sn_api_insights_ws_importable_servicenow_api]

    Details of APIs imported from ServiceNow.

    Open API Specifications

    [sn_api_insights_ws_openapi_specifications]

    OpenAPI specification records for API Insights.

    Push API Specification

    [sn_api_insights_ws_push_api_spec]

    Records for pushing API specifications.

    API Requests Access Task

    [sn_api_insights_ws_request_access_task]

    Tasks related to API access requests.

    Specification Validation Rule

    [sn_api_insights_ws_spec_validation_rule]

    Validation rules that validate API specifications based on the configured rules.

    API Metric Configuration

    [sn_api_insights_ws_api_metric_config]

    Configuration that maps each discovery source to the MetricBase application used for analytics, defining the metric name, whether it applies at API or component level, and the metric type (usage, error rate, latency, cache hit).
    Tag Based Relationship Mapping

    [sn_api_insights_ws_tag_relationship_mapping]

    Relationship rules that apply tag-based mapping between APIs and application services or business applications, defining the CI types involved, the relationship type, and which CI acts as the parent.

    Plugins installed

    Plugin Description

    MetricBase (com.snc.clotho)

    Collects, retains, analyzes, graphs, and acts on time-series data.

    ServiceNow Store applications installed

    Application Description

    @devsnc/sn-list-selector (sn_list-selector)

    Enables selecting a set of values from a simple or multi-dimensional data source.

    CMDB CI Class Models (sn_cmdb_ci_class)

    Provides the single source for all new base-system CMDB CI class models defined by ServiceNow.

    CMDB Workspace (sn_cmdb_ws)

    Enables a workspace for working with the CMDB to search and explore the CMDB, understand its health, work on related tasks, view activity, performance and feature usage, and access various management tools to support tasks in an organization.

    Node map Experience Component (sn_node_map)

    Enables mapping and visualizing connections between concepts.

    SGC Central (sn_sgc_central)

    Enables discovering, installing, and monitoring Service Graph Connectors.

    Timeline component (sn_ui_timeline)

    Shows events and information across a timeline to contextualize history or important information for an object.

    UX Commons (sn_app_ux_commons)

    Enhances component experience with common UI Builder utilities, controllers, and bundles.