Using AutoTest Assist

Create and execute an AutoTest profile so you can use AutoTest Assist to support your API integrations.

AutoTest Assist provides quality testing of an API by sending it a series of randomly-generated requests, which are informed by the API definition and any custom rules that you provide. The feature alerts you about any conformance errors and server-side errors that it observes.

AutoTest Assist is provided by IBM API Connect Test and Monitor.


  • An instance of AutoTest Assist is deployed. For more information, see Deploying AutoTest Assist.

  • You have the following components:

    • An OpenAPI document that defines the interface of the target API. In the current release of IBM Cloud Pak® for Integration, this document must conform to OpenAPI 2.0 (Swagger 2.0).

    • A URL that points to a test deployment of the API.
      Important: The auto-tester may send thousands of requests to this endpoint, depending on how you configure the AutoTest profile.
    • Credentials for the deployment. In this release of Cloud Pak for Integration, credentials consist of a username and password, or an API key.


  1. Log in to the Platform UI.

  2. In the navigation panel, click Administration > Integration instances.

  3. Select a deployed instance of API management.

    • If you don't have an instance of API management to select, first follow the steps for "Deploying into a new instance of API management subsystems" in Deploying AutoTest Assist.

  4. Click the Test APIs tile. If this tile isn't available, follow the steps for "Deploying into an existing instance of API management subsystems" in Deploying AutoTest Assist.

  5. Create a new test suite, or open an existing test suite, and click the Tests tab.

  6. Follow the steps for Creating an AutoTest profile in the API Connect documentation.