Azure Web PubSub

Azure Web PubSub General API

The general API from Azure Web PubSub — 1 operation(s) for general.

Documentation GitHub OpenAPI

Operations 1

HEAD /api/health Get service health status #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/microsoft-azure-web-pubsub:microsoft-azure-web-pubsub-general-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Azure Web PubSub Service REST General API
  version: '2024-12-01'
  description: WebPubSubServiceClient
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
security:
- OAuth2Auth:
  - https://webpubsub.azure.com/.default
tags:
- name: General
paths:
  /api/health:
    head:
      operationId: GetServiceStatus
      tags:
      - General
      summary: Get service health status
      description: Get service health status.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      responses:
        '200':
          description: The service is healthy.
        default:
          description: The error response.
          headers:
            x-ms-error-code:
              description: The error code.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
      x-ms-examples:
        GetServiceStatus:
          $ref: ./examples/HealthApi_GetServiceStatus.json
components:
  parameters:
    Azure.Core.Foundations.ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      x-ms-parameter-location: method
      x-ms-client-name: apiVersion
      schema:
        type: string
        minLength: 1
  schemas:
    InnerError:
      type: object
      description: Inner error detail.
      properties:
        code:
          type: string
          description: A more specific error code than was provided by the containing error.
        inner:
          $ref: '#/components/schemas/InnerError'
          description: Inner error.
    ErrorDetail:
      type: object
      description: The error object.
      properties:
        code:
          type: string
          description: One of a server-defined set of error codes.
        message:
          type: string
          description: A human-readable representation of the error.
        target:
          type: string
          description: The target of the error.
        details:
          type: array
          description: An array of details about specific errors that led to this reported error.
          items:
            $ref: '#/components/schemas/ErrorDetail'
        inner:
          $ref: '#/components/schemas/InnerError'
          description: An object containing more specific information about the error.
  securitySchemes:
    OAuth2Auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            https://webpubsub.azure.com/.default: ''
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - name: endpoint
    in: path
    description: HTTP or HTTPS endpoint for the Web PubSub service instance
    required: true
    type: string
    format: uri
    x-ms-skip-url-encoding: true

Azure Web PubSub General API

Operations 1

Documentation

Specifications

Schemas & Data

Other Resources