# Azure Web PubSub Webpubsub API

**Canonical:** https://apis.io/apis/microsoft-azure-web-pubsub/microsoft-azure-web-pubsub-webpubsub-api/  
**Provider:** Azure Web PubSub — https://apis.io/providers/microsoft-azure-web-pubsub/  
**Base URL:** https://management.azure.com  
**Documentation:** https://learn.microsoft.com/en-us/azure/azure-web-pubsub/reference-json-webpubsub-subprotocol

Azure Web PubSub Webpubsub API is one of 6 APIs that [Azure Web PubSub](https://apis.io/providers/microsoft-azure-web-pubsub/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 10 JSON Schema definitions. Tagged areas include Web PubSub. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, a getting-started guide, authentication docs, and 10 JSON Schemas.

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

## Operations (60 of 68)

| Method | Path | Summary |
|---|---|---|
| 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 |

…and 8 more operations. They are listed in full on the page.

## Machine-readable artifacts (17)

- **OpenAPI** — https://artifacts.apis.io/microsoft-azure-web-pubsub/openapi/microsoft-azure-web-pubsub-webpubsub-api-openapi.yml
- **Reference** — https://learn.microsoft.com/en-us/rest/api/webpubsub/controlplane/web-pub-sub
- **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
- **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
- **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 Azure Web PubSub APIs (5)

- [Azure Web PubSub Client and Upstream Events](https://apis.io/apis/microsoft-azure-web-pubsub/azure-web-pubsub-client-and-upstream-events/)
- [Azure Web PubSub Hub API](https://apis.io/apis/microsoft-azure-web-pubsub/microsoft-azure-web-pubsub-hub-api/)
- [Azure Web PubSub Permission API](https://apis.io/apis/microsoft-azure-web-pubsub/microsoft-azure-web-pubsub-permission-api/)
- [Azure Web PubSub General API](https://apis.io/apis/microsoft-azure-web-pubsub/microsoft-azure-web-pubsub-general-api/)
- [Azure Web PubSub Client Token API](https://apis.io/apis/microsoft-azure-web-pubsub/microsoft-azure-web-pubsub-client-token-api/)

## Tags

Web PubSub

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/microsoft-azure-web-pubsub/microsoft-azure-web-pubsub-webpubsub-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/microsoft-azure-web-pubsub/.