No Result Found
Connect & Get help from fellow developers on our Discord community. Ask the CommunityAsk the Community

Start build API in Test Reporting & Analytics

Use this API to start a build and receive a build_hashed_id required for all subsequent test ingestion calls within that build.

Start a build

POST https://api-automation.browserstack.com/ext/v1/builds/start

Request parameters

Request

curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
-X POST "https://api-automation.browserstack.com/ext/v1/builds/start" \
-H "Content-Type: application/json" \
-d '{
  "name": "Login Test Suite",
  "project_name": "My Web App",
  "started_at": "2025-11-11T10:30:00Z"
}'

  • name* String

    Name of the build. Maximum 255 characters.

  • project_name* String

    Name of the project the build belongs to. Maximum 255 characters.

  • started_at* String (ISO 8601)

    Build start timestamp in ISO 8601 format (for example, 2025-11-11T10:30:00Z).

  • tags Array

    Build tags for categorization. Maximum 50 tags.

  • build_run_identifier String

    A unique identifier for this build run. Maximum 64 characters.

  • Show 4 more

  • host_info Object

    Information about the host system running the build.

    â–¶ SHOW VALUES

    • hostname String

      Hostname of the machine running the build.

    • platform String

      Platform or operating system of the host machine (for example, linux, darwin, win32).

    • type String

      Type of the host environment (for example, physical, virtual, container).

    • version String

      Operating system version of the host machine.

    • arch String

      CPU architecture of the host machine (for example, x64, arm64).

  • ci_info Object

    Information about the CI/CD system triggering the build.

    â–¶ SHOW VALUES

    • name String

      Name of the CI provider (for example, GitHub Actions, Jenkins, CircleCI).

    • build_url String

      URL to the current build on the CI platform.

    • url String

      URL to the CI service or project.

    • build_number String

      Build number assigned by the CI provider.

    • job_name String

      Name of the CI job or workflow that triggered this build.

  • version_control Object

    Git or other VCS information for the build.

  • framework Object

    Testing framework details. When provided, both name and version are required.

    â–¶ SHOW VALUES

    • name* String

      Name of the test framework (for example, pytest, jest, rspec). Required when the framework object is provided.

    • version* String

      Version of the test framework. Required when the framework object is provided.

Response attributes 200 OK JSON

Response

{
  "success": true,
  "build_hashed_id": "o7coi5zrophfrxxc6lmz52yk3csgpuq6exyzs68s"
}

  • success Boolean

    Indicates if the build was created successfully.

  • build_hashed_id String

    Unique 40-character identifier for the build. Use this value as the buildHashedId path parameter in all subsequent API calls related to this build.

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