API, CLI, and Setup

Introduction

This page provides links to the API documentation, AWS Command Line Interface (CLI), and other setup topics.


API

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.

See Also:
API User Guide
API Reference Guide
Admin API Reference Guide
API Reference Guide (Inventory)
Azure API Reference Guide
Deprecated API Calls
Deprecated Admin API Calls


CLI

To use the AWS Command Line Interface to create a new user, review the CLI topic.


SSO

To enable and configure your Single Sign-On (SSO), review the topic, CloudCheckr Single Sign-On.


New Relic Plugin

To set up the new relic plugin, review the topic, New Relic Plugin.


AppDynamics

To set up the extension for AppDynamics, review the topic, Extension for AppDynamics.