Dev Proxy Proxy API

openapi: 3.1.0
info:
  title: Microsoft Dev — JWT Proxy API
  description: 'Dev Proxy is a Microsoft command-line API simulator. While running, it exposes a

    local HTTP control API on a port configured in the proxy settings (default 8897)

    so callers can inspect proxy state, toggle recording, generate JWTs, raise mock

    requests, fetch the root certificate, and shut the proxy down programmatically.

    '
  version: 1.0.0
  contact:
    name: Microsoft Dev Proxy
    url: https://learn.microsoft.com/en-us/microsoft-cloud/dev/dev-proxy/
servers:
- url: http://localhost:8897
  description: Local Dev Proxy control plane (default port)
tags:
- name: Proxy
paths:
  /proxy:
    get:
      summary: Get Dev Proxy state
      description: Returns information about the currently running Dev Proxy instance.
      operationId: getProxyInfo
      tags:
      - Proxy
      responses:
        '200':
          description: Proxy info
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyInfo'
    post:
      summary: Control Dev Proxy
      description: Start or stop request recording.
      operationId: setProxyState
      tags:
      - Proxy
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                recording:
                  type: boolean
      responses:
        '200':
          description: Updated proxy info
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyInfo'
  /proxy/mockrequest:
    post:
      summary: Raise a mock request
      description: Equivalent of pressing `w` in the Dev Proxy console.
      operationId: raiseMockRequest
      tags:
      - Proxy
      responses:
        '202':
          description: Mock request accepted
  /proxy/rootCertificate:
    get:
      summary: Download Dev Proxy root certificate (PEM)
      operationId: getRootCertificate
      tags:
      - Proxy
      parameters:
      - name: format
        in: query
        required: true
        schema:
          type: string
          enum:
          - crt
      responses:
        '200':
          description: PEM-encoded root certificate
          content:
            application/x-x509-ca-cert:
              schema:
                type: string
        '400':
          description: Unsupported format
  /proxy/stopproxy:
    post:
      summary: Gracefully shut down Dev Proxy
      operationId: stopProxy
      tags:
      - Proxy
      responses:
        '202':
          description: Shutdown accepted
components:
  schemas:
    ProxyInfo:
      type: object
      properties:
        recording:
          type: boolean
          description: Whether the proxy is currently recording requests
        configFile:
          type: string
          description: Path to the configuration file (read-only)