Skip to content
Olivares AI docs

Event-bus subscriber, saturation, loss, and optional bridge snapshot

GET
/v1/console/bus
 
curl --request GET \
  --url https://example.com/v1/console/bus \
  --header 'Authorization: Bearer <token>'

Returns the privileged event-bus snapshot: subscribers, saturation, loss counters and the bridge state when one is configured.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
bridge
object
connected
required
boolean
decode_errors
required
integer format: int64
dropped
required
integer format: int64
gate_skipped
required
integer format: int64
invalid_subject
required
integer format: int64
pending_bytes
required
integer
pending_msgs
required
integer
publish_errors
required
integer format: int64
dropped
required
integer format: int64
dropped_notify
required
integer format: int64
dropped_telemetry
required
integer format: int64
enqueued
required
integer format: int64
handled
required
integer format: int64
handler_errors
required
integer format: int64
publish_blocked
required
integer format: int64
subscribers
required
Array<object>
object
capacity
required
integer
class
required
string
Allowed values: enforcement state telemetry notify unknown
depth
required
integer
name
required
string
Example 
{
  "subscribers": [
    {
      "class": "enforcement"
    }
  ]
}

400

Section titled “400 ”

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

401

Section titled “401 ”

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Section titled “403 ”

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

404

Section titled “404 ”

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

409

Section titled “409 ”

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

429

Section titled “429 ”

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}