Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 5 Next »


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


Getting started


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


3. Once the access is granted, enable the API. Go to https://console.cloud.google.com → 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


CloudAware Setup


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 using this link.


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 parameters and the Request body value.

As for our Use Case we would like to create incidents for the overutilized instances, the subject will be "CPUUtilization is too high on eoduat-eu-central-db.RDS.eu-central (instance name)"). You can also see the tips under the question mark on every field from the Request body helping you to insert the correct values.



Note: Your Webhook key was generated in CloudAware

  1. Execute the request without OAuth (or Authorize and execute if it is required by your API method).


  1. Check the new incident in your org:




  • No labels