BIbitrise
builds

Trigger a new build/pipeline

Changed on

Trigger a new build/pipeline. Specify an app slug and at least one parameter out of three: a git tag or git commit hash, a branch, or a workflow/pipeline ID. You can also set specific parameters for Pull Request builds/pipelines and define additional environment variables for your build/pipeline. Check out our detailed guide.

post/apps/{app-slug}/builds

Request

  • Base URL
    https://api.bitrise.io/v0.1
  • Auth
    • API key in header Authorization
    • or API key in header Bitrise-Addon-Auth-Token

Path parameters

app-slugstring required

App slug

Request body

Example request

{
  "build_params": {
    "environments": [
      {
        "mapped_to": "Deprecated. Please use key instead"
      }
    ],
    "machine_type_id": "g2-m1.4core",
    "stack": "osx-xcode-16.0.x"
  },
  "hook_info": {
    "type": "bitrise"
  }
}

Response

Created

build_numberinteger

Deprecated

build_slugstring

Deprecated

build_urlstring

Deprecated

messagestring
servicestring
slugstring
statusstring
triggered_workflowstring

Deprecated

Changes

  • 274eb91c5877Revision changes
    • breaking

      removed the success response with the status

    • info

      added the success response with the status