List venue key specs
Lists the key spec of every venue the platform takes a key for — its legs as a JSON Schema with form hints, the roles its connectors fill, what to grant — each marked enabled when this deployment serves it, beside the egress addresses to allowlist. Served to every admitted member as one document, never a page. The venues as reference data are the data API’s GET /venues, under the same ids.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Headers
Your own id for the request: 8 to 128 of [A-Za-z0-9._-]. It becomes the request’s id and is echoed on the response. A value off that grammar is replaced with a fresh id, never refused.
Query parameters
A position you hold — an X-Immix-Global-Sequence you read, or a 202’s commandGlobalSequence: this member answers only once it has folded the platform’s stream through it, waiting up to its deadline, then 503 PROJECTION_BEHIND with Retry-After. Within that stream a read is never older than what you have seen; drop your positions after an announced stream cut. A retry stating its 202’s position attaches to or replays that operation while the journal holds its key, never publishing twice. Stated once: one to nineteen digits, at most 9223372036854775807; else 400 MALFORMED_REQUEST.
Response
The deployment’s venue key specs: its egress addresses, and every venue the platform takes a key for, with the ones it serves marked enabled. The position it was served at rides the two position headers, as on every read; the document does not move with it.
The addresses this deployment’s connectors reach venues from — IP addresses, or CIDR blocks — the ones to allowlist on a key at the venue; the key check judges a pasted key’s allowlist against the same list. Empty while the deployment has no fixed egress address: nothing can be allowlisted yet, and the check reads UNKNOWN.
Every venue the platform takes a key for, in the platform’s order — the enabled ones and the rest alike, so a client can name a venue it cannot yet offer.