Microsoft Edge Pages API

openapi: 3.0.3
info:
  title: Microsoft Edge Add-ons Browser Pages API
  description: REST API for managing Microsoft Edge browser extensions through the Partner Center. Enables programmatic publishing, updating, and managing Edge extensions in the Microsoft Edge Add-ons store, supporting the full extension lifecycle from upload to publication.
  version: 1.0.0
  contact:
    name: Microsoft Edge Developer
    url: https://developer.microsoft.com/microsoft-edge/
  license:
    name: Microsoft Software License
    url: https://www.microsoft.com/legal/terms-of-use
  x-generated-from: documentation
  x-last-validated: '2026-04-18'
servers:
- url: https://api.addons.microsoftedge.microsoft.com
  description: Microsoft Edge Add-ons API Production
security:
- bearerAuth: []
tags:
- name: Pages
  description: Page target management
paths:
  /json/new:
    put:
      operationId: createTarget
      summary: Microsoft Edge Create New Target
      description: Opens a new tab navigated to the specified URL and returns the new target's debugging information.
      tags:
      - Pages
      parameters:
      - name: url
        in: query
        required: false
        description: URL to navigate the new tab to
        schema:
          type: string
          format: uri
        example: https://www.example.com
      responses:
        '200':
          description: New target created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Target'
              examples:
                CreateTarget200Example:
                  summary: Default createTarget 200 response
                  x-microcks-default: true
                  value:
                    description: ''
                    devtoolsFrontendUrl: /devtools/inspector.html?ws=localhost:9222/devtools/page/DEF456
                    id: DEF456
                    title: New Tab
                    type: page
                    url: https://www.example.com
                    webSocketDebuggerUrl: ws://localhost:9222/devtools/page/DEF456
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /json/activate/{targetId}:
    post:
      operationId: activateTarget
      summary: Microsoft Edge Activate Target
      description: Brings the specified target to the foreground, making it the active page in the browser window.
      tags:
      - Pages
      parameters:
      - name: targetId
        in: path
        required: true
        description: Target identifier
        schema:
          type: string
        example: ABC123
      responses:
        '200':
          description: Target activated successfully
          content:
            text/plain:
              schema:
                type: string
              examples:
                ActivateTarget200Example:
                  summary: Default activateTarget 200 response
                  x-microcks-default: true
                  value: Target activated
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /json/close/{targetId}:
    post:
      operationId: closeTarget
      summary: Microsoft Edge Close Target
      description: Closes the specified target tab or page.
      tags:
      - Pages
      parameters:
      - name: targetId
        in: path
        required: true
        description: Target identifier
        schema:
          type: string
        example: ABC123
      responses:
        '200':
          description: Target closed successfully
          content:
            text/plain:
              schema:
                type: string
              examples:
                CloseTarget200Example:
                  summary: Default closeTarget 200 response
                  x-microcks-default: true
                  value: Target is closing
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Target:
      type: object
      description: A debuggable browser target
      properties:
        description:
          type: string
          description: Target description
          example: ''
        devtoolsFrontendUrl:
          type: string
          description: URL to the DevTools frontend for this target
          example: /devtools/inspector.html?ws=localhost:9222/devtools/page/ABC123
        faviconUrl:
          type: string
          description: URL to the target's favicon
          example: https://www.example.com/favicon.ico
        id:
          type: string
          description: Unique target identifier
          example: ABC123
        title:
          type: string
          description: Page title
          example: Example Page
        type:
          type: string
          description: Target type
          enum:
          - page
          - background_page
          - service_worker
          - worker
          - iframe
          - other
          example: page
        url:
          type: string
          format: uri
          description: Current URL of the target
          example: https://www.example.com
        webSocketDebuggerUrl:
          type: string
          description: WebSocket URL for debugging this target
          example: ws://localhost:9222/devtools/page/ABC123
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 access token obtained from Azure Active Directory using the client credentials flow with the Microsoft Partner Center API scope.