ZeroKey

Connection Management

Initiate a new SignalR connection to the event hub

SecurityOAuth2 or ApiKey
Request
Request Body schema: application/json

Initiate a new SignalR connection to the event hub

Array of objects (FilterChain)

All filters in this array are compared with a logical OR operation, while all filters listed as children objects within each filter are compared with a logical 'AND'.

Array
FilterTemplate
string
Default: "none"

Several built-in filter chains are available for common activities.

Enum: "dashboard" "hardware_events" "position_events" "api_calls" "alert_events" "none"
Selector
string

Indicates the property within the Event upon which to filter its value.

Type
string

Specify whether the value should be matched against the Match property of this object as a regular expression or a string comparison.

Enum: "regex" "string"
Match
string

The pattern to match against the value specified by the Selection property within each Event.

Invert
boolean
Default: false

Logically invert the match result.

Children
object (FilterChain) Recursive
Responses
200

Response success

Response Schema: application/json
EndpointURI
string

Endpoint URI for the SignalR EventHub connection.

EndpointID
string

The unique ID of the connection, this must be passed in the Authorization header as a bearer token when establishing the SignalR connection.

object
HubName
string

Friendly name of the hub.

HubTypeID
string

Globally unique identifier representing the type of hub.

HubInstanceID
string

Globally unique identifier representing the particular hub instance.

400

Malformed request.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden. Current token does not have the necessary authority for the operation.

422

Invalid data was sent.

post/events/connections
Request samples
application/json
{
  • "Filters": [
    ]
}
Response samples
application/json
{
  • "EndpointURI": "https://10.20.30.40:35000/hubs/EventMessage",
  • "EndpointID": "3F2504E0-4F89-11D3-9A0C-0305E82C3301",
  • "HubInfo": {
    }
}

Update the message filter associated with the specified EndpointID

SecurityOAuth2 or ApiKey
Request
path Parameters
EndpointID
required
string

ID of the endpoint

Request Body schema: application/json

Update connection properties of a SignalR connection

Array of objects (FilterChain)

All filters in this array are compared with a logical OR operation, while all filters listed as children objects within each filter are compared with a logical 'AND'.

Array
FilterTemplate
string
Default: "none"

Several built-in filter chains are available for common activities.

Enum: "dashboard" "hardware_events" "position_events" "api_calls" "alert_events" "none"
Selector
string

Indicates the property within the Event upon which to filter its value.

Type
string

Specify whether the value should be matched against the Match property of this object as a regular expression or a string comparison.

Enum: "regex" "string"
Match
string

The pattern to match against the value specified by the Selection property within each Event.

Invert
boolean
Default: false

Logically invert the match result.

Children
object (FilterChain) Recursive
Responses
200

Response success

Response Schema: application/json
EndpointURI
string

Endpoint URI for the SignalR EventHub connection.

EndpointID
string

The unique ID of the connection, this must be passed in the Authorization header as a bearer token when establishing the SignalR connection.

object
HubName
string

Friendly name of the hub.

HubTypeID
string

Globally unique identifier representing the type of hub.

HubInstanceID
string

Globally unique identifier representing the particular hub instance.

400

Malformed request.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden. Current token does not have the necessary authority for the operation.

422

Invalid data was sent.

put/events/connections/{EndpointID}
Request samples
application/json
{
  • "Filters": [
    ]
}
Response samples
application/json
{
  • "EndpointURI": "https://10.20.30.40:35000/hubs/EventMessage",
  • "EndpointID": "3F2504E0-4F89-11D3-9A0C-0305E82C3301",
  • "HubInfo": {
    }
}
➔ Next to Event Debugging