VMWare CloudHealth
App Vendor: VMWare
App Category: Cloud Security
Connector Version: 1.0.0
API Version: V1, V2
Hostname:https://chapi.cloudhealthtech.com
Default Port: 443
About App
The VMWare CloudHealth app allows security teams to integrate with the VMWare CloudHealth enterprise application, to manage resource utilization and costs across cloud environments through the use of related actions.
The VMWare CloudHealth app is configured with CSOL application to perform the below-listed actions:
Action Name | Description |
|---|---|
Get a list of queryable reports | This action can be used to retrieve a list of standard OLAP reports that can be queried. |
Get a list of Reports of a specific type | This action can be used to retrieve a list of available standard OLAP Reports of a specify type. |
Get data for Standard Report | This action can be used to retrieve the data for a specific Standard Report. |
Get data for Custom Standard Report | This action can be used to retrieve the data for a Custom Standard Report. |
Search for Assets | This action can be used to search and retrieve Assets that match specific criteria using a search query. |
Get a single Asset | This action can be used to retrieve the attributes and related assets for a single asset object. |
Get a list of queryable Assets | This action can be used to retrieve the API names of all queryable AWS, Azure, Data Center, and Google Cloud asset objects. |
Get a single Policy violation | This action can be used to retrieve a single Policy violation and a list of all Assets and Resources affected by the violation. |
Get all Policy violations | This action can be used to retrieve a list of all Policy violations generated by a Policy block. |
Get all Policy Blocks | This action can be used to retrieve a list of all Policy Blocks for a Policy. |
Get all Policies | This action can be used to retrieve a list of all Policies in the organization. |
Get all organizations | This action can be used to retrieve a list of all organizations, including the number of accounts assigned in the CloudHealth Platform. |
Get a single AWS account | This action can be used to retrieve information of a single AWS account that is enabled in the CloudHealth platform. |
Get a list of all AWS accounts | This action can be used to retrieve a list of all AWS accounts that are enabled in the CloudHealth platform. |
Prerequisites
All the actions configured in the VMWare CloudHealth app relate to private APIs. VMWare CloudHealth Enterprise subscription is required to access the private APIs.
Configuration parameters
Below is the list of configuration parameters that are required for the VMWare CloudHealth app to communicate with the VMWare CloudHealth application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required / Optional | Comments |
|---|---|---|---|---|
API Key | Enter the VMWare CloudHealth API Key. | Text | Required |
Action: Get a list of queryable reports
This action can be used to retrieve a list of standard Online Analytical Processing (OLAP) reports that can be queried.
Request Parameters
Parameter | Description | Field Type | Required / Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the organization ID. | Text | Required | By default, the ID of the default organization is taken. |
Action: Get a list of Reports of a specific type
This action can be used to retrieve a list of available standard OLAP Reports of a specific type.
Request Parameters
Parameter | Description | Field Type | Required / Optional | Comments |
|---|---|---|---|---|
Report type | Enter the report type. | Text | Required | Allowed values:
|
Organization ID | Enter the organization ID. | Text | Optional | By default, the ID of the default organization is taken. |
Example Request
[
{
"report_type": "cost"
}
]Action: Get data for Standard Report
This action can be used to retrieve the data of a specific Standard Report.
Request Parameters
Parameter | Description | Field Type | Required / Optional | Comments |
|---|---|---|---|---|
Report type | Enter the report type. | Text | Required | Allowed values:
|
Report ID | Enter the report ID. | Integer | Required | |
Query parameters | Enter the query parameters in the form of key-value pairs to filter the Standard Report data that is being retrieved. | Key Value | Optional | Allowed values:
|
Example Request
[
{
"report_type": "cost"
"query_params":
{
"measures": [
{
"name":"usage_quantity",
"label":"# Instances"
}],
"interval": "daily"
}
}
]Action: Get data for Custom Standard Report
This action can be used to retrieve the data for a Custom Standard Report.
Request Parameters
Parameter | Description | Field Type | Required / Optional | Comments |
|---|---|---|---|---|
Report ID | Enter the report ID. | Integer | Required | |
Query parameters | Enter the query parameters in the form of key-value pairs to filter the Custom Standard Report data that is being retrieved. | Key Value | Optional | Allowed values:
|
Example Request
[
{
"query_params":
{
"measures": [
{
"name":"usage_quantity",
"label":"# Instances"
}],
"interval": "daily"
}
}
]Action: Search for Assets
This action can be used to search and retrieve Assets that match specific criteria using a search query.
Request Parameters
Parameter | Description | Field Type | Required / Optional | Comments |
|---|---|---|---|---|
Asset name | Enter the asset name. For example, “AWSInstance”. | Text | Required | |
Search query | Enter the search query. For example, “query=name='MyAccount'+and+is_private=0”. | Any | Required | Criteria for finding assets of a particular asset object type are specified as "query=[field value][operator][value]". |
Query parameters | Enter the query parameters in the form of key-value pairs to filter the Assets being retrieved. | Key Value | Optional | Allowed values:
|
Example Request
[
{
"asset_name": "AWSInstance",
"query": "query=name='MyAccount'+and+is_private=0",
"extra_params":
{
"page": 1,
"per_page": 100,
"api_version": 2
}
}
]Action: Get a single Asset
This action can be used to retrieve the attributes and related assets for a single asset object.
Request Parameters
Parameter | Description | Field Type | Required / Optional | Comments |
|---|---|---|---|---|
Asset name | Enter the asset name. For example, “AWSInstance”. | Text | Required | |
Organization ID | Enter the organization ID. | Text | Required | By default, the ID of the default organization is taken. |
Example Request
[
{
"asset_name": "AWSInstance"
}
]Action: Get a list of queryable Assets
This action can be used to retrieve the API names of all queryable AWS, Azure, Data Center, and Google Cloud asset objects.
Request Parameters
Parameter | Description | Field Type | Required / Optional | Comments |
|---|---|---|---|---|
Organization ID | Enter the organization ID | Text | Required | By default, the ID of the default organization is taken. |
Action: Get a single Policy violation
This action can be used to retrieve a single policy violation and a list of all Assets and Resources affected by the violation.
Request Parameters
Parameter | Description | Field Type | Required / Optional | Comments |
|---|---|---|---|---|
Policy ID | Enter the Policy ID. | Integer | Required | |
Policy block ID | Enter the Policy block ID. | Integer | Required | |
Violation ID | Enter the violation ID. | Integer | Required | |
Query parameters | Enter the query parameters in the form of key-value pairs to filter the Policy violation being retrieved. | Key Value | Optional | Allowed values:
|
Example Request
[
{
"query_params":
{
"per_page": 100,
"page": 12
}
}
]Action: Get all Policy violations
This action can be used to retrieve a list of all Policy violations generated by a policy block.
Request Parameters
Parameter | Description | Field Type | Required / Optional | Comments |
|---|---|---|---|---|
Policy ID | Enter the Policy ID. | Integer | Required | |
Policy block ID | Enter the Policy block ID. | Integer | Required | |
Query parameters | Enter the query parameters in the form of key-value pairs to filter the Policy violations being retrieved. | Key Value | Optional | Allowed values:
|
Example Request
[
{
"query_params":
{
"per_page": 100,
"page": 12
}
}
]Action: Get all Policy Blocks
This action can be used to retrieve a list of all Policy Blocks for a Policy.
Request Parameters
Parameter | Description | Field Type | Required / Optional | Comments |
|---|---|---|---|---|
Policy ID | Enter the Policy ID. | Integer | Required | |
Query parameters | Enter the query parameters in the form of key-value pairs to filter the Policy Blocks being retrieved. | Key Value | Optional | Allowed values:
|
Example Request
[
{
"query_params":
{
"per_page": 100,
"page": 12
}
}
]Action: Get all Policies
This action can be used to retrieve a list of all Policies in the organization.
Request Parameters
Parameter | Description | Field Type | Required / Optional | Comments |
|---|---|---|---|---|
Query parameters | Enter the query parameters in the form of key-value pairs. | Key Value | Optional | Allowed values:
|
Example Request
[
{
"query_params":
{
"per_page": 100,
"page": 12
}
}
]Action: Get all organizations
This action can be used to retrieve a list of all organizations, including the number of accounts assigned in the CloudHealth Platform.
Request Parameters
Parameter | Description | Field Type | Required / Optional | Comments |
|---|---|---|---|---|
Query parameters | Enter the query parameters in the form of key-value pairs to filter the organizations being retrieved.. | Key Value | Optional | Allowed values:
|
Example Request
[
{
"query_params":
{
"per_page": 100,
"page": 12,
}
}
]Action: Get a single AWS account
This action can be used to retrieve information of a single AWS account that is enabled in the CloudHealth platform.
Request Parameters
Parameter | Description | Field Type | Required / Optional | Comments |
|---|---|---|---|---|
AWS account ID | Enter the AWS account ID. | Integer | Required |
Action: Get a list of all AWS accounts
This action can be used to retrieve a list of all AWS accounts that are enabled in the CloudHealth platform.
Request Parameters
Parameter | Description | Field Type | Required / Optional | Comments |
|---|---|---|---|---|
Query parameters | Enter the query parameters in the form of key-value pairs to filter the AWS accounts being retrieved. | Key Value | Optional | Allowed values:
|
Example Request
[
{
"query_params":
{
"per_page": 100,
"page": 12
}
}
]