JetBrains Builds API

Build execution and results

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

jetbrains-builds-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: JetBrains Hub REST Activities Builds API
  description: The JetBrains Hub REST API provides programmatic access to Hub, the centralized authentication and authorization service for JetBrains tools. It allows management of users, groups, projects, roles, permissions, and OAuth 2.0 services. Hub serves as the identity provider for YouTrack, TeamCity, and other connected JetBrains services.
  version: 2024.1.0
  contact:
    name: JetBrains
    url: https://www.jetbrains.com/help/youtrack/devportal/hub-rest-api-reference.html
  license:
    name: Proprietary
    url: https://www.jetbrains.com/legal/
servers:
- url: https://{instance}.youtrack.cloud/hub/api/rest
  description: Hub API (via YouTrack Cloud)
  variables:
    instance:
      default: myinstance
      description: Your instance name
security:
- bearerAuth: []
tags:
- name: Builds
  description: Build execution and results
paths:
  /builds:
    get:
      summary: JetBrains List Builds
      description: Returns a list of builds matching the specified locator.
      operationId: listBuilds
      tags:
      - Builds
      parameters:
      - name: locator
        in: query
        schema:
          type: string
      - name: fields
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Successful response with build list
  /builds/{buildLocator}:
    get:
      summary: JetBrains Get Build
      description: Returns details of a specific build.
      operationId: getBuild
      tags:
      - Builds
      parameters:
      - name: buildLocator
        in: path
        required: true
        schema:
          type: string
      - name: fields
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Successful response with build details
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Permanent token or OAuth 2.0 Bearer Token