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 APIs discovered by Akamai into your ServiceNow instance. This integration supports API management and security use cases by importing critical API data into the ServiceNow Configuration Management Database (CMDB), specifically enriching the API Component CI class with security- and risk-related attributes.
Show less
This connector is compatible with ServiceNow versions Xanadu, Yokohama, and Zurich, and works with Akamai API Security REST APIs including /api/v3/apis, /api/v3/sources, and /auth/token.
Key Features
- API Data Integration: Automatically imports API details discovered by Akamai, such as request/response data types, internet-facing endpoint status, and authentication types, enabling comprehensive API security management.
- Configuration and Management: Use the SGC Central view within Service Graph Workspace or CMDB Workspace to install, configure, monitor, and debug the connector connection efficiently.
- CMDB Integrations Dashboard: Provides a centralized dashboard via the Integration Commons for CMDB app to monitor status, processing results, and errors across all integrations, with filtering options by integration or time frame.
- Data Mapping and Transformation: Employs the Robust Transform Engine (RTE) for mapping Akamai data into CMDB classes and the Identification and Reconciliation Engine (IRE) to insert data accurately. IntegrationHub ETL app can be used to view and manage data maps.
- Data Loading Options: Supports both full and delta data loads. Initial data import runs a full load; subsequent imports fetch only changed data. You can customize recurring full loads by adjusting the schedule of the Reset Last Run Datetime for SG-Akamai script.
Practical Benefits
By integrating Akamai API Security data into ServiceNow, customers gain a unified view of their API landscape with enriched security insights. This enables proactive risk management, improved API governance, and enhanced security posture for internet-facing and internal APIs.
Monitoring and managing these integrations through the CMDB dashboard ensures operational visibility and efficient troubleshooting. The flexible data loading approach allows balancing completeness and performance in your data synchronization strategy.
Next Steps
- Install and configure the connector using the SGC Central interface.
- Utilize the CMDB Integrations Dashboard to monitor integration health and performance.
- Adjust scheduled scripts for full or delta data loads as needed to align with your update frequency.
- Refer to related ServiceNow documentation for detailed API references, configuration guides, and CMDB class definitions.
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 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.