APIs.io Engineering Platform · Schema

WebSockets

WebSockets are open connections sustained between the client and the origin server. Inside a WebSockets connection, the client and the origin can pass data back and forth without having to reestablish sessions. This makes exchanging data within a WebSockets connection fast. WebSockets are often used for real-time applications such as live chat and gaming. For more information refer to [Can I use Cloudflare with Websockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Can-I-use-Cloudflare-with-WebSockets-).

APIs.ioEngineeringPlatform

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/zones_websockets",
  "title": "WebSockets",
  "allOf": [
    {
      "$ref": "#/components/schemas/zones_base"
    },
    {
      "properties": {
        "id": {
          "description": "ID of the zone setting.",
          "enum": [
            "websockets"
          ],
          "example": "websockets"
        },
        "value": {
          "$ref": "#/components/schemas/zones_websockets_value"
        }
      }
    }
  ],
  "description": "WebSockets are open connections sustained between the client and the origin server. Inside a WebSockets connection, the client and the origin can pass data back and forth without having to reestablish sessions. This makes exchanging data within a WebSockets connection fast. WebSockets are often used for real-time applications such as live chat and gaming. For more information refer to [Can I use Cloudflare with Websockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Can-I-use-Cloudflare-with-WebSockets-)."
}