JetBrains Projects API

openapi: 3.0.3
info:
  title: JetBrains Hub REST Activities Projects 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: Projects
  description: Project management
paths:
  /projects:
    get:
      summary: JetBrains List Projects
      description: Returns a list of Hub projects.
      operationId: listProjects
      tags:
      - Projects
      responses:
        '200':
          description: Successful response with project list
    post:
      summary: JetBrains Create Project
      description: Creates a new project.
      operationId: createProject
      tags:
      - Projects
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Project created successfully
  /projects/{projectId}:
    get:
      summary: JetBrains Get Project
      description: Returns details of a specific project.
      operationId: getProject
      tags:
      - Projects
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response with project details
  /projects/{projectLocator}:
    get:
      summary: JetBrains Get Project
      description: Returns details of a specific project.
      operationId: getProject
      tags:
      - Projects
      parameters:
      - name: projectLocator
        in: path
        required: true
        schema:
          type: string
      - name: fields
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Successful response with project details
  /admin/projects:
    get:
      summary: JetBrains List Projects
      description: Returns a list of projects.
      operationId: listProjects
      tags:
      - Projects
      parameters:
      - name: fields
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Successful response with project list
  /admin/projects/{projectId}:
    get:
      summary: JetBrains Get Project
      description: Returns details of a specific project.
      operationId: getProject
      tags:
      - Projects
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response with project details
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Permanent token or OAuth 2.0 Bearer Token