# Azure Web PubSub General API

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

Azure Web PubSub General 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. 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 general API from Azure Web PubSub — 1 operation(s) for general.

## Operations (1)

| Method | Path | Summary |
|---|---|---|
| HEAD | `/api/health` | Get service health status |

## Machine-readable artifacts (17)

- **OpenAPI** — https://artifacts.apis.io/microsoft-azure-web-pubsub/openapi/microsoft-azure-web-pubsub-general-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 Webpubsub API](https://apis.io/apis/microsoft-azure-web-pubsub/microsoft-azure-web-pubsub-webpubsub-api/)
- [Azure Web PubSub Client Token API](https://apis.io/apis/microsoft-azure-web-pubsub/microsoft-azure-web-pubsub-client-token-api/)

---

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