Service Graph Connector for Akamai API Security
Summarize
Summary of Service Graph Connector for Akamai API Security
The Service Graph Connector (SGC) for Akamai API Security integrates API data discovered by Akamai into your ServiceNow instance. This integration supports comprehensive API management and security use cases by populating the ServiceNow Configuration Management Database (CMDB) with detailed API information. It enhances the new API Insights capability by adding security- and risk-related attributes such as data types, internet-facing status, and authentication methods for API endpoints.
Show less
Supported Versions and APIs
- Supported ServiceNow versions include Xanadu, Yokohama, and Zurich.
- Compatible with Akamai API Security REST APIs:
/api/v3/apis,/api/v3/sources, and/auth/token.
Key Features
- Connector Configuration: Use the SGC Central view in Service Graph Workspace or CMDB Workspace to install, configure, and manage the connector lifecycle, including debugging and monitoring connections.
- CMDB Integrations Dashboard: Provides centralized monitoring of integration status, processing results, and errors, with filtering options for specific integrations or timeframes.
- Data Mapping: Akamai API Security data is mapped and transformed via the Robust Transform Engine (RTE) and inserted into the CMDB using the Identification and Reconciliation Engine (IRE). Key data sources include Akamai API Security Sources and API Component classes.
- Data Load Methods: Supports both full and delta data loads. Initial imports use full loads, while subsequent imports use delta loads to capture changes. The schedule for full loads can be customized via the Reset Last Run Datetime scheduled script.
- IntegrationHub ETL Compatibility: Allows viewing and management of data maps through the IntegrationHub ETL application.
Practical Benefits for ServiceNow Customers
By leveraging this connector, customers can unify API data within their ServiceNow environment to improve visibility and control over API security risks. It enables automated data synchronization between Akamai API Security and ServiceNow CMDB, facilitating better risk assessment, security compliance, and API management workflows.
Next Steps
- Install and configure the connector using the SGC Central interface.
- Monitor integration health and metrics via the CMDB Integrations Dashboard.
- Customize scheduled scripts for data load frequency according to operational needs.
- Consult related documentation such as the Management API Reference and Service Graph Connectors for deeper technical guidance.
Use the Service Graph Connector for Akamai API Security to integrate the APIs discovered by Akamai into your ServiceNow instance to support various API management use cases.
Request apps on the Store
Visit the ServiceNow Store website to view all the available apps and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.
Supported versions
- Supported ServiceNow versions:
- Xanadu
- Yokohama
- Zurich
- Supported Akamai API Security REST APIs:
- /api/v3/apis
- /api/v3/sources
- /auth/token
Use cases
The Service Graph Connector for Akamai API Security brings data into the new API Insights capability of the ServiceNow platform, enabling the management of different APIs in one instance. The connector adds information discovered by Akamai API Security to the API Component CI class.
The Service Graph Connector for Akamai API Security populates attributes that are security- and risk-related, such as the request and response data types, whether an API endpoint is internet-facing, and the type of authentication used for the endpoint. These data points enable risk and security use cases to be implemented for API security.
Configuring a connection for the connector
Use the SGC Central view in the Service Graph Workspace or CMDB Workspace to install the connector and configure the connection. The view enables you to install and discover connectors and to manage the full life cycle of creating, editing, monitoring, and debugging connections. For instructions, see Configure Service Graph Connector for Akamai API Security using SGC Central.
CMDB integrations dashboard
The Integration Commons for CMDB store app provides a dashboard with a central view of the status, processing results, and processing errors of all installed integrations. You can see metrics for all integration runs. You can filter the view to a specific CMDB integration, a specific time duration, or a specific integration run. For more details about monitoring Akamai API Security integrations in the CMDB Integrations Dashboard, see Using the CMDB Integrations Dashboard.
Data mapping
Data from the Akamai API Security data sources is mapped and transformed into the ServiceNow CMDB Configuration Item (CI) class definitions using the Robust Transform Engine (RTE). Data is inserted into the ServiceNow CMDB using the Identification and Reconciliation Engine (IRE).
| Data source | Staging table | Target tables |
|---|---|---|
| Sources | sn_akamai_api_sec_akamai_sources | Akamai API Security Sources [sn_akamai_source] |
| API Component | sn_akamai_api_sec_sga_akamai_api_component | API Component |
You can use the IntegrationHub ETL app to view the data maps. See IntegrationHub ETL for more information.
Scheduled script for full data load
The Service Graph Connector for Akamai API Security supports both full load and delta load data ingestion methods. A full data load retrieves all API-related data and populates the corresponding CMDB tables. Delta loads fetch only the data that changed since the previous execution.
During the initial scheduled data import, a full data load is executed. Subsequent data imports perform delta loads.
To run a full data load on a recurring basis, customize the execution schedule of the Reset Last Run Datetime for SG-Akamai scheduled script based on your requirements. To open the Scheduled Script Executions table, enter sysauto_script.list in the navigation filter.