Cloudistics Web Services API

Cloudistics Web Services (CWS) provides API access to the Cloudistics on-premises cloud platform. Specifically, the API provides access to virtual datacenter and infrastructure resources. You can use the API, for example, to create resizable resources, manage workloads, and retrieve information about the underlying infrastructure. Refer to the following topics.

Get Started

Navigate to the CWS Site

Interactive API reference documentation is available to demonstrate how to use the Cloudistics Web Services API here. You can view and make API calls using the CWS endpoint /swagger-ui.html.

Authorize Token

First, you need to authorize your API token.

NOTE

You can obtain a token for your account in the Cloudistics Ignite management portal under Developer Options. See this topic for instructions: Manage Developer Options.

  1. Once you have your token, click the Authorize button on the main page.(It will show an unlocked icon, meaning there are no authorizations provided yet.)

    Cloudistics Web Services API

  2. In the Available Authorizations dialog box, add your token in the following format, Bearer my_token, where my_token is your API token, and then click Authorize.

    Enter and authorize your token

    After you click Authorize you should see the Available Authorizations dialog box.

    Authorized token

    On the main API documentation page, you should see that the authorization is added as noted with a locked icon. Since the authorization has been provided, you can now successfully make API requests.

Make an API Request

Once you have an API token, you can make an API request via a selected endpoint as follows.

  1. Select a specific endpoint, and then click Try it out.

    Selected endpoint

    When you click Try it out, an "Execute" button will appear between the Parameters and Responses sections.

  2. Set the available parameters as you like, and then click Execute to make the API request.

    Execute the call

    Upon submitting the API request, an example Curl request appears, which represents the API request, as well as the server response. The response includes the status code, response body and response headers.

    Results

Example: How to search for an application

An example is provided below to help guide you in learning to use the CWS API.

Example Scenario: Using the Applications Get API, search for an application with a specific name and only include the UUID in the response.

  1. Input filter criteria and data to include in the response.

    The screenshot below shows inputting the UUID with the application name, "Cloudistics Migration Manager," in the filters input box.

    Example parameters

  2. Execute the query.

    The screenshot below shows the query being executed based on the user input (in the Curl section). Notice that the UUID is returned in the response body.

Example query executed

Previous

Next

Still need help?

Submit a request