List builds

{
  "base":     "\https://api.buddybuild.com/v1",
  "endpoint": "/apps/:app_id:/builds",
  "method":   "get",
  "params": {
    "headers": [
      {
        "name": "Authorization",
        "type": "Bearer :api-access-token:",
        "req":  true,
        "cue":  "Enter your API access token"
      }
    ],
    "path":   [
      {
        "name": ":app_id:",
        "type": "string",
        "desc": 'App identifier',
        "req":  true,
        "cue":  'Enter an app id'
      }
    ],
    "query":  [
      {
        "name": "branch",
        "type": "string",
        "desc": "URL-encoded name of the branch",
        "req":  false,
        "cue":  "Enter a branch name"
      },
      {
        "name": "scheme",
        "type": "string",
        "desc": "URL-encoded name of the scheme (iOS only)",
        "req":  false,
        "cue":  "Enter a scheme name"
      },
      {
        "name": "status",
        "type": "string",
        "desc": 'One of "cancelled", "failed", "queued", "running", "success"',
        "req":  false,
        "cue":  'Enter a status, one of "cancelled", "failed", "queued", "running", "success"'
      },
      {
        "name": "limit",
        "type": "integer",
        "desc":   "Number of builds to list: min=1, max=100",
        "def":  "10",
        "req":  false,
        "cue":  "Enter the number of builds to list"
      }
    ],
    "body":   []
  },
  "authentication": "required"
}

Definition

Placeholder for the definition; auto-generated from JSON above.

This method is paginated. By default, 10 items are returned in the response. You can request up to 100 items at a time using the limit query parameter.

You can apply optional filters to the query:

  • Specify a branch name (branch) to restrict the output to the most recent builds for the specified branch. The branch name must be URL encoded.

  • Specify a build status (status) to restrict the output to the most recent builds for the specified build status. Valid values are cancelled, failed, queued, running, or success. Use this to get a list of recently failed builds for example.

For iOS apps, you can also apply the optional scheme filter to the query:

  • Each build of a multi-scheme build is returned separately. Specify an iOS scheme name (scheme) to restrict the output to the most recent builds for the specified scheme. The scheme name must be URL encoded.

Note

Looking for your API access token?

Parameters

Required = *

Placeholder for the endpoint parameters; auto-generated from JSON above.

curl
curl -X GET \
  -H 'Authorization: Bearer :api-access_token:' \
  'https://api.buddybuild.com/v1/apps/:app_id:/builds?branch=:branch:&scheme=:scheme:&status=:status:&limit=:limit:'
jquery
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https:////api.buddybuild.com/v1/apps/:app_id:/builds?limit=&branch=:branch:&scheme=:scheme:&status=:status:",
  "method": "GET",
  "headers": {
    "authorization": "Bearer :api-access-token:"
  }
}
$.ajax(settings).done(function (response) {
  console.log(response);
});
Response
[
  {
    "_id": "27a1c5f4d561a500012e5a2e",
    "app_id": "172aee62ca0774b1d0a9c60c",
    "build_number": 1221,
    "build_status": "failed",
    "commit_info": {
      "author": "Developer 1",
      "branch": "master",
      "commit_sha": "142237443348qbaff75336ca9ada2372d8529686",
      "html_url": "https://github.com/example/app/commit/1ad263853b485baff75336ca9ada2372d8529686";,
      "message": "Remove failing retry logic.",
      "tags": []
    },
    "created_at": "2017-08-31T08:08:25.432Z",
    "finished": true,
    "finished_at": "2017-08-31T08:35:16.728Z",
    "links": {
      "download": [],
      "install": []
    },
    "repo_url": "https://github.com/example/app.git";,
    "started_at": "2017-08-31T08:08:26.381Z",
    "test_summary": {}
  },
  {
    "_id": "29a1d379ec90540001c7eef9",
    "app_id": "172aee62ca0774b1d0a9c60c",
    "build_number": 1220,
    "build_status": "success",
    "commit_info": {
      "author": "Developer 2",
      "branch": "dev-2/fix-crash",
      "commit_sha": "182e3f421977e42a8d83a2dq1650cb4d199d2aaa",
      "html_url": "https://github.com/example/app/commit/18c26f321577442d8683q2d81651cb4d199d2aaa";,
      "message": "fix crash",
      "tags": []
    },
    "created_at": "2017-08-31T08:06:17.728Z",
    "finished": true,
    "finished_at": "2017-08-31T08:14:56.381Z",
    "links": {
      "download": [],
      "install": []
    },
    "repo_url": "https://github.com/example/app.git";,
    "started_at": "2017-08-31T08:06:20.432Z",
    "test_summary": {}
  }
]

results matching ""

    No results matching ""