Welcome
Extending Product Functions
You can create your own plug-ins to extend the product’s capabilities.
REST API reference
The Build server has a REST interface, which you can use to automate tasks on the server.
REST commands for Build
The following list shows the commands that are available.
dashboard resource
/dashboard/projects GET

Build
Build offers the capability to build applications, manage continuous integration workflows, and store build artifacts.
System requirements
Overview of Build
Build is a continuous integration and build-management system.
Tutorials
Administering
Users with the correct permissions can configure security, create users, configure integrations, and create notifications and announcements among other things.
Creating and Managing Projects
Projects run builds, manage dependencies with third-party tools, and can be used for administrative, operational, and system maintenance.
Build pipelines
A build pipeline defines the automated process that transforms source code into deployable artifacts. It specifies the steps required to compile, test, validate, scan, and package the code.
Creating Jobs and Processes
Jobs are the core building blocks of Build. Process definitions assemble jobs into the basic unit of automation. A process definition determines how, when, and where jobs run.
Managing Project Templates
Project templates are reusable plans that map build processes.
Monitoring and Reporting
With the monitoring tools you can review current and historical activity and save your filter conditions for future use. You can create charts and reports from most database tables.
Extending Product Functions
You can create your own plug-ins to extend the product’s capabilities.
- Plug-ins
  Build plug-ins provide tools for creating workflows and integrating with external tools.
- Example plug-in
  A plug-in consists of one or more steps. A step represents a unit of functionality that a user can configure and combine with other steps into a process. Creating a plug-in consists of defining its individual steps and then grouping them for presentation in Build.
- Build Scripting
  The scripting API describes the various types of supported scripts.
- Properties in Build
  Properties can be set for many different things, including projects, build configurations, process configurations, build requests, and the server. You can also set and retrieve agent properties.
- REST API reference
  The Build server has a REST interface, which you can use to automate tasks on the server.
  - Running REST commands
    Many different programs can run REST commands. To run the command, you call a method on a REST resource and pass parameters or a request in JSON format.
  - Authenticating for REST commands
    The way that you authenticate to run REST commands depends on how the server is set up and the tool that you are using to run the commands.
  - REST API conventions
    The Build REST API follows a set of conventions to make interacting with it more consistent.
  - REST commands for Build
    The following list shows the commands that are available.
    - agentPools resource
    - agents resource
      Resources for working with agents.
    - artifactsets resource
    - authenticationRealm resource
    - authorizationRealm resource
    - authtoken resource
    - authtokens resource
    - build-lives resource
    - buildProcessTemplates resource
      Resources for working with build process templates.
    - codestation-build-lives resource
    - codestation-projects resource
    - conf/locale resource
    - currentActivity resource
    - dashboard resource
    - dependencyConfig resource
    - dynamicAgentPools resource
    - file resource
    - files resource
    - fixedAgentPools resource
    - group resource
    - import resource
    - jobPreConditions resource
    - jobPreConditionScripts resource
    - jobs resource
    - label resource
    - logs resource
    - myactivity resource
    - notificationSubscriptions resource
    - plugins resource
    - preferences resource
    - preflight resource
    - processRequests resource
    - processTemplates resource
      Resources for working with process templates.
    - projects resource
    - radiator resource
    - repo resource
    - reporting resource
    - reports resource
    - repositories resource
    - requestStatuses resource
    - resource resource
    - resourceRole resource
    - resourceType resource
    - role resource
    - search resource
    - secondaryProcessTemplates resource
      Resources for working with secondary process templates.
    - security resource
    - sourceTemplates resource
      Resources for working with source config templates.
    - stage resource
    - statuses resource
    - stepPreConditionScripts resource
    - steps resource
    - system resource
    - team resource
    - templates resource
      Resources for working with project templates.
    - trends resource
    - user resource
    - users resource
    - workDirScripts resource
    - workflow/{workflowId/dependencies resource
    - workflow/massdependencytree resource
    - workflowStatuses resource

/dashboard/projects GET

Request

GET https://{hostname}:{port}
  /build/rest2/dashboard/projects?{parameters}

Table 1. Request parameters
Parameter	Type	Required	Description
name	string	false	The project name pattern, * is allowed as a wildcard character
showInactive	boolean	false	When set to true, only show inactive projects. When set to false, only show active projects.