Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Info

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

Table of Contents

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. Provide . Submit an access request to support@cloudaware.com providing the email associated with your Google your Google Cloud Project account submitting an access request to support@cloudaware.com

3. Once the access is granted, enable  enable the API. Go to https://console.cloud.google.comGo to Google Console → APIs & Services → Library → filter by Private.:Image Removed

...

4. Select  Select external.endpoints.cloudaware-vm.cloud.goog Enable.Image Removed

...

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

Image Removed

...


6.  Copy the API Key to the clipboard.Image Removed

...

Configure Incident Webhook Integration in Cloudaware

1. Log in to your Cloudaware account → Admin.Image Removed

...

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

...

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

...

Note

*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.Image Removed

...

API Explorer

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

1. Go  Go to Google APIs Explorer using this link.

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

...

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

...

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

Image Removed

...

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

...

As for our use case we would like to create incidents for the overutilized instances, the subject "CPUUtilization is too high on eoduat-eu-central-db.RDS.eu-central{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.Image Removed

...