Microsoft Azure

Azure Webpubsub

WebPubSubServiceClient

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

WebPubSubServiceClient

Endpoints 25

general

  • HEADGet service health status./api/health?api-version=stringGet service health status.

webpubsub

  • POSTAdd filtered connections to multiple groups./api/hubs/:hub/:addToGroups?api-version=stringAdd filtered connections to multiple groups.
  • POSTClose the connections in the hub./api/hubs/:hub/:closeConnections?api-version=string&excluded=string&reason=stringClose the connections in the hub.
  • POSTGenerate token for the client to connect Azure Web PubSub service./api/hubs/:hub/:generateToken?api-version=string&userId=string&role=string&minutesToExpire=60&group=string&clientType=DefaultGenerate token for the client to connect Azure Web PubSub service.
  • POSTRemove filtered connections from multiple groups./api/hubs/:hub/:removeFromGroups?api-version=stringRemove filtered connections from multiple groups.
  • POSTBroadcast content inside request body to all the connected client connections./api/hubs/:hub/:send?api-version=string&excluded=string&filter=string&messageTtlSeconds=0Broadcast content inside request body to all the connected client connections.
  • DELETEClose the client connection./api/hubs/:hub/connections/:connectionId?api-version=string&reason=stringClose the client connection.
  • HEADCheck if the connection with the given connectionId exists./api/hubs/:hub/connections/:connectionId?api-version=stringCheck if the connection with the given connectionId exists.
  • POSTSend content inside request body to the specific connection./api/hubs/:hub/connections/:connectionId/:send?api-version=string&messageTtlSeconds=0Send content inside request body to the specific connection.
  • DELETERemove a connection from all groups./api/hubs/:hub/connections/:connectionId/groups?api-version=stringRemove a connection from all groups.
  • HEADCheck if there are any client connections inside the given group/api/hubs/:hub/groups/:group?api-version=stringCheck if there are any client connections inside the given group
  • POSTClose connections in the specific group./api/hubs/:hub/groups/:group/:closeConnections?api-version=string&excluded=string&reason=stringClose connections in the specific group.
  • POSTSend content inside request body to a group of connections./api/hubs/:hub/groups/:group/:send?api-version=string&excluded=string&filter=string&messageTtlSeconds=0Send content inside request body to a group of connections.
  • GETList connections in a group./api/hubs/:hub/groups/:group/connections?api-version=string&maxpagesize=1&top=1&continuationToken=stringList connections in a group.
  • PUTAdd a connection to the target group./api/hubs/:hub/groups/:group/connections/:connectionId?api-version=stringAdd a connection to the target group.
  • DELETERemove a connection from the target group./api/hubs/:hub/groups/:group/connections/:connectionId?api-version=stringRemove a connection from the target group.
  • PUTGrant permission to the connection./api/hubs/:hub/permissions/:permission/connections/:connectionId?api-version=string&targetName=stringGrant permission to the connection.
  • DELETERevoke permission for the connection./api/hubs/:hub/permissions/:permission/connections/:connectionId?api-version=string&targetName=stringRevoke permission for the connection.
  • HEADCheck if a connection has permission to the specified action./api/hubs/:hub/permissions/:permission/connections/:connectionId?api-version=string&targetName=stringCheck if a connection has permission to the specified action.
  • HEADCheck if there are any client connections connected for the given user./api/hubs/:hub/users/:userId?api-version=stringCheck if there are any client connections connected for the given user.
  • POSTClose connections for the specific user./api/hubs/:hub/users/:userId/:closeConnections?api-version=string&excluded=string&reason=stringClose connections for the specific user.
  • POSTSend content inside request body to the specific user./api/hubs/:hub/users/:userId/:send?api-version=string&filter=string&messageTtlSeconds=0Send content inside request body to the specific user.
  • DELETERemove a user from all groups./api/hubs/:hub/users/:userId/groups?api-version=stringRemove a user from all groups.
  • PUTAdd a user to the target group./api/hubs/:hub/users/:userId/groups/:group?api-version=stringAdd a user to the target group.
  • DELETERemove a user from the target group./api/hubs/:hub/users/:userId/groups/:group?api-version=stringRemove a user from the target group.

API details

Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
25 operations on 20 pathsPOST 10DELETE 6HEAD 5PUT 3GET 1
Main resources
webpubsub 24general 1
Response formats
application/json
Description format
Swagger 2.0, API version 2024-12-01

How to test the Azure Webpubsub in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Webpubsub collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get service health status.” (HEAD /api/health?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Webpubsub?

WebPubSubServiceClient It is listed under Developer tools and has 25 endpoints.

Who publishes the Azure Webpubsub?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the Azure Webpubsub?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Webpubsub have?

25 operations on 20 paths (10 POST, 6 DELETE, 5 HEAD, 3 PUT, 1 GET). The largest groups are webpubsub, general.

Is forking the Azure Webpubsub free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.