This site will be decommissioned on December 31st 2024. After that date content will be available at techdocs.broadcom.com.

How to get started with VMware Aria Automation for Secure Clouds APIs

VMware Aria Automation for Secure Clouds provides public APIs documented through a user-friendly Swagger interface for its customers to query cloud account findings, rules, and compliance information to create advanced reports and automation. The APIs expose a powerful query engine that enables users to derive meaningful insights about the state of their cloud setup. Customers can use these APIs to integrate the power of the connected threat model with their favorite tools.

API authorization

All VMware Aria Automation for Secure Clouds APIs use a common authorization model. This article outlines how to set up an access token for yourself so you can use the APIs.

Get an API access token

In order to call the APIs, users need to set up the appropriate API authorization for their account. These are the steps:

  1. Go to VMware Cloud Services Platform (CSP) and click Generate Token. This takes you to the “Generate a New API Token” page.

    Generate API token page

  2. Select either All Roles or the VMware Aria Automation for Secure Clouds service roles and click Generate.

  3. A new API token is now created that you can use for authorization. Copy and store this in a safe place.

    API token secret value

  4. Next, make a web request to VMware CSP to provision a temporary access token using the new API token as described here:

curl -X POST \
  https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize \
  -d refresh_token={api_token}

Response body

{
    "id_token": "eyJ...",
    "token_type": "bearer",
    "expires_in": 1799,
    "scope": "...",
    "access_token": "{access_token}",
    "refresh_token": "{api_token}"
}

From the response body, extract the access_token. This is used to make an authenticated call to VMware Aria Automation for Secure Clouds APIs to gather insights about your cloud infrastructure. You can use this any time an API call example in one of our guides calls for an {access_token} variable.

Now you can start making your own calls from any of the following API sets:

check-circle-line exclamation-circle-line close-line
Scroll to top icon