Target tables for storing API Service Graph Connector for AWS API Gateway data

  • 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 Target Tables for Storing API Service Graph Connector for AWS API Gateway Data

    This document outlines the target tables used to store data from the API Service Graph Connector for AWS API Gateway within ServiceNow. Once the integration is set up, data is periodically pulled from the AWS API Gateway and stored in various tables, primarily extending the Configuration Item (CI) classes.

    Show full answer Show less

    Key Features

    • AWS API Gateway Table: Collects attributes such as ID, Name, and Operational Status.
    • Managed API Table: Stores details like Life Cycle Stage Status, Version, Base URL, and Operational Status.
    • API Frontend Table: Contains data on Host, Method, Path, URL, and Operational Status.
    • API Backend Table: Holds attributes such as ID, URL, and Operational Status.
    • API Consumer Table: Captures Consumer ID and Username.
    • API Consumer Access Table: Links API and API Consumer data.
    • API Deployment Table: Records the Name and associated API.
    • API Policy Table: Maintains information on Policies related to Managed APIs.
    • Key Value Table: Stores key-value pairs for additional data attributes.

    Key Outcomes

    By utilizing these tables, ServiceNow customers can effectively manage and analyze AWS API Gateway data, enhancing visibility into API relationships and operational status. This structured data storage enables improved decision-making and operational efficiency regarding API management and deployment.

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

    AWS API Gateway [cmdb_ci_aws_api_gateway]

    The following attributes in the AWS API Gateway [cmdb_ci_aws_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 AWS API Gateway
    Parent class Relationship type Child class
    AWS API Gateway [cmdb_ci_aws_api_gateway] Provides::Provided by Managed API [cmdb_ci_managed_api]
    AWS API Gateway [cmdb_ci_aws_api_gateway] Reference API Policy [api_policy]
    AWS API Gateway [cmdb_ci_aws_api_gateway] Reference API Consumer [api_consumer]
    AWS API Gateway [cmdb_ci_aws_api_gateway] Uses::Used by DNS Alias [cmdb_ci_dns_alias]

    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

    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
    Life Cycle Stage Status life_cycle_stage_status
    ID id
    Name name
    Base URL base_url
    Operational status operational_status
    Life Cycle Stage life_cycle_stage
    Model ID model_id
    Type type
    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] Reference Key Value [cmdb_key_value]

    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
    Host host
    Method method
    Path path
    URL url
    Authorization authorization
    Name name
    Operational status operational_status
    Protocol protocol
    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 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
    ID id
    URL url
    Name name
    Operational status operational_status
    Type type

    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
    API Gateway api_gateway

    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
    API api
    API Consumer api_consumer
    State state

    API Deployment [api_deployment]

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

    API Policy [api_policy]

    The following attributes in the API Policy [api_policy] table are populated by collected data:
    Attribute label Attribute name
    Name name
    Consumer consumer
    ID id
    Managed API managed_api
    Table 4. Relationship created for API Policy
    Parent class Relationship type Child class
    API Policy [api_policy] Reference Managed API [cmdb_ci_managed_api]

    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
    Key key
    Value value