Developers & DevOps Quick Start
Use this guide to start integrating Cloudaware into CI/CD workflows, infrastructure-as-code processes, and custom automation. It focuses on the minimum sequence needed to access Cloudaware data safely, automate repeatable work, and connect events to engineering systems.
Before You Start
Confirm that you have:
- Access to a Cloudaware account and the automation features you plan to use.
- An approved authentication method for API access.
- A clear use case, such as onboarding cloud accounts, querying CMDB data, exporting findings, opening tickets, or triggering remediation.
- Development, test, and production boundaries for automation.
- Agreement on which objects, fields, modules, and environments the integration may read or change.
- A logging, monitoring, and rollback plan for automated workflows.
Learn The Data And API Model
Start by understanding the Cloudaware object model and API entry points before building automation.
Address to these guides:
Prefer scoped credentials and test against a narrow object set before expanding automation.
Configure API Access
Choose the authentication pattern that matches your security requirements and runtime.
Use:
- External Client App With Client Credentials Flow
- External Client App With JWT Bearer Flow
- Connected App With Client Credentials Flow
- RBAC
- Least-Privilege Patterns
Record the integration owner, credential rotation process, allowed scopes, and expected call volume.
Automate Cloud And CMDB Operations
Start with repeatable workflows that reduce manual onboarding and validation work.
Common starting points:
- Add or update cloud accounts using the guide Add Cloud Accounts Using Cloudaware APIs.
- Validate inventory with CMDB Queries.
- Extend the CMDB with Custom Objects, Calculated Attributes, and Enrichment Rules.
- Track configuration changes with Change Events and History & Audit.
Keep automated writes small, observable, and reversible until the workflow is proven.
Integrate CI/CD And Developer Tools
Connect engineering systems when Cloudaware context should inform build, deployment, or remediation workflows.
Use:
Useful CI/CD patterns include checking required tags before deployment, linking repositories to CMDB applications, exporting policy findings into work queues, and triggering remediation playbooks when Cloudaware events meet a defined condition.
Build Event-Driven Workflows
Use events when teams need to react to changes, findings, alerts, or operational signals without polling.
Start with:
Define event filters, delivery targets, retry behavior, and ownership before routing production events.
Extend Collection With Breeze Agent
Use Breeze Agent when automation or module workflows need OS-level telemetry, local execution, or endpoint context.
Start with:
Coordinate agent rollout with administrators and operations teams because Breeze data can support CMDB, vulnerability, patch, monitoring, and intrusion detection workflows.
Publish Automation Views
Create operational views that make automation behavior visible:
- API integrations, owners, credentials, and last successful runs.
- Failed API requests, throttling, permission errors, and retry queues.
- Webhook delivery success, failures, and downstream ticket creation.
- Automated CMDB changes and related change history.
- CI/CD controls by repository, application, environment, or owner.
Use CMDB Queries & Reporting, Advanced Analytics, Change Tracking, and Audit Access.
Next Steps
- Work with administrators through the Administrators Quick Start when automation needs new permissions or tenant configuration.
- Work with cloud engineers through the Cloud Engineers Quick Start when automation depends on inventory freshness or tagging standards.
- Use Troubleshooting for common API, integration, and connectivity issues.