Azure Web PubSub

Azure Web PubSub Webpubsub API

The webpubsub API from Azure Web PubSub — 46 operation(s) for webpubsub.

GitHub OpenAPI

Operations 68

POST /api/hubs/{hub}/:addToGroups Add filtered connections to multiple groups #
POST /api/hubs/{hub}/:closeConnections Close the connections in the hub #
POST /api/hubs/{hub}/:generateToken Generate token for the client to connect Azure Web PubSub service #
POST /api/hubs/{hub}/:removeFromGroups Remove filtered connections from multiple groups #
POST /api/hubs/{hub}/:send Broadcast content inside request body to all the connected client connections #
DELETE /api/hubs/{hub}/connections/{connectionId} Close the client connection #
HEAD /api/hubs/{hub}/connections/{connectionId} Check if the connection with the given connectionId exists #
POST /api/hubs/{hub}/connections/{connectionId}/:send Send content inside request body to the specific connection #
DELETE /api/hubs/{hub}/connections/{connectionId}/groups Remove a connection from all groups #
HEAD /api/hubs/{hub}/groups/{group} Check if there are any client connections inside the given group #
POST /api/hubs/{hub}/groups/{group}/:closeConnections Close connections in the specific group #
POST /api/hubs/{hub}/groups/{group}/:send Send content inside request body to a group of connections #
GET /api/hubs/{hub}/groups/{group}/connections List connections in a group #
PUT /api/hubs/{hub}/groups/{group}/connections/{connectionId} Add a connection to the target group #
DELETE /api/hubs/{hub}/groups/{group}/connections/{connectionId} Remove a connection from the target group #
PUT /api/hubs/{hub}/permissions/{permission}/connections/{connectionId} Grant permission to the connection #
DELETE /api/hubs/{hub}/permissions/{permission}/connections/{connectionId} Revoke permission for the connection #
HEAD /api/hubs/{hub}/permissions/{permission}/connections/{connectionId} Check if a connection has permission to the specified action #
HEAD /api/hubs/{hub}/users/{userId} Check if there are any client connections connected for the given user #
POST /api/hubs/{hub}/users/{userId}/:closeConnections Close connections for the specific user #
POST /api/hubs/{hub}/users/{userId}/:send Send content inside request body to the specific user #
DELETE /api/hubs/{hub}/users/{userId}/groups Remove a user from all groups #
PUT /api/hubs/{hub}/users/{userId}/groups/{group} Add a user to the target group #
DELETE /api/hubs/{hub}/users/{userId}/groups/{group} Remove a user from the target group #
GET /providers/Microsoft.SignalRService/operations Operations list #
POST /subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability Web pub sub check name availability #
GET /subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages Usages list #
GET /subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/webPubSub Web pub sub list by subscription #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub Web pub sub list by resource group #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName} Web pub sub get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName} Web pub sub create or update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName} Web pub sub delete #
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName} Web pub sub update #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates Web pub sub custom certificates list #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates/{certificateName} Web pub sub custom certificates get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates/{certificateName} Web pub sub custom certificates create or update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customCertificates/{certificateName} Web pub sub custom certificates delete #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains Web pub sub custom domains list #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains/{name} Web pub sub custom domains get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains/{name} Web pub sub custom domains create or update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/customDomains/{name} Web pub sub custom domains delete #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs Web pub sub hubs list #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName} Web pub sub hubs get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName} Web pub sub hubs create or update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/hubs/{hubName} Web pub sub hubs delete #
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/listKeys Web pub sub list keys #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections Web pub sub private endpoint connections list #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName} Web pub sub private endpoint connections get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName} Web pub sub private endpoint connections update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName} Web pub sub private endpoint connections delete #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/privateLinkResources Web pub sub private link resources list #
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/regenerateKey Web pub sub regenerate key #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas Web pub sub replicas list #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName} Web pub sub replicas get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName} Web pub sub replicas create or update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName} Web pub sub replicas delete #
PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName} Web pub sub replicas update #
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/restart Web pub sub replicas restart #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources Web pub sub replica shared private link resources list #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName} Web pub sub replica shared private link resources get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName} Web pub sub replica shared private link resources create or update #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/replicas/{replicaName}/skus Web pub sub list replica skus #
POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/restart Web pub sub restart #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources Web pub sub shared private link resources list #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName} Web pub sub shared private link resources get #
PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName} Web pub sub shared private link resources create or update #
DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/sharedPrivateLinkResources/{sharedPrivateLinkResourceName} Web pub sub shared private link resources delete #
GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/webPubSub/{resourceName}/skus Web pub sub list skus #

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socketio-overview
📖
GettingStarted
https://learn.microsoft.com/en-us/azure/azure-web-pubsub/socketio-quickstart
📖
Authentication
https://learn.microsoft.com/en-us/azure/azure-web-pubsub/howto-generate-client-access-url
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/webpubsub
📖
Authentication
https://learn.microsoft.com/en-us/azure/active-directory/develop/authentication-scenarios

Specifications

⚙
OpenAPI
https://artifacts.apis.io/microsoft-azure-web-pubsub/openapi/microsoft-azure-web-pubsub-webpubsub-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-web-pubsub/json-schema/microsoft-azure-web-pubsub-web-pub-sub-keys-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-web-pubsub/json-schema/microsoft-azure-web-pubsub-shared-private-link-resource-list-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-web-pubsub/json-schema/microsoft-azure-web-pubsub-private-endpoint-connection-list-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-web-pubsub/json-schema/microsoft-azure-web-pubsub-sku-list-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-web-pubsub/json-schema/microsoft-azure-web-pubsub-operation-list-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-web-pubsub/json-schema/microsoft-azure-web-pubsub-name-availability-parameters-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-web-pubsub/json-schema/microsoft-azure-web-pubsub-remove-from-groups-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-web-pubsub/json-schema/microsoft-azure-web-pubsub-add-to-groups-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-web-pubsub/json-schema/microsoft-azure-web-pubsub-group-member-paged-values-schema.json
📊
JSONSchema
https://artifacts.apis.io/microsoft-azure-web-pubsub/json-schema/microsoft-azure-web-pubsub-client-token-response-schema.json

Other Resources

🔗
Reference
https://learn.microsoft.com/en-us/rest/api/webpubsub/controlplane/web-pub-sub

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-webpubsub-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

microsoft-azure-web-pubsub-webpubsub-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Microsoft Azure Web Pubsub Webpubsub API
  x-refined-note:
  - x-typespec-generated differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged webpubsub across 2 of this provider''s published API definitions: microsoft-azure-web-pubsub-data-plane-2024-12-01-swagger.json, microsoft-azure-web-pubsub-management-2024-03-01-swagger.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
tags:


# --- truncated at 32 KB (169 KB total) ---
# Full source: https://artifacts.apis.io/microsoft-azure-web-pubsub/openapi/microsoft-azure-web-pubsub-webpubsub-api-openapi.yml