Cloudaware REST API

This article instructs you on how to activate access to the Cloudaware REST API and invoke the API methods using HTTP requests. Sample use case: create incidents in Cloudaware when a specific instance is overutilized.

1 Create API Key
2 Configure Incident Webhook Integration in Cloudaware
3 API Explorer

Create API Key

The API key is required for performing requests to Cloudaware API.

1. Create a Google Cloud Project account (for this purpose, a free trial account will work).

2. Submit an access request to support@cloudaware.com providing the email associated with your Google Cloud Project account.

3. Once the access is granted, enable the API. Go to Google Console → APIs & Services → Library → filter by Private:

4. Select external.endpoints.cloudaware-vm.cloud.goog → Enable.

5. Generate API key. Go back to APIs & Services → Credentials → +Create credentials → API Key.

6. Copy the API Key to the clipboard.

Configure Incident Webhook Integration in Cloudaware

1. Log in to your Cloudaware account → Admin.

2. Scroll down to Other integrations → CloudAware Incident Webhook. Click +Add.

3. Type the Name* for your Integration. Click Save.

*This name will be populated to Incident Source Provider field on the 'CloudAware Incident' object. It may also help you to find the source provider of each created incident, if you have several accounts.

4. Replace {API_KEY} part from URL with API Key from your Google Cloud project (see step 5). This will be the URL for the HTTP requests.

API Explorer

The Google APIs Explorer is a tool allowing you to explore and test APIs.

1. Go to Google APIs Explorer.

2. Select Set API key / OAuth 2.0 Client ID. Click Save.

3. Select Custom credentials and insert your API key. Click Save.

4. Services → External API v1 → external.incidents.create.

5. Insert the required parameters. Use tips (the question mark sign) on every field to insert the correct values.

As for our use case we would like to create incidents for the overutilized instances, the subject "CPUUtilization is too high on {InstanceName} is used.

6. Select Execute without OAuth or Authorize and execute depending on your API method.

7. Check a new incident in your Cloudaware account.