API regression testing

Run an API application’s tests from a test plan against a base URL, with configs for credentials.

An API test plan uses the same parameters as a web plan. The environment URL is the API base URL, such as https://api.staging.example.com. Tests in the plan that belong to the API application run against that host. They do not open a browser.

Base URL

Set the environment on the test plan Parameters card for the API application. To point one run at a different host, pass environment.url on that application’s override in Start Run.

{
  "testPlanShortId": "pln_abc123",
  "applications": [
    {
      "applicationShortId": "app_api123",
      "environment": { "url": "https://api.staging.example.com" }
    }
  ]
}

Configs

Assign Configs on each test under Settings → Configs. Use an API Key config for a secret and a Custom Fields config for non-secret IDs. The sandbox receives scalar values as environment variables. Refer to them by purpose in the test instructions. See API testing.

Config environment overrides supply a different value when the same test runs against another environment.

Run it from CI

GitHub

Test Run Action with a base URL override for the API application.

GitLab

POST /v1/run with the API base URL for that deploy.

Bitrise

One HTTP request with the test plan short ID.

API

Start the plan from any CI that can send an HTTPS request.