GitLab VS Code API

openapi: 3.2.0
info:
  title: GitLab REST VS Code API
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:
- name: VSCode
  description: 'Use this API to synchronize Visual Studio Code settings, so that a user''s editor preferences follow

    them between VS Code and the Web IDE.'
  x-displayName: VS Code
paths:
  /api/v4/vscode/settings_sync/v1/manifest:
    get:
      operationId: getApiV4VscodeSettingsSyncV1Manifest
      summary: Retrieve the settings manifest for Settings Sync
      description: Retrieves the manifest of the settings stored for VS Code Settings Sync.
      tags:
      - VSCode
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIVsCodeSettingsEntitiesVsCodeManifest'
        '401':
          description: 401 Unauthorized
        '404':
          description: Not Found
        '400':
          description: Bad Request
  /api/v4/vscode/settings_sync/{settings_context_hash}/v1/manifest:
    get:
      operationId: getApiV4VscodeSettingsSyncSettingsContextHashV1Manifest
      summary: Retrieve the settings manifest for Settings Sync
      description: Retrieves the manifest of the settings stored for VS Code Settings Sync.
      tags:
      - VSCode
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIVsCodeSettingsEntitiesVsCodeManifest'
        '401':
          description: 401 Unauthorized
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: settings_context_hash
        required: true
        description: Settings context hash.
        schema:
          type: string
        in: path
  /api/v4/vscode/settings_sync/v1/resource/{resource_name}/{id}:
    get:
      operationId: getApiV4VscodeSettingsSyncV1ResourceResourceNameId
      summary: Retrieve a specific setting resource
      description: Retrieves a single VS Code setting resource. Returns 204 when the resource does not exist.
      tags:
      - VSCode
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIVsCodeSettingsEntitiesVsCodeSetting'
        '204':
          description: No content
        '400':
          description: 400 bad request
        '401':
          description: 401 Unauthorized
        '404':
          description: Not Found
      parameters:
      - name: resource_name
        required: true
        description: Name of the resource such as settings.
        schema:
          type: string
          enum:
          - settings
          - extensions
          - globalState
          - machines
          - keybindings
          - snippets
          - tasks
          - profiles
          minLength: 1
        in: path
      - name: id
        required: true
        description: ID of the resource to retrieve.
        schema:
          type: string
        in: path
  /api/v4/vscode/settings_sync/{settings_context_hash}/v1/resource/{resource_name}/{id}:
    get:
      operationId: getApiV4VscodeSettingsSyncSettingsContextHashV1ResourceResourceNameId
      summary: Retrieve a specific setting resource
      description: Retrieves a single VS Code setting resource. Returns 204 when the resource does not exist.
      tags:
      - VSCode
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIVsCodeSettingsEntitiesVsCodeSetting'
        '204':
          description: No content
        '400':
          description: 400 bad request
        '401':
          description: 401 Unauthorized
        '404':
          description: Not Found
      parameters:
      - name: settings_context_hash
        required: true
        description: Settings context hash.
        schema:
          type: string
        in: path
      - name: resource_name
        required: true
        description: Name of the resource such as settings.
        schema:
          type: string
          enum:
          - settings
          - extensions
          - globalState
          - machines
          - keybindings
          - snippets
          - tasks
          - profiles
          minLength: 1
        in: path
      - name: id
        required: true
        description: ID of the resource to retrieve.
        schema:
          type: string
        in: path
  /api/v4/vscode/settings_sync/v1/resource/{resource_name}:
    get:
      operationId: getApiV4VscodeSettingsSyncV1ResourceResourceName
      summary: List all references to a VS Code setting resource
      description: Lists all references to the stored versions of a VS Code setting resource.
      tags:
      - VSCode
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIVsCodeSettingsEntitiesVsCodeSettingReference'
        '400':
          description: 400 bad request
        '401':
          description: 401 Unauthorized
        '404':
          description: Not Found
      parameters:
      - name: resource_name
        required: true
        description: Name of the resource such as settings.
        schema:
          type: string
          enum:
          - settings
          - extensions
          - globalState
          - machines
          - keybindings
          - snippets
          - tasks
          - profiles
          minLength: 1
        in: path
    post:
      operationId: postApiV4VscodeSettingsSyncV1ResourceResourceName
      summary: Create or update a specific setting
      description: Creates a VS Code setting resource, or updates it if it already exists.
      tags:
      - VSCode
      responses:
        '200':
          description: OK
        '400':
          description: Bad request
        '401':
          description: 401 Unauthorized
        '404':
          description: Not Found
      parameters:
      - name: resource_name
        required: true
        description: Name of the resource such as settings.
        schema:
          type: string
          enum:
          - settings
          - extensions
          - globalState
          - machines
          - keybindings
          - snippets
          - tasks
          - profiles
          minLength: 1
        in: path
  /api/v4/vscode/settings_sync/{settings_context_hash}/v1/resource/{resource_name}:
    get:
      operationId: getApiV4VscodeSettingsSyncSettingsContextHashV1ResourceResourceName
      summary: List all references to a VS Code setting resource
      description: Lists all references to the stored versions of a VS Code setting resource.
      tags:
      - VSCode
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIVsCodeSettingsEntitiesVsCodeSettingReference'
        '400':
          description: 400 bad request
        '401':
          description: 401 Unauthorized
        '404':
          description: Not Found
      parameters:
      - name: settings_context_hash
        required: true
        description: Settings context hash.
        schema:
          type: string
        in: path
      - name: resource_name
        required: true
        description: Name of the resource such as settings.
        schema:
          type: string
          enum:
          - settings
          - extensions
          - globalState
          - machines
          - keybindings
          - snippets
          - tasks
          - profiles
          minLength: 1
        in: path
    post:
      operationId: postApiV4VscodeSettingsSyncSettingsContextHashV1ResourceResourceName
      summary: Create or update a specific setting
      description: Creates a VS Code setting resource, or updates it if it already exists.
      tags:
      - VSCode
      responses:
        '200':
          description: OK
        '400':
          description: Bad request
        '401':
          description: 401 Unauthorized
        '404':
          description: Not Found
      parameters:
      - name: settings_context_hash
        required: true
        description: Settings context hash.
        schema:
          type: string
        in: path
      - name: resource_name
        required: true
        description: Name of the resource such as settings.
        schema:
          type: string
          enum:
          - settings
          - extensions
          - globalState
          - machines
          - keybindings
          - snippets
          - tasks
          - profiles
          minLength: 1
        in: path
  /api/v4/vscode/settings_sync/v1/collection:
    delete:
      operationId: deleteApiV4VscodeSettingsSyncV1Collection
      summary: Delete all VS Code setting resources for a user
      description: Deletes all VS Code setting resources of the current user.
      tags:
      - VSCode
      responses:
        '200':
          description: OK
        '401':
          description: 401 Unauthorized
        '404':
          description: Not Found
        '400':
          description: Bad Request
  /api/v4/vscode/settings_sync/{settings_context_hash}/v1/collection:
    delete:
      operationId: deleteApiV4VscodeSettingsSyncSettingsContextHashV1Collection
      summary: Delete all VS Code setting resources for a user
      description: Deletes all VS Code setting resources of the current user.
      tags:
      - VSCode
      responses:
        '200':
          description: OK
        '401':
          description: 401 Unauthorized
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: settings_context_hash
        required: true
        description: Settings context hash.
        schema:
          type: string
        in: path
components:
  schemas:
    APIVsCodeSettingsEntitiesVsCodeSettingReference:
      type: object
      properties:
        url:
          type: string
        created:
          type: string
    APIVsCodeSettingsEntitiesVsCodeManifest:
      type: object
      properties:
        latest:
          type: string
        session:
          type: string
          example: '1'
    APIVsCodeSettingsEntitiesVsCodeSetting:
      type: object
      properties:
        content:
          type: string
        machines:
          type: string
        version:
          type: string
        machineId:
          type: string
  securitySchemes:
    http:
      type: http
      scheme: bearer
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://gitlab.com/oauth/authorize
          tokenUrl: https://gitlab.com/oauth/token
          refreshUrl: https://gitlab.com/oauth/token
          scopes:
            api: Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.
            read_api: Grants read access to the API, including all groups and projects, the container registry, and the package registry.
            read_user: Grants read-only access to your profile through the /user API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under /users.
            create_runner: Grants create access to the runners.
            manage_runner: Grants access to manage the runners.
            k8s_proxy: Grants permission to perform Kubernetes API calls using the agent for Kubernetes.
            self_rotate: Grants permission for token to rotate itself.
            mcp: Grants read-write access to remote Model Context Protocol (MCP) server for tools execution.
            mcp_orbit: Grants access to the Orbit Knowledge Graph MCP server for graph queries and schema retrieval.
    apiKey:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header