catena-tools-core (v1)

How To Use The API Explorer

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.

Download OpenAPI description

catena-tools-core.json

catena-tools-core.yaml

Servers

Mock server

https://docs.catenatools.com/_mock/apis/catena-tools-core/

Localhost

http://localhost:5000/

Custom Domain

https://{domain}/

CatenaApiKeys

Operations

CatenaAccounts

Operations

CatenaServerManager

The server manager service portion of the integrated broker. This is what game servers interact with to handle matches.

Operations

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

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

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.

Operations

catena.catena_match_broker.CatenaMatchBroker_GetServiceHealth

Request

curl -i -X GET \
  https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/matchbroker/healthz

Responses

Success

Bodyapplication/json

healthyboolean

componentsArray of objects(Catena.Core.ComponentHealth)

Response

application/json

{
  "healthy": true,
  "components": [
    { … }
  ]
}

catena.catena_match_broker.CatenaMatchBroker_ListQueuedMatches

Request

curl -i -X GET \
  https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/matches

Responses

Success

Bodyapplication/json

matchesArray of objects(Catena.MatchBroker.Match)

Response

application/json

{
  "matches": [
    { … }
  ]
}

catena.catena_match_broker.CatenaMatchBroker_AdminListActiveMatches

Request

curl -i -X GET \
  https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/matchbroker/admin/list-active-matches

Responses

Success

Bodyapplication/json

matchesArray of objects(Catena.MatchBroker.Match)

Response

application/json

{
  "matches": [
    { … }
  ]
}

catena.catena_match_broker.CatenaMatchBroker_AdminGetActiveMatchById

Request

Path

matchIdstringrequired

curl -i -X GET \
  'https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/matchbroker/admin/match/{matchId}'

Responses

Success

Bodyapplication/json

matchobject(Catena.MatchBroker.Match)

Response

application/json

{
  "match": {
    "matchId": "string",
    "playerIds": [ … ],
    "matchProperties": "string",
    "playerProperties": { … }
  }
}

catena.catena_match_broker.CatenaMatchBroker_AdminEndActiveMatch

Request

Path

matchIdstringrequired

curl -i -X DELETE \
  'https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/matchbroker/admin/delete/{matchId}'

Responses

Success

Bodyapplication/json

matchDeletedboolean

Response

application/json

{
  "matchDeleted": true
}

catena.catena_match_broker.CatenaMatchBroker_AdminGetAvailableAllocators

Request

curl -i -X GET \
  https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/matchbroker/admin/allocators/available

Responses

Success

Bodyapplication/json

allocatorNamesArray of strings

Response

application/json

{
  "allocatorNames": [
    "string"
  ]
}

catena.catena_match_broker.CatenaMatchBroker_AdminGetConfiguredAllocators

Request

curl -i -X GET \
  https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/matchbroker/admin/allocators/configured

Responses

Success

Bodyapplication/json

allocatorsArray of objects(Services.CatenaMatchBroker.AllocatorConfiguration)

Response

application/json

{
  "allocators": [
    { … }
  ]
}

catena.catena_match_broker.CatenaMatchBroker_AdminXGetMatchBrokerConfig

Request

curl -i -X GET \
  https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/matchbroker/admin/config

Responses

Success

Bodyapplication/json

fastScheduleinteger(int32)

serverMaxLifetimeMinutesinteger(int32)

matchPickupTimeSecondsinteger(int32)

matchReadyTimeSecondsinteger(int32)

matchMaxRunTimeMinutesinteger(int32)

scheduleFrequencySecondsinteger(int32)

delayAllocationSecondsinteger(int32)

Response

application/json

{
  "fastSchedule": 0,
  "serverMaxLifetimeMinutes": 0,
  "matchPickupTimeSeconds": 0,
  "matchReadyTimeSeconds": 0,
  "matchMaxRunTimeMinutes": 0,
  "scheduleFrequencySeconds": 0,
  "delayAllocationSeconds": 0
}

catena.catena_match_broker.CatenaMatchBroker_AdminXReconfigureMatchBroker

Request

Query

fastScheduleinteger(int32)

serverMaxLifetimeMinutesinteger(int32)

matchPickupTimeSecondsinteger(int32)

matchReadyTimeSecondsinteger(int32)

matchMaxRunTimeMinutesinteger(int32)

scheduleFrequencySecondsinteger(int32)

delayAllocationSecondsinteger(int32)

curl -i -X POST \
  'https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/matchbroker/admin/reconfigure?delayAllocationSeconds=0&fastSchedule=0&matchMaxRunTimeMinutes=0&matchPickupTimeSeconds=0&matchReadyTimeSeconds=0&scheduleFrequencySeconds=0&serverMaxLifetimeMinutes=0'

Responses

Success

Bodyapplication/json

successboolean

Response

application/json

{
  "success": true
}

CatenaFriends

Operations

Events

Operations

CatenaEntitlements

Operations

CatenaLeaderboards

Operations

CatenaMatchmaking

Operations

CatenaServerCatalog

Operations

CatenaSteamDiag

Operations

catena-tools-core (v1)

How To Use The API Explorer

CatenaApiKeys

CatenaAccounts

CatenaServerManager

CatenaAuthentication

CatenaSessions

CatenaTitles

CatenaServerReleases

CatenaPlatformAuth

CatenaParties

CatenaNodeInspection

CatenaNodeControl

CatenaMatchBroker

catena.catena_match_broker.CatenaMatchBroker_GetServiceHealth

Request

Responses

Was this helpful?

catena.catena_match_broker.CatenaMatchBroker_ListQueuedMatches

Request

Responses

Was this helpful?

catena.catena_match_broker.CatenaMatchBroker_AdminListActiveMatches

Request

Responses

Was this helpful?

catena.catena_match_broker.CatenaMatchBroker_AdminGetActiveMatchById

Request

Responses

Was this helpful?

catena.catena_match_broker.CatenaMatchBroker_AdminEndActiveMatch

Request

Responses

Was this helpful?

catena.catena_match_broker.CatenaMatchBroker_AdminGetAvailableAllocators

Request

Responses

Was this helpful?

catena.catena_match_broker.CatenaMatchBroker_AdminGetConfiguredAllocators

Request

Responses

Was this helpful?

catena.catena_match_broker.CatenaMatchBroker_AdminXGetMatchBrokerConfig

Request

Responses

Was this helpful?

catena.catena_match_broker.CatenaMatchBroker_AdminXReconfigureMatchBroker

Request

Responses

Was this helpful?

CatenaFriends

Events

CatenaEntitlements

CatenaLeaderboards

CatenaMatchmaking

CatenaServerCatalog

CatenaSteamDiag