Azure API Reference Guide

Below is the list of CloudCheckr API calls specific to Microsoft Azure.

Click here for additional information about CloudCheckr API methods


Other API methods

alert/add_cost_alert*
alert/delete_cost_alert*

* these calls are not compatible with Multi-Account Views.

TROUBLESHOOTING

For help with troubleshooting common API issues, click here.


API CALLS

GET ALL API ENDPOINTS

The API method “get_all_api_endpoints” is used to return a complete list of all available CloudCheckr API calls and their parameters.

The preferred HTTP method for this call is GET.

XML call:

https://api.cloudcheckr.com/api/help.xml/get_all_api_endpoints?access_key=[access_key]

JSON call:

https://api.cloudcheckr.com/api/help.json/get_all_api_endpoints?access_key=[access_key]

INPUT PARAMETERS

This call accepts these parameters:

  • access_key (required) – Either a General or Admin-Level Access Key is required for this call.

OUTPUT

XML Example:

<ArrayOfControllerContainer
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <ControllerContainer>
        <controller_name>best_practice</controller_name>
        <api_calls>
            <ApiCall>
                <method_name>get_best_practices</method_name>
                <param_names>
                    <string>(admin level)access_key</string>
                    <string>date</string>
                    <string>aws_account_ids</string>
                    <string>all_result</string>
                    <string>importance</string>
                    <string>category</string>
                </param_names>
            </ApiCall>
        </api_calls>
    </ControllerContainer>
    <ControllerContainer>
        <controller_name>help</controller_name>
        <api_calls>
            <ApiCall>
                <method_name>get_resources_cloudformation_details</method_name>
                <param_names>
                    <string>date</string>
                    <string>aws_account_ids</string>
                    <string>max_results</string>
                </param_names>
            </ApiCall>
        </api_calls>
    </ControllerContainer>
</ArrayOfControllerContainer>

JSON Example:

[
  {
    "controller_name": "best_practice",
    "api_calls": [
      {
        "method_name": "get_best_practices",
        "param_names": [
          "(admin level)access_key",
          "date",
          "aws_account_ids",
          "all_result",
          "importance",
          "category"
        ]
      }
    ]
  },
  {
    "controller_name": "inventory",
    "api_calls": [
      {
        "method_name": "get_resources_cloudformation_details",
        "param_names": [
          "date",
          "aws_account_ids",
          "max_results"
        ]
      }
    ]
  }
]