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​

Add Cloud Accounts Using Cloudaware External APIs when an external application or automation workflow needs to onboard cloud accounts without using the Cloudaware UI.

This path covers:

  • Obtaining an OAuth access token.
  • Configuring API credentials.
  • Calling Cloudaware External API operations.
  • Testing requests with Google APIs Explorer.

Use this pattern when the primary goal is to create or manage cloud account connections at scale.

CMDB API OAuth Apps​

Use OAuth-based access when external tools need authenticated access to Cloudaware CMDB data through Salesforce APIs. The detailed setup depends on whether you use an External Client App, JWT bearer flow, client credentials flow, or a legacy connected app. For details, see Connect to Cloudaware CMDB API.

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

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:
  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.