Components installed with API Insights

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

    The activation of the API Insights plugin in ServiceNow introduces various components, including user roles, scheduled jobs, and tables, enhancing the Configuration Management Database (CMDB) capabilities. These components are essential for managing APIs effectively within your organization.

    Show full answer Show less

    Key Features

    • Roles Installed:
      • Enterprise architect administrator: Manages API Insights workspace, searches APIs, monitors connections, evaluates metrics, and sets parameters.
      • Enterprise architect: Oversees API activity, reviews access requests, and manages API life cycle aspects.
    • Scheduled Jobs Installed:
      • Gather APIs without Business App relationship: Identifies APIs lacking business context.
      • Import ServiceNow API to API Insights: Imports ServiceNow APIs into API Insights.
      • Import ServiceNow API usage to MetricBase: Collects and pushes API usage data.
      • SyncOwnershipGroupsOfAPIVersions: Synchronizes ownership groups for API versions.
      • API Specification Validation: Automates validation of API specifications.
    • Tables Installed:
      • APIs missing relationships: Records APIs with undefined relationships.
      • API Specification: Contains details of API specifications.
      • Importable ServiceNow APIs: Details of APIs imported from ServiceNow.
      • Open API Specifications: Records for OpenAPI specifications.
      • Push API Specification: Manages records for pushing API specifications.
      • API Requests Access Task: Manages API access request tasks.
      • Specification Validation Rule: Defines rules for validating API specifications.
    • Plugins Installed:
      • MetricBase: Analyzes and acts on time-series data.
      • CMDB CI Class Models: Provides a single source for CMDB CI class models.
      • CMDB Workspace: Facilitates CMDB management and operations.
      • Node map Experience Component: Visualizes connections between concepts.
      • SGC Central: Monitors Service Graph Connectors.
      • Timeline component: Displays events across a timeline.
      • UX Commons: Enhances user experience with common UI utilities.

    Key Outcomes

    By leveraging the components installed with API Insights, ServiceNow customers can effectively manage their APIs, ensure compliance with specifications, and enhance the overall health of their API ecosystem. This results in improved API lifecycle management and better visibility into API performance and usage across the organization.

    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.

    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.

    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.