JetBrains Plugins API

openapi: 3.0.3
info:
  title: JetBrains Hub REST Activities Plugins 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: Plugins
  description: Plugin listing and search
paths:
  /plugins/list/:
    get:
      summary: JetBrains List Plugins
      description: Returns a list of all plugins compatible with a provided IDE build.
      operationId: listPlugins
      tags:
      - Plugins
      parameters:
      - name: build
        in: query
        description: IDE build number (e.g., IC-232.8660.185)
        schema:
          type: string
      responses:
        '200':
          description: Successful response with plugin list
  /api/plugins/{pluginId}:
    get:
      summary: JetBrains Get Plugin Details
      description: Returns details of a specific plugin.
      operationId: getPlugin
      tags:
      - Plugins
      parameters:
      - name: pluginId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successful response with plugin details
  /api/searchPlugins:
    get:
      summary: JetBrains Search Plugins
      description: Searches for plugins by keyword and filters.
      operationId: searchPlugins
      tags:
      - Plugins
      parameters:
      - name: search
        in: query
        schema:
          type: string
      - name: max
        in: query
        schema:
          type: integer
      - name: offset
        in: query
        schema:
          type: integer
      - name: orderBy
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Successful response with search results
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Permanent token or OAuth 2.0 Bearer Token