On the right hand side of this page, you will see a list of "Servers".
Mock server: This server will return mock responses to all requests. It is best used when evaluating the shape of the Catena API.
Localhost: This server will point at a locally running version of Catena. It is best used when you want to make real requests or to validate that Catena is properly running on your machine.
Custom Domain: This server will point at any domain you specify with the domain variable. It is best used when you have a version of Catena deployed to a live environment and you want to make real requests against it.
To configure which server is shown in example requests:
Select the "Try it" button on any API operation within the API explorer
Select your environment
If you want to point the API explorer to an instance of Catena you have deployed, select "Custom Domain" and configure the domain environment variable.
You're all set! This setting will be cached across all API operations exposed in these docs.
The server manager service portion of the integrated broker. This is what game servers interact with to handle matches.
Operations
CatenaAuthentication
CatenaAuthentication
Operations
CatenaSessions
A service that can be used to probe the session store directly for development or diagnostics. Not intended for regular production use!
Operations
CatenaTitles
CatenaTitles
Operations
CatenaServerReleases
CatenaServerManagement
Operations
CatenaPlatformAuth
A service for managing Catena-authoritative functionality with regards to validation and authentication. Used by validators in the Authentication service that log the user into the Catena platform.
Operations
CatenaParties
CatenaParties
Operations
CatenaNodeInspection
A service that can be used inspect the Catena node.
Operations
CatenaNodeControl
A service that can be used control the Catena node.
Operations
CatenaMatchBroker
An integrated match broker service which sits between the matchmaker, clients, and game servers/hosting to coordinate capacity and notify clients when servers are ready to accept connections. This implementation integrates the broker and capacity/server manager roles.