How To interact with CSMP API?

This article talks about user interaction with CSMP API using Swagger.

Request a token

You can create API access keys to access CloudBolt CSMP services using API calls. Use this procedure to create a new access key.

1. Go to the profile page from the dashboard.

2. Click Access Keys in the left navigation panel.

3. In the Description box, enter a description for your access key.

4. From the Expires options, select when you want to expire your access key.

5. Click Save to generate an access key.

6. You must copy the access key by clicking the Copy button. If you fail to copy and save, you will need to generate a new access key.

Test API Calls in Swagger

There are two API endpoints for CSMP data and actions:

• CSMP API Swagger Start Page

  • Reporting

  • Core

Both endpoints require an API key to authorize and the user also needs to specify the subdomain and optionally the tenant of the CSMP instance.

• Subdomain

  • Ex: CSMP instance URL is “https://testaccount.kumolus.net”

    • Enter “testaccount” as subdomain in Swagger

• Click Authorize to input API Access Key and optionally Tenant Name

• In the Available Authorizations menu:

  • Input your access key under the first option for Bearer > Value:

  • Optionally, if you would like to narrow your API responses to a specific (sub) tenant within the CSMP instance, input the name of that tenant in the Tenant Name > Value: field below.

    • NOTE: if you intend to run against the Default tenant (Default tenant is the primary admin tenant which contains all data in the platform) leave the Tenant Name field empty

    • Even if you have changed the name of the default tenant you still do not need to specify this.

After completing Authorization and setting the subdomain you can now test out the API endpoints. Find a call that is relevant to what you’re looking to accomplish and click ‘Try it out’

• Ensure all required parameters are filled out. Most parameters will have a default value that can be edited by the user if necessary

Once the parameters are set, click ‘Execute’ and the endpoint response will generate below.

The response will feature a CURL snippet of the request headers, parameters, and details of the server response. Certain reporting endpoints also include snippets in Bash, PowerShell, and CMD.

Useful Links:

https://docs.cloudbolt.io/articles/#!cloudbolt-csmp-latest/csmp-api