API
TrainingSupportCommunity

CloudTest API

You can use the CloudTest API service to plan for peak traffic performance by performance testing your environment safely and at scale to identify areas in your site or app that need strengthening. To have success with this API you need to first create your tests and other content in the CloudTest UI and understand the concepts there.

The CloudTest API service consists of nine major components:

  • Tokens. Authenticate login credentials, and provides a security token that must be included with every other API request.

  • Objects. Create, read, update, and delete Repository objects.

  • Compositions. The CloudTest Compositions API allows you to play compositions using a Representational State Transfer (REST) API. When you play a composition, that running test is referred to as an instance of the composition. The Compositions API allows the user to get the status of the instance as well perform actions upon that instance including stop, pause, and resume. The API allows the same composition to be run multiple times but each has its own instance ID.

  • Server management. The Server Management API is a REST API that allows technical support, engineers, and users to gather information about a running server to assist in problem analysis. In particular use it to assist in diagnosing memory issues. At it's most basic level it can return general information about servers including their name, IP address, ID's, and which services they are running.

  • Cloud servers. Cloud servers are created by the grid deployment process either in the CloudTest UI or with the Start or stop a grid operation in the API. Use Cloud servers API to perform actions on running Cloud serves including list, restart, and terminate.

  • Grid provisioning. A grid is created in the CloudTest UI. Use this API to start, stop, or list existing grids. To interact with a grid you need the ID which can be retrieved from List objects.

  • Test environments. A test environment is created via the the CloudTest Manager. Use this API to start, stop, or list test environments via the CloudTest Manager. To interact with a test environment you need the ID which can be retrieved from List objects.

  • Results databases. A results database is created in the CloudTest UI. Use this API to start, stop, or list existing results databases. To interact with a results database you need the ID which can be retrieved from List objects.

  • Query results. Use this to get the results from a composition.

  • Results management. Allows you to mass-delete results. This is an asynchronous operation, see Asynchronous operations for more information.

  • Seed data. Use this to interact with seed data. To interact with seed data you need the ID which can be retrieved from List objects.