Bugs API for Low Code Automation

File a bug in Jira or Azure DevOps from a failed Low Code Automation test run.

Use this endpoint to create a ticket in a connected bug tracker and link it to a failed test run. Connect the bug tracker before your first call. For the setup steps, see Jira or Azure DevOps.

For authentication and the base URL, see the Low Code Automation Reference API overview.

Create a bug

Creates a ticket in a connected bug tracker and links it to a test run. This endpoint requires the Update builds role permission.

POST /api/v1/public/projects/{project_id}/builds/{build_id}/test-runs/{test_run_id}/bugs

Request parameters

In the curl request, replace YOUR_USERNAME and YOUR_ACCESS_KEY with your account’s username and access key.

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
  -X POST "https://lcnc-api.browserstack.com/api/v1/public/projects/40906/builds/9a1c77e2b4d0f38561ce0a7f4b21d9903cf8e142/test-runs/f3b90a1157dc4e2b8a06d5391cf7e4488b0a2d67/bugs" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: build-9a1c77e2-run-f3b90a11" \
  -d '{
    "bug": {
      "integration_key": "jira",
      "project_id": "CHECKOUT",
      "ticket_type_id": "10001",
      "summary": "Login button not clickable on checkout",
      "description": "Step 4 failed on the checkout flow",
      "custom": {
        "priority": "High"
      }
    }
  }'

Response attributes 201 application/json

Response

{
  "bug": {
    "id": "CHECKOUT-42",
    "url": "https://your-org.atlassian.net/browse/CHECKOUT-42"
  },
  "linked": true
}

Avoid duplicate tickets on retry

Send an Idempotency-Key header so that a retried request doesn’t file the same bug twice.

Within 24 hours, a retry with the same key and the same request body returns the original ticket instead of creating a second one. The response carries an Idempotent-Replayed header set to true. A different key creates a new ticket.

The key is scoped to a single bug tracker, so sending the same key first to Jira and then to Azure DevOps creates one ticket in each.

Note: Reuse an idempotency key only across retries of the same request. Reusing a key with a different request body returns a 400 response, because the key stays bound to the parameters it was first sent with.

Status codes

The following table lists the responses this endpoint returns:

Note: A 401 response doesn’t always mean your credentials are wrong. A disconnected bug tracker returns 401 with the code integration_not_connected, and error.details carries setup_completed set to false along with a redirect_uri you can use to connect the integration. Check error.code before you rotate your access key.

A 422 response carries the per-field errors from your bug tracker in error.details, so you can correct the request. For example, a required Jira custom field that is left unset returns 422.

Related topics

• Low Code Automation Reference API overview
• Builds and reports API
• Integrate with Jira
• Integrate with Azure DevOps