Service Graph Connector for Akamai API Security
Summarize
Summary of Service Graph Connector for Akamai API Security
The Service Graph Connector for Akamai API Security enables integration of APIs discovered by Akamai into your ServiceNow instance. This integration supports API management use cases by bringing detailed API security and risk-related data into the ServiceNow platform, specifically enhancing the new API Insights capability.
Show less
This connector populates the API Component Configuration Item (CI) class with key security attributes such as data types for requests and responses, internet-facing endpoint status, and authentication types. These details facilitate risk assessment and security management of APIs within your CMDB.
Supported Versions and APIs
- Compatible with ServiceNow versions: Xanadu, Yokohama, and Zurich.
- Supports Akamai API Security REST APIs: /api/v3/apis, /api/v3/sources, and /auth/token.
Configuration and Management
Use the Service Graph Connector (SGC) Central view within the Service Graph Workspace or CMDB Workspace to install and configure the connector. This interface supports the entire lifecycle of connections, including creation, editing, monitoring, and debugging.
Integration status, results, and errors for Akamai API Security and other CMDB integrations can be monitored centrally via the CMDB Integrations Dashboard provided by the Integration Commons for CMDB app. This dashboard allows filtering by integration, time, or specific runs.
Data Handling and Mapping
Data from Akamai API Security sources is ingested through staging tables and transformed using the Robust Transform Engine (RTE). It is then inserted into the CMDB using the Identification and Reconciliation Engine (IRE). Key data mappings include:
- Sources: Mapped from
snakamaiapisecakamaisourcestoAkamai API Security Sources [snakamaisource]. - API Components: Mapped from
snakamaiapisecsgaakamaiapicomponentto the API Component CI class.
Customers can utilize the IntegrationHub ETL app to review and manage these data maps efficiently.
Data Load Methods
The connector supports both full and delta data loads for API information:
- Full Load: Retrieves all API-related data and populates CMDB tables, executed initially and can be scheduled repeatedly by customizing the "Reset Last Run Datetime for SG-Akamai" scheduled script.
- Delta Load: Fetches only data changes since the last import and is run on subsequent scheduled imports to optimize performance.
Scheduled script executions can be managed through the sysautoscript.list in the ServiceNow navigation filter.
Practical Benefits for ServiceNow Customers
- Centralizes API security data within ServiceNow CMDB, improving visibility and management of API risks.
- Enables automated, ongoing synchronization of Akamai API Security data, supporting both full and incremental updates.
- Provides monitoring and troubleshooting tools for integration health and data accuracy.
- Supports integration with ServiceNow’s API Insights for enhanced API governance and security use cases.
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.