Skip to main content

APIs & Connections Overview

Use Cloudaware APIs and connection methods to onboard cloud accounts, access CMDB data, exchange events with external systems, and connect resources in private networks.

This section helps you select an integration pattern and identify the access, credentials, permissions, and network path required before implementation.

info
  • Audience: Cloudaware administrators, DevOps, integration owners
  • Outcome: The integration approach is selected, and the required access, credentials, and network path are identified

Prerequisites​

Before you begin, make sure you have:

  • Access to a Cloudaware account.
  • Administrator access for the area you plan to configure, such as Cloudaware Admin, Setup (Salesforce), or an integration-specific settings page.
  • Agreement on the data flow:
    • Source and destination systems.
    • Objects, fields, events, or accounts that will be read or updated.
    • Required permissions and ownership for the integration identity.
  • A secure place to store credentials, API keys, client secrets, certificates, or webhook signing secrets.
  • Network access between Cloudaware and the external system, or a plan to use an agent or tunnel when private endpoints are involved.

Use Cases​

Use Cloudaware-supported connection methods when you need to:

  • Add or manage cloud accounts programmatically.
  • Query CMDB records, relationships, and module data from external tools.
  • Export Cloudaware data to data warehouses, SIEM, ITSM platforms, or reporting systems.
  • Send incidents, alerts, or events into Cloudaware from third-party systems.
  • Connect private endpoints that are not directly reachable from Cloudaware.
  • Automate recurring operational workflows without manual UI steps.

Choose a Connection Pattern​

Select a pattern based on the system you need to connect and the direction of the data flow.

Cloudaware APIs​

Set Up External API Access when you need to interact with Cloudaware programmatically using an external application, script, or automation workflow.

This path covers:

  • Obtaining a Cloudaware OAuth token.
  • Enabling access to the Cloudaware External API.
  • Configuring a Google Cloud API key.
  • Setting up Google APIs Explorer.
  • Calling and testing supported External API operations.

Use this pattern when you need programmatic access to Cloudaware for workflows such as managing cloud accounts, checking TunHub tunnel status, or using other supported external APIs.

CMDB API OAuth Apps​

Connect to Cloudaware CMDB API to give external tools authenticated access to Cloudaware CMDB data through Salesforce APIs. The required setup depends on the authentication method you use, such as an External Client App with JWT bearer flow or client credentials flow, or a legacy Connected App.

Use this pattern to query or update CMDB objects, fields, relationships, and module data through a configured application.

Webhooks​

Use webhooks when external systems need to send incidents, alerts, or events into Cloudaware for correlation and automation.

Typical sources include:

  • Monitoring and observability platforms.
  • Security and incident detection tools.
  • IT service management systems.
  • Custom applications and automation services.

Agents and Tunnels​

Use agent-assisted or tunnel-based connections when Cloudaware must communicate with systems that are not directly accessible over public networks.

For private connectivity, see TunHub and Breeze guides.

High-Level Implementation Flow​

  1. Define the integration goal and data direction: read from Cloudaware, write to Cloudaware, or exchange events both ways.
  2. Select the appropriate connection pattern:
    • Use Cloudaware External APIs for programmatic cloud account onboarding, checking statuses of TunHub tunnels, and other use cases.
    • Use OAuth apps for authenticated CMDB API access.
    • Use webhooks for event or incident ingestion.
    • Use TunHub when private network access is required.
  3. Prepare access and permissions for the integration identity or receiving endpoint.
  4. Configure credentials, scopes, keys, certificates, or webhook secrets.
  5. Test the connection with a small query, request, event, or account payload.
  6. Add monitoring, ownership, and rotation procedures for long-running integrations.
On this page