You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-signalr/signalr-reference-data-plane-rest-api.md
+23-17Lines changed: 23 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,28 +39,34 @@ The following table shows all versions of REST API we have for now. You can also
39
39
40
40
API Version | Status | Port | Doc | Spec
41
41
---|---|---|---|---
42
-
`1.0` | Latest | Standard | [Doc](./swagger/signalr-data-plane-rest-v1.md) | [swagger](https://github.com/Azure/azure-signalr/blob/dev/docs/swagger/v1.json)
42
+
`20220601` | Latest | Standard | [Doc](./swagger/signalr-data-plane-rest-v20220601.md) | [swagger](https://github.com/Azure/azure-signalr/blob/dev/docs/swagger/V20220601.json)
43
+
`1.0` | Stable | Standard | [Doc](./swagger/signalr-data-plane-rest-v1.md) | [swagger](https://github.com/Azure/azure-signalr/blob/dev/docs/swagger/v1.json)
43
44
`1.0-preview` | Obsolete | Standard | [Doc](./swagger/signalr-data-plane-rest-v1-preview.md) | [swagger](https://github.com/Azure/azure-signalr/blob/dev/docs/swagger/v1-preview.json)
44
45
45
46
The latest available APIs are listed as following.
46
47
47
48
48
49
| API | Path |
49
-
| ---- | ---------- |
50
-
|[Broadcast a message to all clients connected to target hub.](./swagger/signalr-data-plane-rest-v1.md#broadcast-a-message-to-all-clients-connected-to-target-hub)|`POST /api/v1/hubs/{hub}`|
51
-
|[Broadcast a message to all clients belong to the target user.](./swagger/signalr-data-plane-rest-v1.md#broadcast-a-message-to-all-clients-belong-to-the-target-user)|`POST /api/v1/hubs/{hub}/users/{id}`|
52
-
|[Send message to the specific connection.](./swagger/signalr-data-plane-rest-v1.md#send-message-to-the-specific-connection)|`POST /api/v1/hubs/{hub}/connections/{connectionId}`|
53
-
|[Check if the connection with the given connectionId exists](./swagger/signalr-data-plane-rest-v1.md#check-if-the-connection-with-the-given-connectionid-exists)|`GET /api/v1/hubs/{hub}/connections/{connectionId}`|
54
-
|[Close the client connection](./swagger/signalr-data-plane-rest-v1.md#close-the-client-connection)|`DELETE /api/v1/hubs/{hub}/connections/{connectionId}`|
55
-
|[Broadcast a message to all clients within the target group.](./swagger/signalr-data-plane-rest-v1.md#broadcast-a-message-to-all-clients-within-the-target-group)|`POST /api/v1/hubs/{hub}/groups/{group}`|
56
-
|[Check if there are any client connections inside the given group](./swagger/signalr-data-plane-rest-v1.md#check-if-there-are-any-client-connections-inside-the-given-group)|`GET /api/v1/hubs/{hub}/groups/{group}`|
57
-
|[Check if there are any client connections connected for the given user](./swagger/signalr-data-plane-rest-v1.md#check-if-there-are-any-client-connections-connected-for-the-given-user)|`GET /api/v1/hubs/{hub}/users/{user}`|
58
-
|[Add a connection to the target group.](./swagger/signalr-data-plane-rest-v1.md#add-a-connection-to-the-target-group)|`PUT /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}`|
59
-
|[Remove a connection from the target group.](./swagger/signalr-data-plane-rest-v1.md#remove-a-connection-from-the-target-group)|`DELETE /api/v1/hubs/{hub}/groups/{group}/connections/{connectionId}`|
60
-
|[Check whether a user exists in the target group.](./swagger/signalr-data-plane-rest-v1.md#check-whether-a-user-exists-in-the-target-group)|`GET /api/v1/hubs/{hub}/groups/{group}/users/{user}`|
61
-
|[Add a user to the target group.](./swagger/signalr-data-plane-rest-v1.md#add-a-user-to-the-target-group)|`PUT /api/v1/hubs/{hub}/groups/{group}/users/{user}`|
62
-
|[Remove a user from the target group.](./swagger/signalr-data-plane-rest-v1.md#remove-a-user-from-the-target-group)|`DELETE /api/v1/hubs/{hub}/groups/{group}/users/{user}`|
63
-
|[Remove a user from all groups.](./swagger/signalr-data-plane-rest-v1.md#remove-a-user-from-all-groups)|`DELETE /api/v1/hubs/{hub}/users/{user}/groups`|
50
+
| ---- | ---------- |
51
+
|[Get service health status.](./swagger/signalr-data-plane-rest-v20220601.md#head-get-service-health-status)|`HEAD /api/health`|
52
+
|[Close all of the connections in the hub.](./swagger/signalr-data-plane-rest-v20220601.md#post-close-all-of-the-connections-in-the-hub)|`POST /api/hubs/{hub}/:closeConnections`|
53
+
|[Broadcast a message to all clients connected to target hub.](./swagger/signalr-data-plane-rest-v20220601.md#post-broadcast-a-message-to-all-clients-connected-to-target-hub)|`POST /api/hubs/{hub}/:send`|
54
+
|[Check if the connection with the given connectionId exists](./swagger/signalr-data-plane-rest-v20220601.md#head-check-if-the-connection-with-the-given-connectionid-exists)|`HEAD /api/hubs/{hub}/connections/{connectionId}`|
55
+
|[Close the client connection](./swagger/signalr-data-plane-rest-v20220601.md#delete-close-the-client-connection)|`DELETE /api/hubs/{hub}/connections/{connectionId}`|
56
+
|[Send message to the specific connection.](./swagger/signalr-data-plane-rest-v20220601.md#post-send-message-to-the-specific-connection)|`POST /api/hubs/{hub}/connections/{connectionId}/:send`|
57
+
|[Check if there are any client connections inside the given group](./swagger/signalr-data-plane-rest-v20220601.md#head-check-if-there-are-any-client-connections-inside-the-given-group)|`HEAD /api/hubs/{hub}/groups/{group}`|
58
+
|[Close connections in the specific group.](./swagger/signalr-data-plane-rest-v20220601.md#post-close-connections-in-the-specific-group)|`POST /api/hubs/{hub}/groups/{group}/:closeConnections`|
59
+
|[Broadcast a message to all clients within the target group.](./swagger/signalr-data-plane-rest-v20220601.md#post-broadcast-a-message-to-all-clients-within-the-target-group)|`POST /api/hubs/{hub}/groups/{group}/:send`|
60
+
|[Add a connection to the target group.](./swagger/signalr-data-plane-rest-v20220601.md#put-add-a-connection-to-the-target-group)|`PUT /api/hubs/{hub}/groups/{group}/connections/{connectionId}`|
61
+
|[Remove a connection from the target group.](./swagger/signalr-data-plane-rest-v20220601.md#delete-remove-a-connection-from-the-target-group)|`DELETE /api/hubs/{hub}/groups/{group}/connections/{connectionId}`|
62
+
|[Remove a connection from all groups](./swagger/signalr-data-plane-rest-v20220601.md#delete-remove-a-connection-from-all-groups)|`DELETE /api/hubs/{hub}/connections/{connectionId}/groups`|
63
+
|[Check if there are any client connections connected for the given user](./swagger/signalr-data-plane-rest-v20220601.md#head-check-if-there-are-any-client-connections-connected-for-the-given-user)|`HEAD /api/hubs/{hub}/users/{user}`|
64
+
|[Close connections for the specific user.](./swagger/signalr-data-plane-rest-v20220601.md#post-close-connections-for-the-specific-user)|`POST /api/hubs/{hub}/users/{user}/:closeConnections`|
65
+
|[Broadcast a message to all clients belong to the target user.](./swagger/signalr-data-plane-rest-v20220601.md#post-broadcast-a-message-to-all-clients-belong-to-the-target-user)|`POST /api/hubs/{hub}/users/{user}/:send`|
66
+
|[Check whether a user exists in the target group.](./swagger/signalr-data-plane-rest-v20220601.md#head-check-whether-a-user-exists-in-the-target-group)|`HEAD /api/hubs/{hub}/users/{user}/groups/{group}`|
67
+
|[Add a user to the target group.](./swagger/signalr-data-plane-rest-v20220601.md#put-add-a-user-to-the-target-group)|`PUT /api/hubs/{hub}/users/{user}/groups/{group}`|
68
+
|[Remove a user from the target group.](./swagger/signalr-data-plane-rest-v20220601.md#delete-remove-a-user-from-the-target-group)|`DELETE /api/hubs/{hub}/users/{user}/groups/{group}`|
69
+
|[Remove a user from all groups.](./swagger/signalr-data-plane-rest-v20220601.md#delete-remove-a-user-from-all-groups)|`DELETE /api/hubs/{hub}/users/{user}/groups`|
64
70
65
71
## Using REST API
66
72
@@ -135,4 +141,4 @@ Currently, we have the following limitation for REST API requests:
135
141
* Header size is a maximum of 16 KB.
136
142
* Body size is a maximum of 1 MB.
137
143
138
-
If you want to send message larger than 1 MB, use the Management SDK with `persistent` mode.
144
+
If you want to send message larger than 1 MB, use the Management SDK with `persistent` mode.
0 commit comments