JetBrains Agile Boards API

Agile board management

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

jetbrains-agile-boards-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: JetBrains Hub REST Activities Agile Boards 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: Agile Boards
  description: Agile board management
paths:
  /agiles:
    get:
      summary: JetBrains List Agile Boards
      description: Returns a list of agile boards.
      operationId: listAgileBoards
      tags:
      - Agile Boards
      responses:
        '200':
          description: Successful response with agile board list
  /agiles/{agileId}:
    get:
      summary: JetBrains Get Agile Board
      description: Returns details of a specific agile board.
      operationId: getAgileBoard
      tags:
      - Agile Boards
      parameters:
      - name: agileId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response with agile board details
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Permanent token or OAuth 2.0 Bearer Token