Clients

Clients are services that query the CloudCheckr API and return data based on that request. For example, you can create a client that queries the CloudCheckr API to return cost data from your Production environment.

To query the CloudCheckr API, you need an access key—a unique ID that gets passed to the API as a way to validate, track, and control how the API is used.

Clients are a component of CloudCheckr's Role Based Access Control (RBAC), which is a method for managing access based on the roles assigned to users.

The Clients tab in Access Management is where you can view, search for, modify, or create a client.


Procedures

Click a button to learn more about the actions you can perform in the Clients tab:

This procedure shows you how to create a new client that you can use to query the CloudCheckr API.

  1. Click the Settings icon and select Access Management > API Management.
  2. Click the + CREATE button.
  3. Type a name for the client.
  4. From the Client Role(s) drop-down list, select the roles you want to assign to the client.
  5. Type any helpful personal and/or organizational notes if applicable.

    Here is an example of what the screen would look like if you created a client with the User and Client Access Management role that could query the CloudCheckr API to retrieve Production cost data:

  6. Click Save.

This procedure shows you how to create an access key, which is required to make a call to the CloudCheckr API.

  1. Under Access Keys on the Create New API Client page, click + CREATE button.
  2. In the Create New Access Key dialog box, type a name for the access key.
  3. Click the arrows to identify the number of days before the access key will expire.

    Here is an example of what the screen would look like if you created an access key for the Production environment with a 30-day expiration date:

  4. Click CREATE.

    A pop-up indicates that CloudCheckr successfully created your access key.

    Since this is the only time you can download or copy this key, we recommend that you copy and save the key to a secure location.
  5. Click COPY KEY TO CLIPBOARD.
  6. Click CLOSE.

How did we do?