Launching a test

This curl command kicks off a test.

curl --fail -u 'user:password' \
-X POST https://<tenant>.antithesis.com/api/v1/launch/basic_test \
-d '{"params": { "antithesis.description":"basic_test on main",
    "antithesis.duration":"length_in_minutes",
    "antithesis.config_image":"config_image_with_tag",
    "antithesis.images":"my_images_with_version_list", 
    "antithesis.report.recipients":"foo@email.com;bar@email.com"
    } }'

You’ll need to provide the following variables.

user:password
The basic auth machine credentials for your tenant.

<tenant>
Your tenant’s name.

For more information on syntax, please consult our webhook reference.

Using this webhook

Calling this webhook first fetches the relevant container images, specified by digest in the antithesis.images parameter. After fetching the images, Antithesis will build the test environment and run your test for a number of minutes set in antithesis.duration.

This webhook returns an HTTP status code to indicate whether it successfully started the test. This code is not your test result, it just indicates whether your webhook call worked.

This webhook can be triggered by your CI system (and we recommend setting your CI up to do this). For more details on setting up CI, or to receive results in Slack, Discord, or directly in your issue tracker, read about our available integrations here.