API regression testing

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.

Regression Testing

Agents

Choose your CI

Base URL

Configs

​Base URL

​Configs

Base URL

Configs