List

API Reference

Builds

List builds for a project

client.builds.list(BuildListParamsparams?, RequestOptionsoptions?): Page<idstringconfig_commitstringcreated_atstringdocumented_specunionobject"build"orgstringprojectstringtargetsTargetsupdated_atstringBuildObject>

get/v0/builds

List builds for a project

Parameters

paramsprojectstringbranchstringcursorstringlimitnumberrevisionunionBuildListParams

Hide ParametersShow Parameters

projectstring

optional

Project name

branchstring

optional

Branch name

cursorstring

optional

Pagination cursor from a previous response

limitnumber

optional

Maximum number of builds to return, defaults to 10 (maximum: 100)

exclusiveMinimum0

maximum100

revisionunion

optional

string | Record<string, unnamed_schema_with_map_parent_0>

A config commit SHA used for the build

Hide ParametersShow Parameters

string

Record<string, unnamed_schema_with_map_parent_0>

Returns

idstringconfig_commitstringcreated_atstringdocumented_specunionobject"build"orgstringprojectstringtargetsTargetsupdated_atstringBuildObject

HTTPTypeScriptPythonGo

import Stainless from '@stainless-api/sdk';

const client = new Stainless({
  apiKey: 'My API Key',
});

// Automatically fetches more pages as needed.
for await (const buildObject of client.builds.list({ project: 'project' })) {
  console.log(buildObject.id);
}

200 Example

{
  "data": [
    {
      "id": "id",
      "config_commit": "config_commit",
      "created_at": "2019-12-27T18:11:19.117Z",
      "documented_spec": {
        "content": "content",
        "type": "content"
      },
      "object": "build",
      "org": "org",
      "project": "project",
      "targets": {
        "cli": {
          "commit": {
            "status": "not_started"
          },
          "lint": {
            "status": "not_started"
          },
          "object": "build_target",
          "status": "not_started",
          "test": {
            "status": "not_started"
          },
          "build": {
            "status": "not_started"
          },
          "upload": {
            "status": "not_started"
          }
        },
        "csharp": {
          "commit": {
            "status": "not_started"
          },
          "lint": {
            "status": "not_started"
          },
          "object": "build_target",
          "status": "not_started",
          "test": {
            "status": "not_started"
          },
          "build": {
            "status": "not_started"
          },
          "upload": {
            "status": "not_started"
          }
        },
        "go": {
          "commit": {
            "status": "not_started"
          },
          "lint": {
            "status": "not_started"
          },
          "object": "build_target",
          "status": "not_started",
          "test": {
            "status": "not_started"
          },
          "build": {
            "status": "not_started"
          },
          "upload": {
            "status": "not_started"
          }
        },
        "java": {
          "commit": {
            "status": "not_started"
          },
          "lint": {
            "status": "not_started"
          },
          "object": "build_target",
          "status": "not_started",
          "test": {
            "status": "not_started"
          },
          "build": {
            "status": "not_started"
          },
          "upload": {
            "status": "not_started"
          }
        },
        "kotlin": {
          "commit": {
            "status": "not_started"
          },
          "lint": {
            "status": "not_started"
          },
          "object": "build_target",
          "status": "not_started",
          "test": {
            "status": "not_started"
          },
          "build": {
            "status": "not_started"
          },
          "upload": {
            "status": "not_started"
          }
        },
        "node": {
          "commit": {
            "status": "not_started"
          },
          "lint": {
            "status": "not_started"
          },
          "object": "build_target",
          "status": "not_started",
          "test": {
            "status": "not_started"
          },
          "build": {
            "status": "not_started"
          },
          "upload": {
            "status": "not_started"
          }
        },
        "php": {
          "commit": {
            "status": "not_started"
          },
          "lint": {
            "status": "not_started"
          },
          "object": "build_target",
          "status": "not_started",
          "test": {
            "status": "not_started"
          },
          "build": {
            "status": "not_started"
          },
          "upload": {
            "status": "not_started"
          }
        },
        "python": {
          "commit": {
            "status": "not_started"
          },
          "lint": {
            "status": "not_started"
          },
          "object": "build_target",
          "status": "not_started",
          "test": {
            "status": "not_started"
          },
          "build": {
            "status": "not_started"
          },
          "upload": {
            "status": "not_started"
          }
        },
        "ruby": {
          "commit": {
            "status": "not_started"
          },
          "lint": {
            "status": "not_started"
          },
          "object": "build_target",
          "status": "not_started",
          "test": {
            "status": "not_started"
          },
          "build": {
            "status": "not_started"
          },
          "upload": {
            "status": "not_started"
          }
        },
        "terraform": {
          "commit": {
            "status": "not_started"
          },
          "lint": {
            "status": "not_started"
          },
          "object": "build_target",
          "status": "not_started",
          "test": {
            "status": "not_started"
          },
          "build": {
            "status": "not_started"
          },
          "upload": {
            "status": "not_started"
          }
        },
        "typescript": {
          "commit": {
            "status": "not_started"
          },
          "lint": {
            "status": "not_started"
          },
          "object": "build_target",
          "status": "not_started",
          "test": {
            "status": "not_started"
          },
          "build": {
            "status": "not_started"
          },
          "upload": {
            "status": "not_started"
          }
        }
      },
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}