Target tables for storing API Service Graph Connector for Apigee Edge data

  • Release version: Zurich
  • Updated July 20, 2026
  • 3 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 Target tables for storing API Service Graph Connector for Apigee Edge data

    This guide details the target tables used by the API Service Graph Connector for Apigee Edge in the ServiceNow platform. After setting up the connection, the integration periodically pulls data from an Apigee Edge application and stores it in specific tables. These tables extend from the Configuration Item [cmdbci] classes and include other non-CMDB tables to represent various API components and their relationships.

    Show full answer Show less

    Key Tables and Their Purpose

    • Apigee API Gateway [cmdbciapigeeapigateway]: Stores details about the API gateway, such as ID, name, and operational status. It relates to Managed API, API Consumer, API Consumer Subscription, and API Product Bundle tables, indicating the gateway’s connections and provisions.
    • Managed API [cmdbcimanagedapi]: Captures attributes like ID, name, description, base URL, version, environment, lifecycle stage, and operational status. It connects to API Frontend, API Backend, API Deployment, and DNS Alias tables, representing the usage and deployment details of managed APIs.
    • API Deployment [apideployment]: Contains the API name and associated API reference, representing deployment information.
    • DNS Alias [cmdbcidnsalias]: Holds DNS alias name and operational status linked to APIs, supporting network identity management.
    • API Backend [cmdbciapibackend]: Stores backend API details including name, URL, type, internet-facing status, and operational status, linked with API Frontend endpoints.
    • API Frontend [cmdbciapifrontend]: Records frontend API details with attributes like name, version, host, method, path, URL, protocol, description, internet-facing flag, and operational status. It relates to API Backend as endpoints.
    • API Product Bundle [cmdbciapiproductbundle]: Contains product bundle information such as ID, name, description, creation and modification dates, access and approval types, and operational status. It contains Managed APIs and is used by API Consumer Subscriptions.
    • Key Value [cmdbkeyvalue]: Stores key-value pairs associated with configuration items, supporting metadata storage.
    • API Consumer Subscription [cmdbciapiconsumersubscription]: Includes subscription details like ID, name, associated API Consumer, creation and modification dates, and discovered state. It references Key Value entries.
    • API [cmdbciapi]: Contains correlation IDs for API identification.
    • API Consumer Access [apiconsumeraccess]: Captures access details including authentication method, state, validity, and references to API, API Consumer, API Product Bundle, and API Consumer Subscription.
    • API Consumer [apiconsumer]: Stores consumer details such as ID, username, email, associated API Gateway, registration date, and discovered state.

    Relationships Between Tables

    The data model defines important relationships to represent dependencies and associations within the API ecosystem:

    • Apigee API Gateway provides Managed APIs, references API Consumers, and provides API Consumer Subscriptions and Product Bundles.
    • Managed API uses API Frontend, Backend, DNS Alias, and references API Deployment.
    • API Frontend uses API Backend endpoints.
    • API Product Bundle contains Managed APIs and is used by API Consumer Subscriptions.
    • API Consumer Subscription references Key Value pairs.

    Practical Benefits for ServiceNow Customers

    By understanding these tables and their relationships, ServiceNow customers can:

    • Effectively track and manage Apigee Edge API components and their lifecycle within the CMDB.
    • Gain visibility into API deployments, configurations, and consumption across their environment.
    • Leverage the structured data to support incident, change, and configuration management processes related to APIs.
    • Enhance governance and operational insight into API gateways, consumers, subscriptions, and product bundles.

    When you complete setting up the connection, you can configure the integration to periodically pull data from an Apigee Edge application. The data is saved in tables that extend from the Configuration item [cmdb_ci] classes and other non-CMDB tables.

    Apigee API Gateway [cmdb_ci_apigee_api_gateway]

    The following attributes in the Apigee API Gateway [cmdb_ci_apigee_api_gateway] table are populated by collected data:
    Attribute label Attribute name
    ID id
    Name name
    Operational status operational_status
    Table 1. Relationships created for Apigee API Gateway
    Parent class Relationship type Child class
    Apigee API Gateway [cmdb_ci_apigee_api_gateway] Provides::Provided by Managed API [cmdb_ci_managed_api]
    Apigee API Gateway [cmdb_ci_apigee_api_gateway] Reference API Consumer [api_consumer]
    Apigee API Gateway [cmdb_ci_apigee_api_gateway] Provides::Provided by API Consumer Subscription [cmdb_ci_api_consumer_subscription]
    Apigee API Gateway [cmdb_ci_apigee_api_gateway] Provides::Provided by API Product Bundle [cmdb_ci_api_product_bundle]

    Managed API [cmdb_ci_managed_api]

    The following attributes in the Managed API [cmdb_ci_managed_api] table are populated by collected data:
    Attribute label Attribute name
    ID id
    Name name
    Description short_description
    Base URL base_url
    Version version
    Type type
    Environment environment
    Model ID model_id
    Correlation ID correlation_id
    Life Cycle Stage life_cycle_stage
    Life Cycle Stage Status life_cycle_stage_status
    Operational status operational_status
    Table 2. Relationships created for Managed API
    Parent class Relationship type Child class
    Managed API [cmdb_ci_managed_api] Uses::Used by API Frontend [cmdb_ci_api_frontend]
    Managed API [cmdb_ci_managed_api] Uses::Used by API Backend [cmdb_ci_api_backend]
    Managed API [cmdb_ci_managed_api] Reference API Deployment [api_deployment]
    Managed API [cmdb_ci_managed_api] Uses::Used by DNS Alias [cmdb_ci_dns_alias]

    API Deployment [api_deployment]

    The following attributes in the API Deployment [api_deployment] table are populated by collected data:
    Attribute label Attribute name
    API api
    Name name

    DNS Alias [cmdb_ci_dns_alias]

    The following attributes in the DNS Alias [cmdb_ci_dns_alias] table are populated by collected data:
    Attribute label Attribute name
    Name name
    Operational status operational_status

    API Backend [cmdb_ci_api_backend]

    The following attributes in the API Backend [cmdb_ci_api_backend] table are populated by collected data:
    Attribute label Attribute name
    Name name
    URL url
    Type type
    Internet facing internet_facing
    Operational status operational_status

    API Frontend [cmdb_ci_api_frontend]

    The following attributes in the API Frontend [cmdb_ci_api_frontend] table are populated by collected data:
    Attribute label Attribute name
    Name name
    API Version api_version
    Host host
    Method method
    Path path
    URL url
    Protocol protocol
    Description short_description
    Internet facing internet_facing
    Operational status operational_status
    Table 3. Relationship created for API Frontend
    Parent class Relationship type Child class
    API Frontend [cmdb_ci_api_frontend] Use End Point To::Use End Point From API Backend [cmdb_ci_api_backend]

    API Product Bundle [cmdb_ci_api_product_bundle]

    The following attributes in the API Product Bundle [cmdb_ci_api_product_bundle] table are populated by collected data:
    Attribute label Attribute name
    ID id
    Name name
    Description short_description
    Creation Date creation_date
    Last Modified Date last_modified_date
    Discovered Access Type discovered_access_type
    Discovered Approval Type discovered_approval_type
    Operational status operational_status
    Table 4. Relationships created for API Product Bundle
    Parent class Relationship type Child class
    API Product Bundle [cmdb_ci_api_product_bundle] Contains::Contained by Managed API [cmdb_ci_managed_api]
    API Product Bundle [cmdb_ci_api_product_bundle] Used by::Uses API Consumer Subscription [cmdb_ci_api_consumer_subscription]
    API Product Bundle [cmdb_ci_api_product_bundle] Reference Key Value [cmdb_key_value]

    Key Value [cmdb_key_value]

    The following attributes in the Key Value [cmdb_key_value] table are populated by collected data:
    Attribute label Attribute name
    Configuration item configuration_item
    Key key
    Value value
    Tag tag

    API Consumer Subscription [cmdb_ci_api_consumer_subscription]

    The following attributes in the API Consumer Subscription [cmdb_ci_api_consumer_subscription] table are populated by collected data:
    Attribute label Attribute name
    ID id
    Name name
    API Consumer api_consumer
    Creation Date creation_date
    Last Modified Date last_modified_date
    Discovered State discovered_state
    Table 5. Relationship created for API Consumer Subscription
    Parent class Relationship type Child class
    API Consumer Subscription [cmdb_ci_api_consumer_subscription] Reference Key Value [cmdb_key_value]

    API [cmdb_ci_api]

    The following attribute in the API [cmdb_ci_api] table is populated by collected data:
    Attribute label Attribute name
    Correlation ID source_native_key

    API Consumer Access [api_consumer_access]

    The following attributes in the API Consumer Access [api_consumer_access] table are populated by collected data:
    Attribute label Attribute name
    Auth Method access_type
    State state
    Valid to valid_to
    API api
    API Consumer api_consumer
    API Product Bundle api_product_bundle
    API Consumer Subscription api_consumer_subscription

    API Consumer [api_consumer]

    The following attributes in the API Consumer [api_consumer] table are populated by collected data:
    Attribute label Attribute name
    ID id
    Username username
    Email email
    API Gateway api_gateway
    Registration Date registration_date
    Discovered State discovered_state