JetBrains Server API

Server information and metadata

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

jetbrains-server-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: JetBrains Hub REST Activities Server 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: Server
  description: Server information and metadata
paths:
  /server:
    get:
      summary: JetBrains Get Server Info
      description: Returns TeamCity server information and API navigation links.
      operationId: getServerInfo
      tags:
      - Server
      responses:
        '200':
          description: Successful response with server info
  /swagger.json:
    get:
      summary: JetBrains Get Swagger Spec
      description: Returns the full Swagger/OpenAPI specification for the TeamCity REST API.
      operationId: getSwaggerSpec
      tags:
      - Server
      responses:
        '200':
          description: Swagger JSON specification
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Permanent token or OAuth 2.0 Bearer Token