Cotal
DocsAPI Reference

Dashboard HTTP API

The Dashboard HTTP API provides mesh observations, message history, and live events for the web dashboard.

Connection

The default address is http://127.0.0.1:7799. The running dashboard can use a different host or port. The dashboard guide describes launch and access.

Authentication

The owner-private launch URL exchanges its single-use k token for a cotal_web_session cookie. The session stays on the same host. Requests from another browser origin are refused. The readiness nonce grants access only to /api/meta.

Available operations

The native web service is read-only. Channel deletion returns HTTP 403. Legacy dashboard instances can support deletion. The /api/meta response reports this capability as channelDeleteSupported.

Operation pages in the sidebar describe parameters, response schemas, and live event payloads.

Reference downloads

OpenAPI specification · Complete Markdown reference

Schema reference links

Schemas

Expand request and response schemas on an operation page. The complete definitions are also available in the OpenAPI download and Markdown reference.

Message

Read direct-message history · Read channel history

RosterEntry

List the roster · Watch live dashboard events

Membership

Read channel membership · Watch live dashboard events

Channel

List chat channels

ActivityEntry

OpenAPI definition · Complete Markdown reference

ActivityPage

Read recent activity

Error

Delete a legacy dashboard channel

AuthenticationError

OpenAPI definition · Complete Markdown reference

OriginError

OpenAPI definition · Complete Markdown reference

MembershipError

OpenAPI definition · Complete Markdown reference

PresenceView

Watch live dashboard events

LiveMessage

Watch live dashboard events

DashboardMeta

Read dashboard metadata

ChannelDeleted

Delete a legacy dashboard channel