Cancel Jobs

To cancel a queued or running job, you can either use the web interface of TestEngine or send a request to the TestEngine API using curl, ReadyAPI, or any other similar tool.

Using API

Use the following operation:

DELETE  http://<testengine-host>:8080/api/v1/testjobs/{testjobId}

Authentication

The request must be authenticated by a TestEngine user.

Note

If you authenticate as a non-admin user, you will be able to cancel only test jobs that you have started. If you authenticate as an administrator, you will be able to cancel any test job in TestEngine.

go.gifSee details on SwaggerHub in the ReadyAPI TestEngine API – Cancel Test Job section.

Example
curl

Use the following command line:

curl -u "user:password" -X DELETE "http://localhost:8080/api/v1/testjobs/{testjobId}"

In this example:

-u user:password

Authenticates the request with the user’s credentials.

-X DELETE

Specifies the DELETE method.

"http://localhost:8080/api/v1/testjobs/{testjobId}"

The endpoint of the request.

ReadyAPI

  1. Create a project by using the TestEngine API definition. See Creating Project From OpenAPI/Swagger Definition to learn how to do it.

    Tip

    You can also create the needed request from scratch.

  2. Select the DELETE request to the /api/v1/testjobs/{testjobId} resource:

    Cancel a test job: Select a request

  3. Enter the test job's id in the Value field of the testjobId parameter:

    Cancel a test job: Enter a test job id

  4. Open the Auth panel.

  5. Select the Basic (Built-in) authorization type.

    Tip

    If you use the same credentials in several requests, use authorization profiles.

  6. Specify user credentials and select the Authenticate pre-emptively option:

    Get peak TestEngine usage statistics: Add authorization

  7. Send the request:

    Get a report on a test job: Send the request

  8. If the operation was successful, you will receive the 204 No Content response:

    Get a report on a test job: View the report

Using Web UI

  1. Go to the home page of the TestEngine:

    http://<testengine-host>:<port>/

    For example, if TestEngine is installed on your local machine and you run it on the default port, use the following link:

    http://localhost:8080/

  2. Click Cancel test job next to the needed running or queued job:

    Cancel a test job in the TestEngine web interface

See Also

In this section:
© 2025
Publication date: