Skip to main content
Experience faster, smarter testing with BrowserStack AI Agents. See what your workflow’s been missing. Explore now!
No Result Found
Get your setup working faster. Join our Discord for optimisation tips from elite testers. Join our DiscordJoin our Discord

Builds and reports API for Low Code Automation

List Low Code Automation builds, inspect test runs, download run artifacts, and rerun failed tests.

List builds, Get build details, Get test run details, and Download run artifacts require the View builds role permission. Check rerun eligibility and Rerun failed tests have their own requirements, listed with each endpoint.

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

Build status values

Every build reports one of the following statuses:

Status Meaning
queued The build is waiting to start.
running The build is in progress.
passed Every test in the build passed.
failed At least one test in the build failed.
aborted The build was cancelled or stopped before it finished.
skipped The build was not executed.
unknown The build status couldn’t be determined. Treat it as indeterminate, never as a pass or a failure.

List builds

Fetches the builds in a project.

GET /api/v1/public/projects/{project_id}/builds

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 GET "https://lcnc-api.browserstack.com/api/v1/public/projects/PR-1/builds?status=passed&suite=d5dd6ec0074faea1c84dee43807e9e357a44ea3e&page=1&per_page=5" \
  -H "accept: application/json"
  • project_id* string

    Unique identifier of the project. Use either the integer Project Key, for example 22530, or the Project ID, for example PR-1. To find both, open your project, click Settings, then General, and look under Project details.

  • status string

    Return only builds in this status. Use one of the following values:

    Value Description
    passed Every test in the build passed.
    failed At least one test in the build failed.
    queued The build is waiting to start.
    running The build is in progress.
    aborted The build was canceled or stopped before it finished.
    skipped The build was not executed.
    unknown The build status couldn’t be determined.
  • suite string

    Return only builds triggered from this test suite. Accepts the test suite ID.

  • trigger_source string

    Return only builds started this way. Use one of the following values:

    Value Description
    api Started through the REST API.
    scheduler Started by a test suite schedule.
    manual Started from the dashboard.
  • created_by string

    Return only builds started by this user. Accepts a BrowserStack user ID, an email address, or a username.

  • created_after string

    Return only builds created on or after this ISO-8601 timestamp.

  • created_before string

    Return only builds created on or before this ISO-8601 timestamp. A date without a time means the end of that day.

  • page integer

    Page to fetch. Pages are 1-based. The default is 1.

  • per_page integer

    Number of records per page. The default is 50 and the maximum is 100.

Response attributes 200 application/json

The trigger_source, created_by, created_after, and created_before filters are applied after the page is fetched. Setting any of them marks the response best_effort and adds filtered_count, which counts the records on the current page that matched. The total field ignores these four filters, so treat it as an upper bound.

Response

{
  "builds": [
    {
      "build_id": "u7rufi3ygpghyl08y8ys7tt7hjv5ddyzv2doh4jz",
      "status": "passed",
      "counts": {
        "passed": 1,
        "failed": 0,
        "skipped": 0
      },
      "suite": "d5dd6ec0074faea1c84dee43807e9e357a44ea3e",
      "trigger_source": "api",
      "created_by": "Alex Johnson",
      "created_at": "2026-09-24T16:33:48Z",
      "device_type": "desktop",
      "browsers": [
        {
          "browser": "Chrome"
        }
      ],
      "devices": [],
      "environment_id": "fbc7267d6719c581e5dfb69f690f18a9c47fbc53",
      "local_testing": {
        "enabled": false
      },
      "accessibility": {
        "enabled": true
      },
      "visual_testing": {
        "enabled": true
      },
      "results_link": "https://automation.browserstack.com/public-build/..."
    }
  ],
  "paging": {
    "page": 1,
    "per_page": 5,
    "total": 1,
    "total_pages": 1
  }
}
  • builds Array[Object]

    Builds that match the request.

    β–Ά SHOW VALUES
    • build_id String

      Unique identifier of the build.

    • status String

      Status of the build, for example passed or failed.

    • counts Object

      Number of tests by result.

      β–Ά SHOW VALUES
      • passed Integer

        Number of tests that passed.

      • failed Integer

        Number of tests that failed.

      • skipped Integer

        Number of tests that were skipped.

    • suite String

      Identifier of the test suite the build ran.

    • trigger_source String

      How the build was started. The value is one of the following:

      Value Description
      api Started through the REST API.
      scheduler Started by a test suite schedule.
      manual Started from the dashboard.
    • created_by String

      Name of the user who started the build.

    • created_at String

      When the build was created, as an ISO 8601 timestamp.

    • device_type String

      Device type the build ran on, for example desktop.

    • browsers Array[Object]

      Browsers the build ran on.

      β–Ά SHOW VALUES
      • browser String

        Browser name, for example Chrome, Firefox, Edge, or Safari.

      • browserVersionSelector String

        Browser version the suite runs on, for example Latest-3. Returned only by the Get a test suite endpoint.

    • devices Array[Object]

      Mobile devices the build ran on. Empty for desktop builds.

    • environment_id String

      Identifier of the environment the build ran against. null when not set.

    • local_testing Object

      Whether Local Testing was on for the build.

      β–Ά SHOW VALUES
      • enabled Boolean

        Whether the setting is turned on.

    • accessibility Object

      Whether accessibility testing was on for the build.

      β–Ά SHOW VALUES
      • enabled Boolean

        Whether the setting is turned on.

    • visual_testing Object

      Whether visual testing was on for the build.

      β–Ά SHOW VALUES
      • enabled Boolean

        Whether the setting is turned on.

    • results_link String

      Shareable public build URL. When the build has no public build URL, this is the link to the build on the dashboard.

  • paging Object

    Pagination details of the response.

    β–Ά SHOW VALUES
    • page Integer

      Page returned. Pages are 1-based.

    • per_page Integer

      Number of records per page.

    • total Integer

      Total number of records that match the request. When best_effort is true, this is an upper bound.

    • total_pages Integer

      Total number of pages. When best_effort is true, this is an upper bound.

    • best_effort Boolean

      Returned as true when total and total_pages are upper bounds rather than exact counts. When you see it, page through the results until you receive an empty list instead of relying on total_pages. Absent when the counts are exact.

results_link is the shareable public build URL. When a build has no public build URL, it links to the build on the dashboard instead.

Get build details

Fetches the details of a single build, including every test run.

GET /api/v1/public/projects/{project_id}/builds/{build_id}

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
  -X GET "https://lcnc-api.browserstack.com/api/v1/public/projects/22530/builds/u7rufi3ygpghyl08y8ys7tt7hjv5ddyzv2doh4jz" \
  -H "accept: application/json"
  • project_id* string

    Unique identifier of the project. Use either the integer Project Key, for example 22530, or the Project ID, for example PR-1. To find both, open your project, click Settings, then General, and look under Project details.

  • build_id* string

    Unique identifier of the build. To get it, open the build, click View metadata, then copy the Build ID.

Response attributes 200 application/json

Each entry in test_runs covers one test. The status field reports the first attempt and final_status reports the latest one. The reruns array holds the second attempt onwards. Pass a test_runs entry’s id to the Get test run details endpoint.

Response

{
  "build": {
    "build_id": "u7rufi3ygpghyl08y8ys7tt7hjv5ddyzv2doh4jz",
    "name": "Homepage visual check",
    "suite": "d5dd6ec0074faea1c84dee43807e9e357a44ea3e",
    "trigger_source": "api",
    "created_by": "Alex Johnson",
    "created_at": "2026-09-24T16:33:48Z",
    "started_at": "2026-09-24T16:33:48Z",
    "ended_at": "2026-09-24T16:35:33Z",
    "duration": 105198,
    "rerun_count": 0,
    "device_type": "desktop",
    "browsers": [
      {
        "browser": "Chrome"
      }
    ],
    "environment_id": null,
    "local_testing": {
      "enabled": false
    },
    "results_link": "https://lcnc-api.browserstack.com/projects/22530/builds/...",
    "status": "passed",
    "counts": {
      "passed": 1,
      "failed": 0,
      "skipped": 0
    }
  },
  "test_runs": [
    {
      "id": "b3ccf3c3-a444-4368-8eae-44a2af8f8cf5",
      "name": "Example Domain navigation",
      "status": "passed",
      "final_status": "passed",
      "run_count": 1,
      "reruns": []
    }
  ],
  "accessibility": {
    "available": false
  },
  "visual_testing": {
    "available": true,
    "snapshots": [
      {
        "id": "2938237978",
        "name": "Open page \"Example Domain\"",
        "review_state": "approved",
        "diff_ratio": null,
        "current_image_url": "https://images.percy.io/...",
        "baseline_image_url": null
      }
    ],
    "error": null
  }
}
  • build Object

    The build.

    β–Ά SHOW VALUES
    • build_id String

      Unique identifier of the build.

    • name String

      Name of the build.

    • suite String

      Identifier of the test suite the build ran.

    • trigger_source String

      How the build was started. The value is one of the following:

      Value Description
      api Started through the REST API.
      scheduler Started by a test suite schedule.
      manual Started from the dashboard.
    • created_by String

      Name of the user who started the build.

    • created_at String

      When the build was created, as an ISO 8601 timestamp.

    • started_at String

      When the build started running, as an ISO 8601 timestamp.

    • ended_at String

      When the build finished, as an ISO 8601 timestamp.

    • duration Integer

      How long the build ran, in milliseconds.

    • rerun_count Integer

      Number of times the build was rerun.

    • device_type String

      Device type the build ran on, for example desktop.

    • browsers Array[Object]

      Browsers the build ran on.

      β–Ά SHOW VALUES
      • browser String

        Browser name, for example Chrome, Firefox, Edge, or Safari.

      • browserVersionSelector String

        Browser version the suite runs on, for example Latest-3. Returned only by the Get a test suite endpoint.

    • environment_id String

      Identifier of the environment the build ran against. null when not set.

    • local_testing Object

      Whether Local Testing was on for the build.

      β–Ά SHOW VALUES
      • enabled Boolean

        Whether the setting is turned on.

    • results_link String

      Shareable public build URL. When the build has no public build URL, this is the link to the build on the dashboard.

    • status String

      Status of the build, for example passed or failed.

    • counts Object

      Number of tests by result.

      β–Ά SHOW VALUES
      • passed Integer

        Number of tests that passed.

      • failed Integer

        Number of tests that failed.

      • skipped Integer

        Number of tests that were skipped.

  • test_runs Array[Object]

    Test runs in the build.

    β–Ά SHOW VALUES
    • id String

      Unique identifier of the test run. Use it as test_run_id in the Get test run details endpoint.

    • name String

      Name of the test.

    • status String

      Status of the first attempt, for example passed or failed.

    • final_status String

      Status after any reruns.

    • run_count Integer

      Number of times the test ran, including reruns.

    • reruns Array[Object]

      Rerun attempts of the test. Empty when the test wasn’t rerun.

  • accessibility Object

    Accessibility results of the build. Always present.

    β–Ά SHOW VALUES
    • available Boolean

      Whether accessibility data is available for the build. Check it before you read the other fields.

    • summary Object

      Accessibility score, severity, WCAG, and coverage values. Returned only when available is true.

    • report_link String

      Link to a CSV report of the accessibility issues. Returned only when available is true.

  • visual_testing Object

    Visual testing results of the build. Always present.

    β–Ά SHOW VALUES
    • available Boolean

      Whether visual testing data is available for the build. Check it before you read the other fields.

    • snapshots Array[Object]

      Visual snapshots captured in the build. Returned only when available is true.

      β–Ά SHOW VALUES
      • id String

        Unique identifier of the snapshot.

      • name String

        Name of the snapshot.

      • review_state String

        Review state of the snapshot, for example approved.

      • diff_ratio Number

        Share of the snapshot that differs from the baseline. null when there’s no baseline.

      • current_image_url String

        URL of the snapshot captured in this build.

      • baseline_image_url String

        URL of the baseline snapshot. null when there’s no baseline.

    • error String

      Error message when the visual testing data couldn’t be loaded. null when there’s no error.

The accessibility and visual_testing objects are always present and always carry an available flag, so the response shape doesn’t change between builds. Check available before reading either one:

  • When accessibility data is available, the object also carries summary, which holds the score, severity, WCAG, and coverage values, and report_link, a link to a CSV issue report.
  • When visual testing data is available, the object also carries snapshots. Each snapshot holds id, name, review_state, diff_ratio, current_image_url, and baseline_image_url.

Get test run details

Fetches the details of one test run in a build, including every attempt and step.

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

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
  -X GET "https://lcnc-api.browserstack.com/api/v1/public/projects/22530/builds/u7rufi3ygpghyl08y8ys7tt7hjv5ddyzv2doh4jz/test-runs/b3ccf3c3-a444-4368-8eae-44a2af8f8cf5" \
  -H "accept: application/json"
  • project_id* string

    Unique identifier of the project. Use either the integer Project Key, for example 22530, or the Project ID, for example PR-1. To find both, open your project, click Settings, then General, and look under Project details.

  • build_id* string

    Unique identifier of the build. To get it, open the build, click View metadata, then copy the Build ID.

  • test_run_id* string

    Unique identifier of the test run. To get it, call the Get build details endpoint and copy the id of the run from the test_runs array in the response.

Response attributes 200 application/json

The verdict field summarizes the run across all its attempts. The possible values are passed_first_attempt, passed_after_rerun, and failed.

Response

{
  "test_run": {
    "verdict": "passed_first_attempt",
    "test_id": "cbbbad1bd2712b823b7bc2e92f9bc4afe8a207d6",
    "browser": "Chrome",
    "os": "Windows Server 2022",
    "device": null,
    "attempts": [
      {
        "id": "b3ccf3c3-a444-4368-8eae-44a2af8f8cf5",
        "status": "passed",
        "started_at": 1790267641944,
        "finished_at": 1790267715127,
        "duration": 72870,
        "failed_step": null,
        "error": null
      }
    ],
    "steps": [
      {
        "id": "e73b55c5d465504e62f97fc05412cb38628cf177",
        "name": "Open page <strong>\"Example Domain\"</strong>",
        "action": "visit_url",
        "status": "Passed",
        "retries": 0,
        "ai_healed": false,
        "error": null,
        "locator": "",
        "selectors": {
          "xpath": null,
          "css_path": null,
          "tag_name": null,
          "id": null,
          "attributes": null,
          "data_attributes": null,
          "overridden_parent": null
        },
        "timeout_ms": 120000,
        "failure_condition": "FAIL_AND_STOP",
        "tab": {
          "identifier": null,
          "switch_focus": null
        },
        "is_iframe": false,
        "is_shadow_dom": null,
        "position": 0,
        "variables": [],
        "screenshots": [
          {
            "type": "stepImage",
            "url": "https://..."
          }
        ]
      }
    ],
    "artifacts": [
      {
        "type": "video",
        "url": "https://..."
      }
    ],
    "linked_issues": [],
    "bug_metadata": {
      "reported": false,
      "start_url": "https://example.com",
      "test_name": "Example Domain navigation",
      "test_execution": {
        "build_id": "u7rufi3ygpghyl08y8ys7tt7hjv5ddyzv2doh4jz",
        "test_run_id": "b3ccf3c3-a444-4368-8eae-44a2af8f8cf5"
      },
      "browser_and_device": "Chrome Windows Server 2022",
      "execution_browser": "Chrome 148.0",
      "logs": {
        "console": "https://...",
        "network": "https://..."
      },
      "failed_steps": []
    }
  }
}
  • test_run Object

    The test run.

    β–Ά SHOW VALUES
    • verdict String

      Rerun-aware result of the test run. The value is one of the following:

      Value Description
      passed_first_attempt The test passed on its first attempt.
      passed_after_rerun The test failed at first and passed on a rerun.
      failed The test failed, including any reruns.
    • test_id String

      Unique identifier of the test.

    • browser String

      Browser the test ran on.

    • os String

      Operating system the test ran on.

    • device String

      Mobile device the test ran on. null for desktop runs.

    • attempts Array[Object]

      Attempts of the test run, including reruns.

      β–Ά SHOW VALUES
      • id String

        Unique identifier of the attempt.

      • status String

        Status of the attempt, for example passed or failed.

      • started_at Integer

        When the attempt started, as a Unix timestamp in milliseconds.

      • finished_at Integer

        When the attempt finished, as a Unix timestamp in milliseconds.

      • duration Integer

        How long the attempt ran, in milliseconds.

      • failed_step String

        Name of the step that failed. null when the attempt passed.

      • error String

        Error message of the failed step. null when the attempt passed.

    • steps Array[Object]

      Steps of the test, with their configuration and outcome.

      β–Ά SHOW VALUES
      • id String

        Unique identifier of the step.

      • name String

        Name of the step, as shown on the dashboard.

      • action String

        Action the step performs, for example visit_url or click.

      • status String

        Result of the step, for example Passed.

      • retries Integer

        Number of times the step was retried.

      • ai_healed Boolean

        Whether AI self-healing fixed the step.

      • error String

        Error message when the step failed. null when the step passed.

      • locator String

        Locator strategy used to find the element, for example xpath. Empty when the step doesn’t target an element.

      • selectors Object

        Selectors recorded for the element.

        β–Ά SHOW VALUES
        • xpath String

          XPath of the element. null when the step doesn’t target an element.

        • css_path String

          CSS path of the element.

        • tag_name String

          HTML tag of the element.

        • id String

          HTML id attribute of the element. Empty when the element has none.

        • attributes Object

          HTML attributes of the element, as key-value pairs.

        • data_attributes Object

          data-* attributes of the element, as key-value pairs.

        • overridden_parent Object

          Parent element used to find the element. null when not set.

          β–Ά SHOW VALUES
          • xpath String

            XPath of the parent element.

          • css_path String

            CSS path of the parent element.

          • tag_name String

            HTML tag of the parent element.

      • timeout_ms Integer

        How long the step waits for its element, in milliseconds.

      • failure_condition String

        What happens when the step fails, for example FAIL_AND_STOP.

      • tab Object

        Browser tab the step runs in.

        β–Ά SHOW VALUES
        • identifier Integer

          Index of the browser tab the step runs in. null when the step doesn’t target a tab.

        • switch_focus Boolean

          Whether the step switches focus to that tab.

      • is_iframe Boolean

        Whether the element is inside an iframe.

      • is_shadow_dom Boolean

        Whether the element is inside a shadow DOM. null when the step doesn’t target an element.

      • position Integer

        Position of the step in the test, starting at 0.

      • variables Array[Object]

        Variables the step used at replay.

      • screenshots Array[Object]

        Screenshots captured for the step.

        β–Ά SHOW VALUES
        • type String

          Type of the screenshot, for example stepImage.

        • url String

          Signed URL of the screenshot.

    • artifacts Array[Object]

      Video and logs of the test run.

      β–Ά SHOW VALUES
      • type String

        Type of the artifact. The value is one of the following:

        Value Description
        video Video recording of the test run.
        console_log Browser console log.
        network_log Network log in HAR format.
      • url String

        Signed URL to download the artifact. The URL expires, so download it soon after you fetch it.

    • linked_issues Array[Object]

      Tickets in your bug tracker that are linked to the test run. Empty when none are linked.

      β–Ά SHOW VALUES
      • issue_id String

        Key of the ticket in your bug tracker.

      • issue_type String

        Type of the ticket, for example Bug.

      • issue_status String

        Status of the ticket in your bug tracker.

      • url String

        Link to the ticket.

      • created_at Integer

        When the ticket was linked, as a Unix timestamp.

    • bug_metadata Object

      Values the dashboard pre-fills a bug report with. The bug tracker and ticket URL are in linked_issues, not here.

      β–Ά SHOW VALUES
      • reported Boolean

        Whether a bug has been filed for the test run.

      • start_url String

        URL the test started from.

      • test_name String

        Name of the test.

      • test_execution Object

        Build and test run the bug report refers to.

        β–Ά SHOW VALUES
        • build_id String

          Unique identifier of the build.

        • test_run_id String

          Unique identifier of the test run.

      • browser_and_device String

        Browser and operating system the test ran on.

      • execution_browser String

        Browser name and version the test ran on.

      • logs Object

        Links to the logs of the test run.

        β–Ά SHOW VALUES
        • console String

          Signed URL of the console log.

        • network String

          Signed URL of the network log.

      • failed_steps Array[Object]

        Steps that failed. Empty when the test passed.

Each step carries its element configuration and its outcome, including the variables used at replay and any screenshots captured.

The bug_metadata object holds the values the dashboard pre-fills a bug report with. The bug tracker and ticket URL aren’t in this object. They’re in linked_issues.

Download run artifacts

Fetches a manifest of download links for a test run’s video, console log, and network log. The response is a list of links, not the files themselves and not an archive.

GET /api/v1/public/projects/{project_id}/builds/{build_id}/test-runs/{test_run_id}/artifacts

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
  -X GET "https://lcnc-api.browserstack.com/api/v1/public/projects/22530/builds/u7rufi3ygpghyl08y8ys7tt7hjv5ddyzv2doh4jz/test-runs/b3ccf3c3-a444-4368-8eae-44a2af8f8cf5/artifacts" \
  -H "accept: application/json"
  • project_id* string

    Unique identifier of the project. Use either the integer Project Key, for example 22530, or the Project ID, for example PR-1. To find both, open your project, click Settings, then General, and look under Project details.

  • build_id* string

    Unique identifier of the build. To get it, open the build, click View metadata, then copy the Build ID.

  • test_run_id* string

    Unique identifier of the test run. To get it, call the Get build details endpoint and copy the id of the run from the test_runs array in the response.

Response attributes 200 application/json

The type field is one of video, console_log, or network_log. Download each URL separately.

Response

{
  "artifacts": [
    {
      "type": "video",
      "url": "https://..."
    },
    {
      "type": "console_log",
      "url": "https://..."
    }
  ]
}
  • artifacts Array[Object]

    Artifacts of the test run.

    β–Ά SHOW VALUES
    • type String

      Type of the artifact. The value is one of the following:

      Value Description
      video Video recording of the test run.
      console_log Browser console log.
      network_log Network log in HAR format.
    • url String

      Signed URL to download the artifact. The URL expires, so download it soon after you fetch it.

Check rerun eligibility

Checks whether a build can be rerun. Call this before a rerun to avoid a 409 response. This endpoint requires the Rerun builds role permission.

GET /api/v1/public/projects/{project_id}/builds/{build_id}/rerun_eligibility

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
  -X GET "https://lcnc-api.browserstack.com/api/v1/public/projects/22530/builds/u7rufi3ygpghyl08y8ys7tt7hjv5ddyzv2doh4jz/rerun_eligibility" \
  -H "accept: application/json"
  • project_id* string

    Unique identifier of the project. Use either the integer Project Key, for example 22530, or the Project ID, for example PR-1. To find both, open your project, click Settings, then General, and look under Project details.

  • build_id* string

    Unique identifier of the build. To get it, open the build, click View metadata, then copy the Build ID.

Response attributes 200 application/json

The ineligibility_reasons array is empty when eligible is true.

Response

{
  "eligible": false,
  "ineligibility_reasons": [
    "build_not_failed"
  ]
}
  • eligible Boolean

    Whether the build can be rerun.

  • ineligibility_reasons Array[String]

    Reasons the build can’t be rerun, for example build_not_failed. Empty when eligible is true.

Response 401 application/json

The access key is missing or invalid.

Response

{
  "error": {
    "code": "unauthenticated",
    "message": "string"
  }
}

Response 403 application/json

Your role doesn’t have the Rerun builds permission.

Response

{
  "error": {
    "code": "forbidden_rbac",
    "message": "string"
  }
}

Response 404 application/json

The build doesn’t exist, or it belongs to another group.

Response

{
  "error": {
    "code": "not_found",
    "message": "string"
  }
}

Response 503 application/json

An upstream dependency is unavailable.

Response

{
  "error": {
    "code": "dependency_unavailable",
    "message": "string"
  }
}

Rerun failed tests

Queues a rerun of the failed tests in a build. This endpoint requires the Rerun builds plan feature and the Rerun builds role permission.

POST /api/v1/public/projects/{project_id}/builds/{build_id}/rerun

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
  -X POST "https://lcnc-api.browserstack.com/api/v1/public/projects/22530/builds/u7rufi3ygpghyl08y8ys7tt7hjv5ddyzv2doh4jz/rerun" \
  -H "accept: application/json"
  • project_id* string

    Unique identifier of the project. Use either the integer Project Key, for example 22530, or the Project ID, for example PR-1. To find both, open your project, click Settings, then General, and look under Project details.

  • build_id* string

    Unique identifier of the build to rerun. To get it, open the build, click View metadata, then copy the Build ID.

Response attributes 202 application/json

Poll the new build with the Get build details endpoint.

Response

{
  "new_build_id": "c4e8021bd7a9f4560138ea7c2b95d4471fa03e88",
  "status": "queued"
}
  • new_build_id String

    Unique identifier of the new build. Poll it with the Get build details endpoint.

  • status String

    Status of the new build, for example queued.

Response 401 application/json

The access key is missing or invalid.

Response

{
  "error": {
    "code": "unauthenticated",
    "message": "string"
  }
}

Response 403 application/json

Your plan doesn’t include the Rerun builds feature, or your role doesn’t have the Rerun builds permission. The code field tells you which: forbidden_plan for the plan, or forbidden_rbac for the role. The example shows the plan case.

Response

{
  "error": {
    "code": "forbidden_plan",
    "message": "string"
  }
}

Response 404 application/json

The build doesn’t exist, or it belongs to another group.

Response

{
  "error": {
    "code": "not_found",
    "message": "string"
  }
}

Response 409 application/json

The build can’t be rerun. The error.details.reasons array lists the blocking reasons. It uses the same values as ineligibility_reasons from the Check rerun eligibility endpoint.

Response

{
  "error": {
    "code": "conflict",
    "message": "string",
    "details": {
      "reasons": [
        "build_not_failed"
      ]
    }
  }
}

Response 503 application/json

An upstream dependency is unavailable.

Response

{
  "error": {
    "code": "dependency_unavailable",
    "message": "string"
  }
}

We're sorry to hear that. Please share your feedback so we can do better

Contact our Support team for immediate help while we work on improving our docs.

We're continuously improving our docs. We'd love to know what you liked





Thank you for your valuable feedback

Download Copy Check Circle