Admin API Reference Guide

CloudCheckr allows for the creation of two different types of access keys. Account-level access keys can only make calls against a single account. Admin-level access keys allow users to make calls against any of their accounts within CloudCheckr. They also allow API users to make account-management related calls that cannot be executed using account-level access keys.

New API Documentation Structure

CloudCheckr is revamping its API documentation to ensure that it reflects the best practices for REST and to improve overall consistency. We will restructure each call to include these sections:

Section	Description
Input Parameters	Options that you pass with the endpoint to influence a response. Identifies if a parameter is required or optional, the data type, and the parameter description.
API Call URL	Identifies the common path for the API (highlighted in yellow) and the end path of the endpoint (highlighted in light blue).
Request Example	Includes a sample request that shows the endpoint and a few key parameters. Formatted in curl since it’s language-agnostic. Includes the header information and the method (GET or POST in most cases).
Response Example	Shows a sample response for all of the parameters passed in the request example. Includes examples in XML and JSON.

Attempting to make any of these calls using a general API access key will result in an error. You may also use admin-level API keys to make the other calls found in the general API Reference guide.

XML Call:

https://api.cloudcheckr.com/api/best_practice.xml/get_best_practices?access_key=[access_key]&use_account=[MyAccount]

https://api.cloudcheckr.com/api/best_practice.xml/get_best_practices?access_key=[access_key]&use_cc_account_id=[MyAccountId]

JSON Call:

https://api.cloudcheckr.com/api/best_practice.json/get_best_practices?access_key=[access_key]&use_account=[MyAccount]

https://api.cloudcheckr.com/api/best_practice.json/get_best_practices?access_key=[access_key]&use_cc_account_id=[MyAccountId]

Using Access Keys

CloudCheckr requires an access key to be passed as a parameter to all API calls.

Click here for details on creating and managing access keys.

Example of Using an Access Key:

https://api.cloudcheckr.com/api/change_monitoring.json/get_changes?access_key=[access_key]

Preferred HTTP Methods

When using libraries such as curl, you may need to indicate the HTTP method to use (POST or GET). The CloudCheckr API accepts both POST and GET in most API calls. However, we recommend you use the preferred HTTP method when possible.

The preferred HTTP method for each call is GET unless specifically noted in the API CALLS section.

For more information on HTTP methods, click here:  http://www.w3schools.com/tags/ref_httpmethods.asp.

API Calls

Add Access Control Lists Per Account Per Group

The API method, “add_access_control_lists_per_account_per_group”, is used to add access control lists per account per group.

The preferred HTTP method for this call is POST.

INPUT PARAMETERS:

API CALL URL:

https://api.cloudcheckr.com/api/account.[json|xml]/add_access_control_lists_per_account_per_group?access_key=your_admin_access_key&use_account=AWS Main

REQUEST EXAMPLE:

curl -X POST \

                -- https://api.cloudcheckr.com/api/account.[json|xml]/add_access_control_lists_per_account_per_group?
                   access_key=your_admin_access_key&use_account=AWS Main\

                -- header 'cache-control: no-cache' \

                -- header 'content-type: application/[json|xml]' \

                -- data '{

                    "group_id": "315ED648-DA56-4713-98DB-7D0A434A31F9",

                    "acls": ["dd82ecd7-c590-490f-9b3a-f22990a1b500[CC_Delimiter]16b586a1-4459-46e1-b348-8c24dd5cfb7f",

                    "dd82ecd7-c590-490f-9b3a-f22990a1b500[CC_Delimiter]e5c59d38-f3a1-4aac-aa48-a9823c1413ed"]
                    

RESPONSE EXAMPLE:

XML:

<AddAccessControlListsPerAccountPerGroupResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance>
          <results>
          <id>315ed648-da56-4713-98db-7d0a434a31f9<
          /id>
          <code>
          0<
          /code>
          <message>
          null<
          /message>
          <
          /results>
          </AddAccessControlListsPerAccountPerGroupResponse>
          

JSON:

{
              "Id": "315ed648-da56-4713-98db-7d0a434a31f9",
              "Code": 0,
              "Message": null
          }

Add Account V3

The API method, “add_account_v3”, is used to register an AWS account with CloudCheckr. This method will return a unique ID, “cc_account_id”, to enhance security for the newly-created account. Customers can use “cc_account_id” for the parameter, “use_cc_account_id”, when making calls to the admin-level API.

INPUT PARAMETERS:

API CALL URL:

https://api.cloudcheckr.com/api/account.[json|xml]/add_account_v3?access_key=your_admin_access_key

REQUEST EXAMPLE:

curl -X POST \
               -- https://api.cloudcheckr.com/api/account.[json|xml]/add_account_v3?access_key=your_admin_access_key&use_cc_account_id=1234\
               -- header 'cache-control: no-cache' \
               -- header 'content-type: application/[json|xml]' \
               -- data '{
                  "account_name": "api added aws account",
              }

RESPONSE EXAMPLE:
XML:

<AddAccountV3Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance> <
          status>
             <account_status>Success</account_status>
             <cc_account_id>38</cc_account_id>
             <credential_status>No credentials given. Can use the following role_account_id and role_external_id to create cross-account role within AWS.</credential_status>
             <role_account_id>352813966789</role_account_id>
             <cc_external_id>CC-69CFBFCA8BF21FA123BA566A6DAAB227</cc_external_id>
          </status>
          </AddAccountV3Response>

JSON:

{
             "account_status": "Success",
             "cc_account_id": 38,
             "credential_status": "No credentials given. Can use the following role_account_id and role_external_id to create cross-account role within AWS.",
             "role_account_id": "352813966789",
             "cc_external_id": "CC-69CFBFCA8BF21FA123BA566A6DAAB227"
          }

Add API Key

The API method, “add_api_key”, is used to create a new CloudCheckr API key for a specific account.

The preferred HTTP method for this call is POST.

XML Call:

https://api.cloudcheckr.com/api/account.xml/add_api_key?access_key=[access_key]&accounts=[account_name]

JSON Call:

https://api.cloudcheckr.com/api/account.json/add_api_key?access_key=[access_key]&accounts=[account_name]

INPUT PARAMETERS
This call accepts these parameters:

• access_key (required) – standard access key required for all API calls.
• accounts (required) – name(s) of the account(s) for which an API key is being created. Accepts multiple accounts.

OUTPUT
XML Example:

<AddApiKeyResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
              <CreationStatuses>
                  <string>
          Created access key for Account: [ACCOUNT] Key: [ACCESS_KEY]
          </string>
              </CreationStatuses>
          </AddApiKeyResponse>
          

JSON Example:

{
             "CreationStatuses": [
                "Created access key for Account: [ACCOUNT] Key: [ACCESS_KEY]"
             ]
          }

Add Custom Usage Rate

The API method, "add_custom_usage_rates", is used to add the Custom Usage Rate.

This API endpoint offers the capability to Bulk Insert the Custom Usage Rate. You shall pass the below parameters as a List of Custom Usage Rate objects as shown in the sample request object below.

The preferred HTTP method for this call is POST.

INPUT PARAMETERS:

API CALL URL:

https://api.cloudcheckr.com/api/billing.json/add_custom_usage_rates

JSON REQUEST EXAMPLE:

curl --request POST \
               --'https://api.cloudcheckr.com/api/billing.[json|xml]/add_custom_usage_rates?use_cc_account_id=7&access_key=your_admin_access_key' \
               --header 'cache-control: no-cache'\
               --header 'content-type: application/[json|xml]'\
               --data '
           [
          {
                         "Description":"TEST DESCRIPTION",
                         "ChargeValue": 5,
                         "FilterType" : "Account",
                         "StartDate":"2013-01-01",
                         "EndDate":"2014-01-01",
                         "Account":[
                                     "123456789123",
                                     "234567891234",
                                     "345678912345"
                                ],
                        "Region":[
                                    "16",
                                    "4",
                                    "2"
                                ],
                                   "UsageType":[
                                   "CAN1-EUC1-AWS-Out-Bytes",
                                   "HeavyUsage:m4.large",
                                   "UGW1-TimedStorage-RRS-ByteHrs"
                               ],
                                  "Operation":[
                                  "SetQueueAttributes",
                                  "RunInstances:0002:SV012",
                                  "PutObject"
                              ],
                                 "AWSService":[
                                 "AmazonSimpleDB",
                                 "AmazonEC2",
                                 "AmazonSQS"
                             ],
                         
          },
          {
          			"StartDate": "9/1/2024",
          			"ChargeValue": "20",
          			"Description": "Desciption",
          			"FilterType" : "Account",
          			"Account": "123456789123",
          }
          ]
            }
          

OUTPUT & RESPONSE:

{
          	"OperationResult": [
            {
          "ObjectId": 95,
          "IsSuccess": true, "Message": "Custom Usage Rate added succesfully"
            }, {
          "ObjectId": 96,"IsSuccess": true,
          "Message": "Custom Usage Rate added succesfully"
          } ]
          
          }
          

Add MAV Account

The API method, “add_mav_account”, is used to create a new Multi-View Account (MAV).

Important: This call can only be made using admin-level access keys.

The preferred HTTP method for this call is POST.

XML Call:

https://api.cloudcheckr.com/api/account.xml/add_mav_account?access_key=[access_key]&account_name=[account_name]

JSON Call:

https://api.cloudcheckr.com/api/account.json/add_mav_account?access_key=[access_key]&account_name=[account_name]

INPUT PARAMETERS
This call accepts these parameters:

• access_key (required) – Admin-level access key required for all API calls.
• account_name (required) – name of the new MAV account(s).
• account_tags_to_set (optional) – comma-separated list of tags to apply to the MAV. The tag must exist.
• for_all_accounts (optional) – true or false or 1 or 0 values. Same impact as having the “This Multi-Account View should include ALL ACCOUNTS” checked in the UI.

OUTPUT

XML & JSON Example:

{

          "Code":200,

          "Message":"OK"

          }
          

Add Tag

The API method, “add_tag”, is used to create and enable an account-level tag and apply this tag to account(s), which you can use to build Multi-Account Views (MAVs).

The preferred HTTP method for this call is POST.

INPUT PARAMETERS:

API CALL URL:

	https://api.cloudcheckr.com/api/account.[json|xml]/add_tag

REQUEST EXAMPLE:

curl -- request POST \

               -- 'https://api.cloudcheckr.com/api/account.[json|xml]/add_tag?access_key=your_admin_access_key&tag_name=my_tag_name&    account_name=my_account_name&accounts=account 1, account 2&use_cc_account_id=1234' \

               -- header 'cache-control: no-cache' \

               -- header 'content-type: application/[json|xml]' \

               -- data '{

                         "tag_name": Production Tag,

                         "account_name": Production Account, 

                         "accounts": Prod 1, Prod 2 

                        }'

RESPONSE EXAMPLE:

	{

            "Code": 200,

            "Message": "OK"

          }

Add User

The API method, “add_user”, creates a new CloudCheckr user.

The preferred HTTP method for this call is POST.

INPUT PARAMETERS:

API CALL URL:

https://api.cloudcheckr.com/api/account.[json|xml]/add_user?access_key=your_admin_access_key

REQUEST EXAMPLE:

curl -X POST \

               -- https://api.cloudcheckr.com/api/account.[json|xml]/add_user?access_key=your_admin_access_key&use_cc_account_id=1234\

               -- header 'cache-control: no-cache' \

               -- header 'content-type: application/[json|xml]' \

               -- data '{

                 "email": "newUser@cloudcheckr.com",

                 "account_access": "AWS Main - Payer,123456789012,Test",

                 "user_role": "user",

                 "cost_report": "no",

                 "auth_types": "saml",

                 "group": "g2",

                 "use_default_provider": "true",

                 "sso_provider": "PingOne"

                  }
                  

RESPONSE EXAMPLE:
XML:

<AddUserResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance> <CreationStatuses>Created new user with email: newUser@cloudcheckr.com</CreationStatuses>
          </AddUserResponse>
          

JSON:

{
              "CreationStatuses": [
                  "Created new user with email: newUser32i34i32ke@cloudcheckr.com"
              ]
          }

Add Users

The API method, “add_users”, creates multiple CloudCheckr users.

The preferred HTTP method for this call is POST.

INPUT PARAMETERS:

API CALL URL:

https://api.cloudcheckr.com/api/account.[json|xml]/add_users?access_key=your_admin_access_key

REQUEST EXAMPLE:

curl -X POST \

               -- https://api.cloudcheckr.com/api/account.[json|xml]/add_users?access_key=your_admin_access_key&use_cc_account_id=1234\

               -- header 'cache-control: no-cache' \

               -- header 'content-type: application/[json|xml]' \

               -- data '{

                 "emails": "newUser@cloudcheckr.com,newuser2@cloudcheckr.com,newuser3@cloudcheckr.com",

                 "account_access": "AWS Main,2150 - Payer,123456789012,987654321012,Test",

                 "user_role": "user",

                 "cost_report": "no",

                 "group": "g2",

                 "use_default_provider": 'true",

                 "sso_provider": "PingOne"

                  }
                  

RESPONSE EXAMPLE:
XML:

<AddUsersResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance> <CreationStatuses>
             <status>Created new user with email: newUser48f@cloudcheckr.com</status>
             <status>Created new user with email: newUserk39dk@cloudcheckr.com</status>
          </CreationStatuses>
          </AddUsersResponse>
          

JSON:

{
              "CreationStatuses": [
                  "Created new user with email: newUser48f@cloudcheckr.com@cloudcheckr.com",
                  "Created new user with email: newUserk39dk@cloudcheckr.com"
              ]
          }

Add User To Group

The API method, “add_user_to_group”, is used to add an existing CloudCheckr user to a new group.

The preferred HTTP method for this call is POST.

INPUT PARAMETERS:

API CALL URL:

https://api.cloudcheckr.com/api/account.[json|xml]/add_user_to_group

REQUEST EXAMPLE:

curl -- request POST \

               -- 'https://api.cloudcheckr.com/api/account.[json|xml]/add_user_to_group?access_key=[your_access_key]&use_cc_account_id=3&user_ids=[some values]&group_id=[some value]\ \

               -- header 'cache-control: no-cache' \

               -- header 'content-type: application/[json|xml]' \

               -- data '{

                         "group_id": "e85446b9-8821-41a6-9558-7550756dd899",

                         "user_ids":  [

                         "8B65E388-8A0B-4B5A-A12B-8B0325D0ABF4",

                         "683C1113-1FF0-4F8B-AA3D-9288D2ED615A"

                          ]

                       }'

RESPONSE EXAMPLE:

XML:

<AddUserToGroupResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

             <status>

               <Code>200</Code>

               <Message>OK</Message>

             </status>

          </AddUserToGroupResponse>

JSON:

{

              "Code": 200,

              "Message": "OK"

          }
          

Clone Group

The API method, “clone_group”, creates a copy of an existing group without the users.

The preferred HTTP method for this call is POST.

INPUT PARAMETERS:

ENDPOINT URL:

https://api.cloudcheckr.com/api/account.[json|xml]/clone_group

JSON/XML CALL EXAMPLE:

curl --request POST \

            -- 'https://api.cloudcheckr.com/api/account.[json|xml]/clone_group?access_key=your_admin_access_key&use_cc_account_id=1234'\

            -- header 'cache-control: no-cache' \

            -- header 'content-type: application/[json|xml]' \

            -- data '{

          	"(required)access_key": "someValHere",

                  "(required)group_id": "someValHere",

          	"(required)name": "someValHere",

          	"use_account": "someValHere",

          	"use_cc_account_id": "someValHere",

          	"use_aws_account_id": "someValHere",

                	}
          

SUCCESSFUL JSON/XML RESPONSE:

{

              "Code": 200,

              "Message": "OK"

          }
          

Configure Custom Cost

The API method, "configure_custom_cost", is used to configure the custom cost settings for a CloudCheckr account.

The preferred HTTP method for this call is POST.

INPUT PARAMETERS:

ENDPOINT URL:

https://api.cloudcheckr.com/api/billing.[json|xml]/configure_custom_cost

JSON/XML CALL EXAMPLE:

curl --request POST \

               --'https://api.cloudcheckr.com/api/billing.[json|xml]/configure_custom_cost?access_key=your_admin_access_key&use_cc_account_id=7'\
 
              --header'cache-control: no-cache'\

               --header'content-type: application/[json|xml]'\
 
              --data'{

                       "CostType":"Unblended",

                       "CustomCostRIAmortization":"Disabled",
 
                      "RIUnsharing":"Disabled",

                       "EnforceEc2RIVolume":"false",

                       "UncompressPricingTiers":"false",

                       "SPAllocation":"Disabled", 

                       "use_cc_account_id":"7"

                        }'

SUCCESSFUL JSON/XML RESPONSE:

{

           "Code":"200",

           "Message": "OK"

           }

Copy User

The API method “copy user” is used to create a new CloudCheckr user with the exact permissions as an existing user.

IMPORTANT: This call can only be made using admin-level access keys.

The preferred HTTP method for this call is POST.

XML call:

https://api.cloudcheckr.com/api/account.xml/copy_user?access_key=[access_key]&email_to_copy=[existing_user_email]&emails=[new_user_email]

JSON call:

https://api.cloudcheckr.com/api/account.json/copy_user?access_key=[access_key]&email_to_copy=[existing_user_email]&emails=[new_user_email]

INPUT PARAMETERS

This call accepts these parameters:

• access_key (required) – Admin-Level Access Key is required for this call.
• email_to_copy (required) – The email address of the existing user.
• emails (required) – The email address(es) of the new user(s).
• use_account (required — either this field or ‘use_cc_account_id’) – The name of the AWS account within CloudCheckr.
• use_cc_account_id (required — either this field or ‘use_account’) – The CloudCheckr ID number for the AWS account within the application.

You can also use this call to add multiple users at once. Simply include all of the emails required, separated by commas.

OUTPUT

XML Example:

<CopyUserResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance> <CreationStatuses>Created new user with email: mytest@mytest.me</CopyUserResponse>
          

JSON Example:

{

              "CreationStatuses": [

                  "Created new user with email: mytest@mytest.me"

              ]

          }
          

Delete Access Control List From Group

The API method, “delete_access_control_list_from_group”, is used to delete an access control list from a group.

The preferred HTTP method for this call is POST.

INPUT PARAMETERS:

API CALL URL:

https://api.cloudcheckr.com/api/account.[json|xml]/delete_access_control_list_from_groupaccess_key=your_admin_access_key&use_account=AWS Main

REQUEST EXAMPLE:

curl -X POST \

            -- https://api.cloudcheckr.com/api/account.[json|xml]/delete_access_control_list_from_group?access_key=your_admin_access_key&use_account=AWS Main\

            -- header 'cache-control: no-cache' \

            -- header 'content-type: application/[json|xml]' \

            -- data '{

          	"group_id": "315ED648-DA56-4713-98DB-7D0A434A31F9",

                  "acls": ["dd82ecd7-c590-490f-9b3a-f22990a1b500[CC_Delimiter]16b586a1-4459-46e1-b348-8c24dd5cfb7f",

                  "dd82ecd7-c590-490f-9b3a-f22990a1b500[CC_Delimiter]e5c59d38-f3a1-4aac-aa48-a9823c1413ed"]

                        	}
          

RESPONSE EXAMPLE:
XML:

<DeleteAccessControlListFromGroupResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <Status>
                <Code>200</Code>
                <Message>OK</Message>
             </Status>
          </DeleteAccessControlListFromGroupResponse>
          

JSON:

{

              "Code": 200,

              "Message": "OK"

          }

Delete Account

The API method “delete_account” is used to remove an AWS account that has been registered with CloudCheckr.

IMPORTANT: This call can only be made using Admin-Level Access Keys.

The preferred HTTP method for this call is GET.

XML call:

https://api.cloudcheckr.com/api/account.xml/delete_account?access_key=[access_key]&account_name=MyAccountName

JSON call:

https://api.cloudcheckr.com/api/account.json/delete_account?access_key=[access_key]&account_name=MyAccountName

INPUT PARAMETERS

This call accepts these parameters:

• access_key (required) – Admin-Level Access Key is required for this call.
• account_name (required) – the name of the AWS account that will be removed from CloudCheckr.

OUTPUT

XML & JSON Example:

{

          "Code":200,

          "Message":"OK"

          }

Delete Custom Usage Rate

The API method, “delete_custom_usage_rate”, is used to delete an existing custom usage rate.

You can perform a bulk delete using via this endpoint. Check the below sample request object for reference.

The preferred HTTP method for this call is POST.

INPUT PARAMETERS:

API CALL URL:

https://api.cloudcheckr.com/api/billing.json/delete_custom_usage_rates

JSON EXAMPLE:

curl-- request Delete \    'https://api.cloudcheckr.com/api/billing.[json|xml]/delete_custom_usage_rate?access_key=access_key]& use_cc_account_id=1234' \   
           --header 'cache-control: no-cache'\    --header 'content-type: application/[json|xml]'\    
          --data '
          [ {	"Id": 94}, {“id” : 95} ]
          

OUTPUT & RESPONSE:

{
          "OperationResult": [
          {
          "ObjectId": 94,
          "IsSuccess": true,
          "Message": "Custom Usage Rate for the provided Id succesfully deleted"
          },
          {
          "ObjectId": 95,
          "IsSuccess": true,
          "Message": "Custom Usage Rate for the provided Id succesfully deleted"
          }
          
          ]
          }
          

Delete Group

The API method, “delete_group”, is used to delete the group with the specified ID.

The preferred HTTP method for this call is POST.

INPUT PARAMETERS:

ENDPOINT URL:

https://api.cloudcheckr.com/api/account.[json|xml]/delete_group

JSON/XML CALL EXAMPLE:

curl --request POST \

            -- 'https://api.cloudcheckr.com/api/account.[json|xml]/delete_group?access_key=your_admin_access_key&use_cc_account_id=1234'\

            -- header 'cache-control: no-cache' \

            -- header 'content-type: application/[json|xml]' \

            -- data '{

          	"(required)(admin level)access_key": "someValHere",

                  "(required)group_id": "someValHere",

          	"email": "someValHere",

          	"user_id": "someValHere",

          	"use_account": "someValHere",

          	"use_cc_account_id": "someValHere",

          	"use_aws_account_id": "someValHere",

                     }
          

SUCCESSFUL JSON/XML RESPONSE:

{

              "Code": 200,

              "Message": "OK"

          }
          

Delete Tag

The API method, “delete_tag”, is used to delete an account-level tag in Multi-Account Views. If you delete an account-level tag, it will impact any account that uses this tag to build its Multi-Account Views (MAVs).

The preferred HTTP method for this call is POST.

INPUT PARAMETERS:

ENDPOINT URL:

https://api.cloudcheckr.com/api/account.[json|xml]/delete_tag

JSON/XML CALL EXAMPLE:

curl --request POST \

            -- 'https://api.cloudcheckr.com/api/account.[json|xml]/delete_tag?access_key=[access key]

            -- header 'cache-control: no-cache' \

            -- header 'content-type: application/[json|xml]' \

            -- data '{

          	'account_name': 'my account name',

                  'account_tag': 'my account tag'

                 	}
          

SUCCESSFUL JSON/XML RESPONSE:

{

              "Code": 200,

              "Message": "OK"

          }
          

Edit Account Email Settings V2

The API method, “edit_account_email_settings_v2”, allows you to identify what conditions will trigger an email notification, how often you want CloudCheckr to send these notifications, and who will receive these notifications.

The preferred HTTP method for this call is POST.

INPUT PARAMETERS:

API CALL URL:

https://api.cloudcheckr.com/api/account.[json|xml]/edit_account_email_settings_v2

curl -- request POST \

               -- 'https://api.cloudcheckr.com/api/account.[json|xml]/edit_account_email_settings_v2?access_key=your_admin_access_key&use_aws_account_id=123451050627&emails=email_addresses' \

               -- header 'cache-control: no-cache' \

               -- header 'content-type: application/[json|xml]' \

               -- data '{

                          "emails": "this@mailbox.com,that@mailbox.com",

                          "use_aws_account_id": "123451050627"

                          }

RESPONSE EXAMPLES:

Result 200 OK (XML):

	<edit_account_email_settings_v2Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

              <status>

                  <Code>200</Code>

                  <Message>OK</Message>

              </status>

          </edit_account_email_settings_v2Response>

Result 200 OK (JSON):

	{

            "Code": 200,

            "Message": "OK"

          }

Edit Account Name

The API method, “edit_accountname”, is used to edit the account name to better fit with the naming conventions used within your deployment.

The preferred HTTP method for this call is POST.

INPUT PARAMETERS:

ENDPOINT URL:

https://api.cloudcheckr.com/api/account.[json|xml]/edit_accountname

JSON/XML CALL EXAMPLE:

curl --request POST \

            -- https://api.cloudcheckr.com/api/account.[json|xml]/edit_accountname?access_key=[access key]

            -- header 'cache-control: no-cache' \

            -- header 'content-type: application/[json|xml]' \

            -- data '{

          	'account_name': CloudCheckr Support',

                 	}
          

SUCCESSFUL JSON/XML RESPONSE:

{

              "Code": 200,

              "Message": "OK"

          }
          

Edit Credential

The API method, “edit_credential”, is used to add or change the AWS credentials on an AWS account that has been registered with CloudCheckr.

Note:

• The HTTP method for this call is POST.

INPUT PARAMETERS:

API CALL URL:

https://api.cloudcheckr.com/api/account.[json|xml]/edit_credential/

REQUEST EXAMPLE:

curl --request POST \  

          				  -- 'https://api.cloudcheckr.com/api/account.[json|xml]/edit_credential?access_key=your_admin_access_key

SUCCESSFUL JSON/XML RESPONSE:

{

              "Code": 200,

              "Message": "OK"

          }
          

Edit Custom Usage Rate

The API method, “edit_custom_usage_rates”, is used to edit a custom usage rate.

This API endpoint offers the capability to Bulk Edit the Custom Usage Rate. You shall pass the below parameters as a List of Custom Usage Rate objects as shown in the sample request object below.

The preferred HTTP method for this call is POST.

INPUT PARAMETERS:

API CALL URL:

https://api.cloudcheckr.com/api/billing.json/edit_custom_usage_rates

JSON CALL EXAMPLE:

curl --request POST \
                --url 'https://api.cloudcheckr.com/api/billing.[json|xml]/edit_custom_usage_rates?access_key=your_admin_access_key&use_cc_account_id=1234' \
                --header 'cache-control: no-cache' \
                --header 'content-type: application/[json|xml]' \
                --data '
          [ 
          {
          	               	"id": 179,
          	               " ChargeValue": 42
          },
          {
          		"id": 35,
          	               " Description": “Changes Description”,
          		“ChargeValue”:”25”
          }
          ]
          }
          

OUTPUT & RESPONSE:

{
          "OperationResult": [
          {
          "ObjectId": 95,
          "IsSuccess": true,
          "Message": "Custom Usage Rate Updated succesfully"
          },
          {
          "ObjectId": 124,
          "IsSuccess": true,
          "Message": "Custom Usage Rate Updated succesfully"
          }
          
          ]
          }
          

Get Access Control List

The API method, “get_access_control_list”, configures which features of the application are visible and accessible for an account.

The preferred HTTP method for this call is POST.

INPUT PARAMETERS:

API CALL URL:

https://api.cloudcheckr.com/api/account.[json|xml]/get_access_control_list

REQUEST EXAMPLE:

curl -- request POST \

               -- 'https://api.cloudcheckr.com/api/account.json/get_access_control_list' \

               -- header 'access_key: [access key]' \

               -- header 'content-type: application/json' \

               -- data '{

          
                         "section": "Savings",

                         "use_cc_account_id": "3"

                        }
          

RESPONSE EXAMPLES:

<?xml version="1.0" encoding="UTF-8" ?>

                  <responseModel>

                      <Id>02xxxxxx-7953-4932-88d5-0d54fdf01c51[CC_Delimiter]cedd1593-75d5-48d1-a48c-e17</xxxxxxxxxxx>

                      <Name>Cost Savings</Name>

                      <Section>Savings</Section>

                      <Code>0</Code>

                      <Message />

                  </responseModel>

                  <responseModel>

                      <Id>02bxxxxxx-7953-4932-88d5-0d54fdf01c51[CC_Delimiter]da61a4df-d4be-4a57-9e6a-xxxxxxxxxxxx</Id>

                      <Name>Cost Savings</Name>

                      <Section>Savings</Section>

                      <Code>0</Code>

                      <Message />

                  </responseModel>

                  <responseModel>

                      <Id>02bxxxxx-7953-4932-88d5-0d54fdf01c51[CC_Delimiter]f3dc0618-c139-4f28-99d5-xxxxxxxxxxxx</Id>

                      <Name>Cost Savings</Name>

                      <Section>Savings</Section>

                      <Code>0</Code>

                      <Message />

                  </responseModel>

                  <responseModel>

                      <Id>02bxxxxx-7953-4932-88d5-0d54fdf01c51[CC_Delimiter]6feaacf0-e136-48c4-90b1-xxxxxxxxxxxx</Id>

                      <Name>Cost Savings</Name>

                      <Section>Savings</Section>

                      <Code>0</Code>

                      <Message />

                  </responseModel>

          	<Code>200</Code>

          	<Message>OK</Message>

          	
 
            
            

{

              "responseModel": [

                  {

                      "Id": "02xxxxxx-7953-4932-88d5-0d54fdf01c51[CC_Delimiter]cedd1593-75d5-48d1-a48c-e17",

                      "Name": "Cost Savings",

                      "Section": "Savings",

                      "Code": 0,

                      "Message": null

                  },

                  {

                      "Id": "02bxxxxxx-7953-4932-88d5-0d54fdf01c51[CC_Delimiter]da61a4df-d4be-4a57-9e6a-xxxxxxxxxxxx",

                      "Name": "Cost Savings",

                      "Section": "Savings",

                      "Code": 0,

                      "Message": null

                  },

                  {

                      "Id": "02bxxxxx-7953-4932-88d5-0d54fdf01c51[CC_Delimiter]f3dc0618-c139-4f28-99d5-xxxxxxxxxxxx",

                      "Name": "Cost Savings",

                      "Section": "Savings",

                      "Code": 0,

                      "Message": null

                  },

                  {

                      "Id": "02bxxxxx-7953-4932-88d5-0d54fdf01c51[CC_Delimiter]6feaacf0-e136-48c4-90b1-xxxxxxxxxxxx",

                      "Name": "Cost Savings",

                      "Section": "Savings",

                      "Code": 0,

                      "Message": null

                  }

              ],

              "Code": 200,

              "Message": "OK"

          }    
              

Get Access Control List By ID

The API method, “get_access_control_list_by_id”, is used to return the access control list by ID.

The preferred HTTP method for this call is POST.

INPUT PARAMETERS:

ENDPOINT URL:

https://api.cloudcheckr.com/api/account.[json|xml]/get_access_control_list_by_id

JSON/XML CALL EXAMPLE:

curl --request POST \

            -- 'https://api.cloudcheckr.com/api/account.[json|xml]/get_access_control_list_by_id&access_key=your_admin_access_key&use_cc_account_id=1234'\

            -- header 'cache-control: no-cache' \

            -- header 'content-type: application/[json|xml]' \

            -- data '{

          	"(required)(admin level)access_key": "someValHere",

          	"(required)id": "someValHere",

          	"use_account": "someValHere",

          	"use_cc_account_id": "someValHere",

          	"use_aws_account_id": "someValHere",

          	}
          

SUCCESSFUL JSON/XML RESPONSE:

{

              "Code": 200,

              "Message": "OK"

          }
          

Get Access Control List Per Group

The API method, “get_access_control_list_per_group”, is used to return the access control list by group.

The preferred HTTP method for this call is POST.

INPUT PARAMETERS:

API CALL URL:

https://api.cloudcheckr.com/api/account.[json|xml]/get_access_control_list_per_group?access_key=your_admin_access_key&use_account=AWS Main&group_id=315ED648-DA56-4713-98DB-7D0A434A31F9

REQUEST EXAMPLE:

curl -X GET \

               -- https://api.cloudcheckr.com/api/account.[json|xml]/get_access_control_list_per_group?access_key=your_admin_access_key&use_account=AWS Main&group_id=315ED648-DA56-4713-98DB-7D0A434A31F9\

               -- header 'cache-control: no-cache' \

               -- header 'content-type: application/[json|xml]' \
          

RESPONSE EXAMPLE:
XML:

<GetAccessControlListPerGroupResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance>
               <acl>
                 <id>dd82ecd7-c590-490f-9b3a-f22990a1b500[CC_Delimiter]bde7a10b-6e76-4ce5-918c-5c4821b4f3bd</id>
                 <name>Inventory Summary</name>
                 <section>Inventory</section>
                 <code>0</code>
                 <message>null</message>
               </acl>
               <acl>
                 <id>dd82ecd7-c590-490f-9b3a-f22990a1b500[CC_Delimiter]4adf637d-667a-4530-a6a4-e8b4e5fcd340</id>
                 <name>Map Overlay</name>
                 <section>Inventory</section>
                 <code>0</code>
                 <message>null</message>
               </acl>
               <acl>
                 <id>dd82ecd7-c590-490f-9b3a-f22990a1b500[CC_Delimiter]08d18f15-1e86-40f7-bc8f-37f8bc27f1b7</id>
                 <nameTagged Resources</name>
                 <section>Inventory</section>
                 <code>0</code>
                 <message>null</message>
               </acl>
          </GetAccessControlListPerGroupResponse>
          

JSON:

{

              "Acls": [

                  {

                      "Id": "dd82ecd7-c590-490f-9b3a-f22990a1b500[CC_Delimiter]bde7a10b-6e76-4ce5-918c-5c4821b4f3bd",

                      "Name": "Inventory Summary",

                      "Section": "Inventory",

                      "Code": 0,

                      "Message": null

                  },

                  {

                      "Id": "dd82ecd7-c590-490f-9b3a-f22990a1b500[CC_Delimiter]4adf637d-667a-4530-a6a4-e8b4e5fcd340",

                      "Name": "Map Overlay",

                      "Section": "Inventory",

                      "Code": 0,

                      "Message": null

                  },

                  {

                      "Id": "dd82ecd7-c590-490f-9b3a-f22990a1b500[CC_Delimiter]08d18f15-1e86-40f7-bc8f-37f8bc27f1b7",

                      "Name": "Tagged Resources",

                      "Section": "Inventory",

                      "Code": 0,

                      "Message": null

                  }

               ]

          }
          

Get Account

The API method, "get_account", is used to determine when CloudCheckr last updated the data in a selected account.

The preferred HTTP method for this call is GET.

INPUT PARAMETERS:

API CALL URL:

https://api.cloudcheckr.com/api/account.[json|xml]/get_account

REQUEST EXAMPLE:

curl -- request GET \

                -- https://api.cloudcheckr.com/api/account.[json|xml]/get_account?access_key=your_admin_access_key&account_id=3'\

                -- header 'cache-control: no-cache' \

                -- header 'content-type: application/[json|xml]' \
          

RESPONSE EXAMPLE:
XML:

<?xml version="1.0" encoding="UTF-8" ?>

                  <Id>3</Id>

                  <Name>Test Payer</Name>

                  <Provider>Amazon Web Services</Provider>

                  <Type>General</Type>

                  <AccountId>000011050627</AccountId>

                  <HasCredentials>true</HasCredentials>

                  <Note></Note>

                  <LastUpdated>2020-11-27T01:38:45</LastUpdated>

                  <PayerId />

                  <PayerAccountId />

                  <Code>0</Code>

          	<Message />

          
          

JSON:

{

              "Id": 3,

              "Name": "Test Payer",

              "Provider": "Amazon Web Services",

              "Type": "General",

              "AccountId": "000011050627",

              "HasCredentials": true,

              "Note": "",

              "LastUpdated": "2020-11-27T01:38:45",

              "PayerId": null,

              "PayerAccountId": null,

              "Code": 0,

              "Message": null

          }

Get Account Email Settings

The API method, “get_account_email_settings”, is used to return a complete list of all email settings in a CloudCheckr account.

INPUT PARAMETERS:

API CALL URL:

https://api.cloudcheckr.com/api/account.[json|xml]/get_account_email_settings?access_key=your_admin_access_key&use_cc_account_id=1234'

REQUEST EXAMPLE:

curl -X GET \

                 -- https://api.cloudcheckr.com/api/account.[json|xml]/get_account_email_settings?access_key=your_admin_access_key&use_cc_account_id=1234'\

                 -- header 'cache-control: no-cache' \

                 -- header 'content-type: application/[json|xml]' \
                 

RESPONSE EXAMPLE:

XML:

<GetAccountEmailSettingsResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
              <accounts_and_email_settings>
                  <AccountAndEmailSettings>
                      <ProjectName>Account_Name_Example</ProjectName>
                      <EmailReportRecipients>
                          <EmailAddresses>email1@cloudcheckr.com, email2@cloudcheckr.com</EmailAddresses>
                      </EmailReportRecipients>
                      <AlertEmailSettings>
                          <EnableDailyCostAlert>true</EnableDailyCostAlert>
                          <AwsCostThreshold>10</AwsCostThreshold>
                          <EnableAwsHealthAlerts>false</EnableAwsHealthAlerts>
                          <EnableAwsHealthAlertsIfAffects>true</EnableAwsHealthAlertsIfAffects>
                      </AlertEmailSettings>
                      <DailyEmailSettings>
                          <EnableDailyChangeMonitoring>false</EnableDailyChangeMonitoring>
                          <EnableDailyBestPractice>false</EnableDailyBestPractice>
                          <EnableDailyBillForceUsingCloudWatch>false</EnableDailyBillForceUsingCloudWatch>
                          <EnableDailyAwsConsolidatedBillingSummary>true</EnableDailyAwsConsolidatedBillingSummary>
                          <EnableDailyChangeMonitoringAwsConfig>false</EnableDailyChangeMonitoringAwsConfig>
                          <EnableAutomation>false</EnableAutomation>
                          <EnableImproperlyTaggedResources>false</EnableImproperlyTaggedResources>
                          <EnableDailyCloudTrailSummary>false</EnableDailyCloudTrailSummary>
                          <DailyBestPracticeEmailSettings>
                              <EnableHighImportance>false</EnableHighImportance>
                              <EnableMediumImportance>false</EnableMediumImportance>
                              <EnableLowImportance>false</EnableLowImportance>
                              <EnableInformationalImportance>false</EnableInformationalImportance>
                              <EnableSecurityType>false</EnableSecurityType>
                              <EnableCostType>false</EnableCostType>
                              <EnableUsageType>false</EnableUsageType>
                              <EnableAvailabilityType>false</EnableAvailabilityType>
                              <EnableTrustedAdvisorType>false</EnableTrustedAdvisorType>
                          </DailyBestPracticeEmailSettings>
                      </DailyEmailSettings>
                      <WeeklyEmailSettings>
                          <EnableWeeklyInventory>true</EnableWeeklyInventory>
                          <EnableWeeklyS3Summary>true</EnableWeeklyS3Summary>
                          <EnableWeeklyEc2Trend>true</EnableWeeklyEc2Trend>
                          <EnableWeeklyS3Trend>false</EnableWeeklyS3Trend>
                          <EnableWeeklyEc2Utilization>true</EnableWeeklyEc2Utilization>
                          <EnableWeeklyBestPractice>false</EnableWeeklyBestPractice>
                          <WeeklyBestPracticeEmailSettings>
                              <EnableHighImportanceWeekly>false</EnableHighImportanceWeekly>
                              <EnableMediumImportanceWeekly>false</EnableMediumImportanceWeekly>
                              <EnableLowImportanceWeekly>false</EnableLowImportanceWeekly>
                              <EnableInformationalImportanceWeekly>false</EnableInformationalImportanceWeekly>
                              <EnableSecurityTypeWeekly>false</EnableSecurityTypeWeekly>
                              <EnableCostTypeWeekly>false</EnableCostTypeWeekly>
                              <EnableUsageTypeWeekly>false</EnableUsageTypeWeekly>
                              <EnableAvailabilityTypeWeekly>false</EnableAvailabilityTypeWeekly>
                          </WeeklyBestPracticeEmailSettings>
                      </WeeklyEmailSettings>
                      <MonthlyEmailSettings>
                          <EnableMonthlyCost>false</EnableMonthlyCost>
                          <EnableMonthlyAwsConsolidatedBillingSummary>false</EnableMonthlyAwsConsolidatedBillingSummary>
                          <EnableMonthlyBestPractice>false</EnableMonthlyBestPractice>
                          <DaysSelectedMonthly />
                          <MonthlyBestPracticeEmailSettings>
                              <EnableHighImportanceMonthly>false</EnableHighImportanceMonthly>
                              <EnableMediumImportanceMonthly>false</EnableMediumImportanceMonthly>
                              <EnableLowImportanceMonthly>false</EnableLowImportanceMonthly>
                              <EnableInformationalImportanceMonthly>false</EnableInformationalImportanceMonthly>
                              <EnableSecurityTypeMonthly>false</EnableSecurityTypeMonthly>
                              <EnableCostTypeMonthly>false</EnableCostTypeMonthly>
                              <EnableUsageTypeMonthly>false</EnableUsageTypeMonthly>
                              <EnableAvailabilityTypeMonthly>false</EnableAvailabilityTypeMonthly>
                          </MonthlyBestPracticeEmailSettings>
                      </MonthlyEmailSettings>
                  </AccountAndEmailSettings>
              </accounts_and_email_settings>
          </GetAccountEmailSettingsResponse>
          

JSON:

{

            "GetAccountEmailSettingsResponse": {

              "accounts_and_email_settings": {

                "AccountAndEmailSettings": {

                  "ProjectName": "Account_Name_Example",

                  "EmailReportRecipients": {

                    "EmailAddresses": "email1@cloudcheckr.com, email2@cloudcheckr.com"

                  },

                  "AlertEmailSettings": {

                    "EnableDailyCostAlert": "true",

                    "AwsCostThreshold": "10",

                    "EnableAwsHealthAlerts": "false",

                    "EnableAwsHealthAlertsIfAffects": "true"

                  },

                  "DailyEmailSettings": {

                    "EnableDailyChangeMonitoring": "false",

                    "EnableDailyBestPractice": "false",

                    "EnableDailyBillForceUsingCloudWatch": "false",

                    "EnableDailyAwsConsolidatedBillingSummary": "true",

                    "EnableDailyChangeMonitoringAwsConfig": "false",

                    "EnableAutomation": "false",

                    "EnableImproperlyTaggedResources": "false",

                    "EnableDailyCloudTrailSummary": "false",

                    "DailyBestPracticeEmailSettings": {

                      "EnableHighImportance": "false",

                      "EnableMediumImportance": "false",

                      "EnableLowImportance": "false",

                      "EnableInformationalImportance": "false",

                      "EnableSecurityType": "false",

                      "EnableCostType": "false",

                      "EnableUsageType": "false",

                      "EnableAvailabilityType": "false",

                      "EnableTrustedAdvisorType": "false"

                    }

                  },

                  "WeeklyEmailSettings": {

                    "EnableWeeklyInventory": "true",

                    "EnableWeeklyS3Summary": "true",

                    "EnableWeeklyEc2Trend": "true",

                    "EnableWeeklyS3Trend": "false",

                    "EnableWeeklyEc2Utilization": "true",

                    "EnableWeeklyBestPractice": "false",

                    "WeeklyBestPracticeEmailSettings": {

                      "EnableHighImportanceWeekly": "false",

                      "EnableMediumImportanceWeekly": "false",

                      "EnableLowImportanceWeekly": "false",

                      "EnableInformationalImportanceWeekly": "false",

                      "EnableSecurityTypeWeekly": "false",

                      "EnableCostTypeWeekly": "false",

                      "EnableUsageTypeWeekly": "false",

                      "EnableAvailabilityTypeWeekly": "false"

                    }

                  },

                  "MonthlyEmailSettings": {

                    "EnableMonthlyCost": "false",

                    "EnableMonthlyAwsConsolidatedBillingSummary": "false",

                    "EnableMonthlyBestPractice": "false",

                    "DaysSelectedMonthly": "",

                    "MonthlyBestPracticeEmailSettings": {

                      "EnableHighImportanceMonthly": "false",

                      "EnableMediumImportanceMonthly": "false",

                      "EnableLowImportanceMonthly": "false",

                      "EnableInformationalImportanceMonthly": "false",

                      "EnableSecurityTypeMonthly": "false",

                      "EnableCostTypeMonthly": "false",

                      "EnableUsageTypeMonthly": "false",

                      "EnableAvailabilityTypeMonthly": "false"

                    }

                  }

                }

              }

           }
           

Get Account Level Tags V2

The API method “get_account_level_tags_v2”, returns enabled account-level tags in three ways:

When called with only an access key, the call returns all account-level tags enabled in this customer, grouped by project name.

When called with a general account specified, the call returns all account-level tags enabled on that general account.

When called with a Multi-Account View specified, the call returns a list of accounts associated with the MAV and all enabled tags in the MAV.

Using call against general accounts:

The preferred HTTP method for this call is GET.

XML call:

https://api.cloudcheckr.com/api/account.xml/get_account_level_tags_v2?access_key=[access_key]

JSON call:

https://api.cloudcheckr.com/api/account.json/get_account_level_tags_v2?access_key=[access_key]

INPUT PARAMETERS

This call accepts these parameters:

• access_key (required) – Admin-Level Access Key is required for this call.
• use_account (optional) – Account name is used here; returns enabled account-level tags from specific account(s).

OUTPUT

XML Example:

<AccountLevelTagsReponse
                xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <AccountItems>
                     <AccountItem>
                          <AccountName>My General Account Name</AccountName>
                          <TagsNames>
                               <string>MyAccountLevelTag1</string>
                               <string>MyAccountLevelTag2</string>
                          </TagsNames>
                     </AccountItem>
                </AccountItems>
           </AccountLevelTagsReponse>

JSON Example:

{
           {AccountItems": [{"AccountName": "814089178758_IOC_PRD", "TagsNames": ["ISD", "USD Accounts", "All Intel Accounts", "All SSG Accounts]}]}
          
          
          
          

Using the call against Multi-Account Views:

XML call:

https://api.cloudcheckr.com/api/account.xml/get_account_level_tags_v2?access_key=[access_key]&use_account=[MAV account name]

JSON call:

https://api.cloudcheckr.com/api/account.json/get_account_level_tags_v2?access_key=[access_key]&use_account=[MAV account name]

INPUT PARAMETERS

This call accepts these parameters:

• access_key (required) – Admin-Level Access Key is required for this call.
• use_account (required)- Account name is used here; returns enabled account-level tags from MAV account(s).

OUTPUT

XML Example:

<AccountLevelTagsReponse
                xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <AccountItems>
                     <AccountItem>
                          <AccountName>My MAV Account Name</AccountName>
                          <TagsNames>
                               <string>MyAccountLevelTag1</string>
                               <string>MyAccountLevelTag2</string>
                          </TagsNames>
                     </AccountItem>
                </AccountItems>
           </AccountLevelTagsReponse>

JSON Example:

{
           "AccountLevelTagsReponse": {
             "-xmlns:xsd": "http://www.w3.org/2001/XMLSchema",
             "-xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
               "AccountItems": {
                 "AccountItem": {
                   "AccountName": "My MAV Account Name",
                   "TagsNames": {
                     "string": [
                       "MyAccountLevelTag1",
                       "MyAccountLevelTag2"
                     ]
                   }
                 }
               }
             }
           }
          

Get Accounts By Group

The API method, “get_accounts_by_group”, is used to return a list of accounts based by a group ID.

The preferred HTTP method for this call is POST.

INPUT PARAMETERS:

ENDPOINT URL:

https://api.cloudcheckr.com/api/account.[json|xml]/get accounts_by_group

JSON/XML CALL EXAMPLE:

curl --request POST \

            -- 'https://api.cloudcheckr.com/api/account.[json|xml]/get_accounts_by_group?access_key=your_admin_access_key&use_cc_account_id=1234'\

            -- header 'cache-control: no-cache' \

            -- header 'content-type: application/[json|xml]' \

            -- data '{

          	"(required)(admin-level)access_key": "someValHere",

          	"(required)group_id": "someValHere",

          	"use_account": "someValHere",

          	"use_cc_account_id": "someValHere",

          	"use_aws_account_id": "someValHere",

                   }
          

SUCCESSFUL JSON/XML RESPONSE:

{

              "Projects": [

                  {

                      "Id": 3,

                      "Name": "2150 AWS Prod",

                      "Provider": "Amazon Web Services",

                      "Type": "General",

                      "AccountId": "215011050627",

                      "HasCredentials": true,

                      "Note": "",

                      "LastUpdated": "2019-09-19T22:00:50"

                  },

                  {

                      "Id": 3,

                      "Name": "2150 AWS Prod",

                      "Provider": "Amazon Web Services",

                      "Type": "General",

                      "AccountId": "215011050627",

                      "HasCredentials": true,

                      "Note": "",

                      "LastUpdated": "2019-09-19T22:00:50"

                  },

                  {

                      "Id": 4,

                      "Name": "949 AWS Prod",

                      "Provider": "Amazon Web Services",

                      "Type": "General",

                      "AccountId": "949195593353",

                      "HasCredentials": true,

                      "Note": null,

                      "LastUpdated": "2019-09-19T13:58:42"

                  },

                  {

                      "Id": 4,

                      "Name": "949 AWS Prod",

                      "Provider": "Amazon Web Services",

                      "Type": "General",

                      "AccountId": "949195593353",

                      "HasCredentials": true,

                      "Note": null,

                      "LastUpdated": "2019-09-19T13:58:42"

                  },

                  {

                      "Id": 6,

                      "Name": "4430 AWS Prod",

                      "Provider": "Amazon Web Services",

                      "Type": "General",

                      "AccountId": "443094636793",

                      "HasCredentials": true,

                      "Note": null,

                      "LastUpdated": "2019-09-19T18:24:01"

                  },

                  {

                      "Id": 6,

                      "Name": "4430 AWS Prod",

                      "Provider": "Amazon Web Services",

                      "Type": "General",

                      "AccountId": "443094636793",

                      "HasCredentials": true,

                      "Note": null,

                      "LastUpdated": "2019-09-19T18:24:01"

                  },

                  {

                      "Id": 8,

                      "Name": "open-sales-int-field-poc",

                      "Provider": "Amazon Web Services",

                      "Type": "General",

                      "AccountId": "103237659442",

                      "HasCredentials": true,

                      "Note": "tesst",

                      "LastUpdated": "2019-09-19T18:18:50"

                  },

                  {

                      "Id": 821,

                      "Name": "China Test",

                      "Provider": "Amazon Web Services",

                      "Type": "General",

                      "AccountId": "281027638441",

                      "HasCredentials": true,

                      "Note": null,

                      "LastUpdated": "2017-05-16T15:07:50"

                  },

                  {

                      "Id": 938,

                      "Name": "DevOps Account",

                      "Provider": "Amazon Web Services",

                      "Type": "General",

                      "AccountId": "087544996801",

                      "HasCredentials": true,

                      "Note": null,

                      "LastUpdated": "2019-09-19T14:55:58"

                  },

                  {

                      "Id": 1522,

                      "Name": "Map To Payer",

                      "Provider": "Amazon Web Services",

                      "Type": "General",

                      "AccountId": "625072036134",

                      "HasCredentials": true,

                      "Note": null,

                      "LastUpdated": "2019-09-20T09:42:35"

                  },

                  {

                      "Id": 1536,

                      "Name": "183698509299",

                      "Provider": "Amazon Web Services",

                      "Type": "General",

                      "AccountId": "183698509299",

                      "HasCredentials": true,

                      "Note": null,

                      "LastUpdated": "2019-09-20T16:09:13"

                  },

                  {

                      "Id": 1537,

                      "Name": "245990094719",

                      "Provider": "Amazon Web Services",

                      "Type": "General",

                      "AccountId": "245990094719",

                      "HasCredentials": true,

                      "Note": null,

                      "LastUpdated": null

                  },

                  {

                      "Id": 1539,

                      "Name": "{\"Rowkey\":\"gy6x99zrwhea7r2s69xhjb861ejh3025\",\"Data\":\"+nj0zsTpqp20TR+3J5d/iQ==\"}",

                      "Provider": "Amazon Web Services",

                      "Type": "General",

                      "AccountId": "557949322966",

                      "HasCredentials": true,

                      "Note": null,

                      "LastUpdated": null

                  },

                  {

                      "Id": 1540,

                      "Name": "260172486890",

                      "Provider": "Amazon Web Services",

                      "Type": "General",

                      "AccountId": "260172486890",

                      "HasCredentials": true,

                      "Note": null,

                      "LastUpdated": null

                  },

                  {

                      "Id": 1645,

                      "Name": "718017 Demo",

                      "Provider": "Amazon Web Services",

                      "Type": "General",

                      "AccountId": null,

                      "HasCredentials": false,

                      "Note": null,

                      "LastUpdated": null

                  },

                  {

                      "Id": 1662,

                      "Name": "1836 Duplicate Test",

                      "Provider": "Amazon Web Services",

                      "Type": "General",

                      "AccountId": "183698509299",

                      "HasCredentials": true,

                      "Note": null,

                      "LastUpdated": "2019-09-19T17:58:44"

                  },

                  {

                      "Id": 1667,

                      "Name": "{\"Rowkey\":\"gy6x99zrwhea7r2s69xhjb861ejh3025\",\"Data\":\"le+IPer7RwEkaZIUzUkC4w==\"}",

                      "Provider": "Amazon Web Services",

                      "Type": "General",

                      "AccountId": null,

                      "HasCredentials": false,

                      "Note": null,

                      "LastUpdated": null

                  },

                  {

                      "Id": 1669,

                      "Name": "{\"Rowkey\":\"gy6x99zrwhea7r2s69xhjb861ejh3025\",\"Data\":\"hBuyY+5DPgGWQa0Zldizqw==\"}",

                      "Provider": "Amazon Web Services",

                      "Type": "General",

                      "AccountId": null,

                      "HasCredentials": false,

                      "Note": null,

                      "LastUpdated": null

                  },

                  {

                      "Id": 1670,

                      "Name": "{\"Rowkey\":\"gy6x99zrwhea7r2s69xhjb861ejh3025\",\"Data\":\"1QvCGYHCAJ9D+TZzj8gs+Q==\"}",

                      "Provider": "Amazon Web Services",

                      "Type": "General",

                      "AccountId": null,

                      "HasCredentials": false,

                      "Note": null,

                      "LastUpdated": null

                  },

                  {

                      "Id": 1672,

                      "Name": "{\"Rowkey\":\"gy6x99zrwhea7r2s69xhjb861ejh3025\",\"Data\":\"qgBge5jxZGgi9HmkbPqWmw==\"}",

                      "Provider": "Amazon Web Services",

                      "Type": "General",

                      "AccountId": null,

                      "HasCredentials": false,

                      "Note": null,

                      "LastUpdated": null

                  },

                  {

                      "Id": 1674,

                      "Name": "{\"Rowkey\":\"gy6x99zrwhea7r2s69xhjb861ejh3025\",\"Data\":\"RTtaVBm1Eko3i3+azzldTA==\"}",

                      "Provider": "Amazon Web Services",

                      "Type": "General",

                      "AccountId": null,

                      "HasCredentials": false,

                      "Note": null,

                      "LastUpdated": null

                  },

                  {

                      "Id": 1675,

                      "Name": "Sample (demo purposes only)",

                      "Provider": "Amazon Web Services",

                      "Type": "General",

                      "AccountId": null,

                      "HasCredentials": false,

                      "Note": null,

                      "LastUpdated": null

                  }

              ]

          }
          

Get Accounts V2

The API method, “get_accounts_v2”, is used to return a complete list of all AWS accounts registered in CloudCheckr. This call will return an ID for each account that can be used for the parameter, “use_cc_account_id”, when making calls to the admin-level API. It will also include the AWS account ID.

The preferred HTTP method for this call is GET.

INPUT PARAMETERS:

API CALL URL:

https://api.cloudcheckr.com/api/account.[json|xml]/get_accounts_v2?access_key=[access_key]

REQUEST EXAMPLE:

curl -X GET \

                -- https://api.cloudcheckr.com/api/account.[json|xml]/get_accounts_v2?access_key=your_admin_access_key'\

                -- header 'cache-control: no-cache' \

                -- header 'content-type: application/[json|xml]' \   

RESPONSE EXAMPLE:
XML:

<GetAccountsResponse2 xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
              <accounts_and_users>
                  <AccountAndUsernames>
                      <account_name>AWS Account1</account_name>
                      <cc_account_id>1</cc_account_id>
                      <aws_account_id>123456789012</aws_account_id>
                      <user_names>
                          <string>user@domain.com</string>
                      </user_names>
                  </AccountAndUsernames>
              </accounts_and_users>
          </GetAccountsResponse2>

JSON:

{

               "accounts_and_users": [

                  {

                    "account_name": "AWS Account1",

                    "cc_account_id": "1",

                    "user_names":

                    "aws_account_id":"123456789012"  [

                    "user@domain.com"

                    ]

                 },

          {

                "accounts_and_users": [

                  {

                    "account_name": "AWS Account2",

                    "cc_account_id": "2",

                    "user_names":

                    "aws_account_id":"234567890123"  [

                    "user@domain.com"

                    ]

                 },

          {

                "accounts_and_users": [

                  {

                    "account_name": "AWS Account3",

                    "cc_account_id": "3",

                    "user_names":

                    "aws_account_id":"345678901234"  [

                    "user@domain.com"

                    ]

                 }

             ]

          }
          

Get Accounts V4

The API method, “get_accounts_v4”, is used to return a complete list of all AWS and Azure accounts registered in CloudCheckr. This call will return an ID for each account that can be used for the parameter, “use_cc_account_id”, when making calls to the admin-level API. For AWS, it will include the AWS account ID and for Azure, it will include the Subscription ID.

The preferred HTTP method for this call is GET.

INPUT PARAMETERS:

API CALL URL:

https://api.cloudcheckr.com/api/account.[json|xml]/get_accounts_v4?access_key=[access_key]

REQUEST EXAMPLE:

curl -X GET \

                -- https://api.cloudcheckr.com/api/account.[json|xml]/get_accounts_v4?access_key=your_admin_access_key'\

                -- header 'cache-control: no-cache' \

                -- header 'content-type: application/[json|xml]' \   

RESPONSE EXAMPLE:
XML:

<GetAccountsResponse4 xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
               <accounts_and_users>
                  <AccountAndUsernames4>
                      <account_name>AWS Account Name</account_name>
                      <cc_account_id>1</cc_account_id>
                      <user_names>
                          <string>user@domain.com</string>
                      </user_names>
                      <aws_account_id>123456789012</aws_account_id>
                      <externalId>CC-99999999999999999999999999999999</externalId>
                  </AccountAndUsernames4>
              <AccountAndUsernames4>
                      <account_name>Azure Subscription</account_name>
                      <cc_account_id>2</cc_account_id>
                      <user_names>
                          <string>user@domain.com</string>
                      </user_names>
                      <externalId>CC-88888888888888888888888888888888</externalId>
                      <azure_account_id>11111111-2222-3333-4444-555555555555</azure_account_id>
                  </AccountAndUsernames4>
              </accounts_and_users>
          </GetAccountsResponse4>

JSON:

{

               "accounts_and_users": {

              "accounts_and_users": [

              {

                      "azure_account_id": null,

                      "externalId": "CC-99999999999999999999999999999999",

                      "aws_account_id": "123456789012",

                      "account_name": "AWS Account Name",

                      "cc_account_id": "1",

                      "user_names": [

                          "user@domain.com"

                      ]

                  },

              {

                      "azure_account_id": "11111111-2222-3333-4444-555555555555",

                      "externalId": "CC-88888888888888888888888888888888",

                      "aws_account_id": null,

                      "account_name": "Azure Subscription",

                      "cc_account_id": "2",

                      "user_names": [

                          "user@domain.com"

                      ]

                  }

              ]

          }

Get Custom Usage Rates

The API method, "get_custom_usage_rates", is used to return any custom usage rates from the Custom Usage Rate page.

INPUT PARAMETERS:

API CALL URL:

https://api.cloudcheckr.com/api/billing.json/get_custom_usage_rates?access_key=[access_key]&use_cc_account_id=[account_id]

OUTPUT & RESPONSE:

{
          	"CustomUsageRates": [
          		{
          			"Id": 83,
          			"StartDate": "9/1/2024",
          			"EndDate": "N/A",
          			"ChargeValue": "20",
          			"Description": "TestDesciption14",
          			"ResourceId": null,
          			"Account": "106491416295",
          			"Region": "Africa (Cape Town),Asia Pacific (Hong Kong)",
          			"InvertAccountsSelection": false,
          			"InvertRegionsSelection": false,
          			"InvertAccountFamiliesSelection": false,
          			"InvertServicesSelection": false,
          			"InvertOperationsSelection": false,
          			"InvertUsageTypesSelection": false,
          			"InvertTransactionTypesSelection": false,
          			"AccountFilterType": "Account",
          			"AccountFamily": "",
          			"AwsService": "EC2,SimpleDB,SQS",
          			"Operation":                "PutObject,RunInstances:0002:SV012,SetQueueAttributes",
          			"UsageType": "CAN1-EUC1-AWS-Out-Bytes,UGW1-TimedStorage-RRS-ByteHrs",
          			"UsageTypeContains": "",
          			"TransactionType": "All Transaction Types",
          			"ReservedInstance": "All Reserved Instance Styles"
          		}
          	]
          }
          

Get CloudTrail Custom Metrics

The API method, “get_cloudtrail_custom_metrics”, is used to export a list of Amazon Machine Images (AMIs) and every launched instance. This API request is based on the Ec2AmiWorkload custom metric.

The preferred HTTP method for this call is GET.

INPUT PARAMETERS:

API CALL URL:

https://api.cloudcheckr.com/api/security.[json|xml]/get_cloudtrail_custom_metrics

REQUEST EXAMPLE:

curl -- request GET \

               -- 'https://api.cloudcheckr.com/api.cloudcheckr.com/api/security.[json|xml]/get_cloudtrail_custom_metrics?access_key=[your_access_key]&use_cc_account_id=3&type=Ec2AmiWorkload'\

               -- header 'cache-control: no-cache' \

               -- header 'content-type: application/[json|xml]' \

RESPONSE EXAMPLE:

This call exports the results to a compressed CSV file and contains the following data:

Get External ID

The API method, “get_external_id”, is used to retrieve external IDs if you require an external ID to be associated with a specific CloudCheckr account.

INPUT PARAMETERS:

API CALL URL:

https://api.cloudcheckr.com/api/account.[json|xml]/get_external_id?access_key=00000&use_account=CloudCheckrDev'

REQUEST EXAMPLE:

curl -X GET \

                -- https://api.cloudcheckr.com/api/account.[json|xml]/get_external_id?access_key=00000&use_account=CloudCheckrDev'

                -- header 'cache-control: no-cache' \

                -- header 'content-type: application/[json|xml]' \

RESPONSE EXAMPLES:

XML:

            
              CC-8B02A95B24EAA7179E8118C1216A9BFA
              352813966189
              CloudCheckrDev
            
          
          

JSON:

            
              
                CC-8B02A95B24EAA7179E8118C1216A9BFA
                352813966189
                CloudCheckrDev
              
            
          
          

Get Group

The API method, “get_group”, is used to retrieve a group.

The preferred HTTP method for this call is POST.

INPUT PARAMETERS:

ENDPOINT URL:

https://api.cloudcheckr.com/api/account.[json|xml]/get_group

JSON/XML CALL EXAMPLE:

curl --request POST \

            -- 'https://api.cloudcheckr.com/api/ac