catena.catena_matchmaking.CatenaMatchmaking_GetServiceHealth

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

CatenaFriends

Operations

Events

Operations

CatenaEntitlements

Operations

CatenaLeaderboards

Operations

CatenaMatchmaking

Operations

catena.catena_matchmaking.CatenaMatchmaking_StartMatchmaking

Request

Bodyapplication/json

entityobject(Catena.Groups.Entity)

We rely on the entity type for storing data about a user in the session token, this is crucial to enable

curl -i -X POST \
  https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/matchmaking/start \
  -H 'Content-Type: application/json' \
  -d '{
    "entity": {
      "id": "string",
      "displayName": "string",
      "entityType": "ENTITY_TYPE_UNSPECIFIED",
      "entities": [
        {}
      ],
      "metadata": {
        "property1": {
          "stringPayload": "string",
          "intPayload": 0,
          "jsonPayload": "string"
        },
        "property2": {
          "stringPayload": "string",
          "intPayload": 0,
          "jsonPayload": "string"
        }
      }
    }
  }'

Responses

Success

Bodyapplication/json

ticketIdstring

The ID of the newly created matchmaking ticket.

Response

application/json

{
  "ticketId": "string"
}

catena.catena_matchmaking.CatenaMatchmaking_CancelMatchmaking

Request

Bodyapplication/json

ticketIdstring

The ID of the ticket for which we are cancelling matchmaking.

curl -i -X POST \
  https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/matchmaking/cancel \
  -H 'Content-Type: application/json' \
  -d '{
    "ticketId": "string"
  }'

Responses

Success

Bodyapplication/json

object(Services.CatenaMatchmaking.CancelMatchmakingResponse)

Response

application/json

{}

catena.catena_matchmaking.CatenaMatchmaking_GetMatchmakingStatus

Request

Path

ticketIdstringrequired

The ID of the ticket for which we are polling matchmaking status.

curl -i -X GET \
  'https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/matchmaking/{ticketId}'

Responses

Success

Bodyapplication/json

statusany(Services.CatenaMatchmaking.MatchmakingStatus)

Prefer integer values in JSON-encoded requests to avoid generic parse errors due to typos.

Enum Value	Description
0	Unspecified
1	InProgress
2	Completed
3	Cancelled
4	Failed
5	FindingServer
6	MatchmakingTimedOut

Response

application/json

{
  "status": "MATCHMAKING_STATUS_UNSPECIFIED"
}

catena.catena_matchmaking.CatenaMatchmaking_ServerStartMatchmaking

Request

Bodyapplication/json

entityobject(Catena.Groups.Entity)

We rely on the entity type for storing data about a user in the session token, this is crucial to enable

curl -i -X POST \
  https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/matchmaking/server/start \
  -H 'Content-Type: application/json' \
  -d '{
    "entity": {
      "id": "string",
      "displayName": "string",
      "entityType": "ENTITY_TYPE_UNSPECIFIED",
      "entities": [
        {}
      ],
      "metadata": {
        "property1": {
          "stringPayload": "string",
          "intPayload": 0,
          "jsonPayload": "string"
        },
        "property2": {
          "stringPayload": "string",
          "intPayload": 0,
          "jsonPayload": "string"
        }
      }
    }
  }'

Responses

Success

Bodyapplication/json

ticketIdstring

The ID of the newly created matchmaking ticket.

Response

application/json

{
  "ticketId": "string"
}

catena.catena_matchmaking.CatenaMatchmaking_ServerCancelMatchmaking

Request

Bodyapplication/json

ticketIdstring

The ID of the ticket for which we are cancelling matchmaking.

curl -i -X POST \
  https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/matchmaking/server/cancel \
  -H 'Content-Type: application/json' \
  -d '{
    "ticketId": "string"
  }'

Responses

Success

Bodyapplication/json

object(Services.CatenaMatchmaking.CancelMatchmakingResponse)

Response

application/json

{}

catena.catena_matchmaking.CatenaMatchmaking_ServerGetMatchmakingStatus

Request

Path

ticketIdstringrequired

The ID of the ticket for which we are polling matchmaking status.

curl -i -X GET \
  'https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/matchmaking/server/{ticketId}'

Responses

Success

Bodyapplication/json

statusany(Services.CatenaMatchmaking.MatchmakingStatus)

Prefer integer values in JSON-encoded requests to avoid generic parse errors due to typos.

Enum Value	Description
0	Unspecified
1	InProgress
2	Completed
3	Cancelled
4	Failed
5	FindingServer
6	MatchmakingTimedOut

Response

application/json

{
  "status": "MATCHMAKING_STATUS_UNSPECIFIED"
}

catena.catena_matchmaking.CatenaMatchmaking_ListTickets

Request

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

Responses

Success

Bodyapplication/json

ticketsArray of objects(Services.CatenaMatchmaking.MatchmakingTicketWithState)

Response

application/json

{
  "tickets": [
    { … }
  ]
}

catena.catena_matchmaking.CatenaMatchmaking_GetServiceHealth

Request

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

Responses

Success

Bodyapplication/json

healthyboolean

componentsArray of objects(Catena.Core.ComponentHealth)

Response

application/json

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

catena.catena_matchmaking.CatenaMatchmaking_AdminXGetMatchmakerConfig

Request

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

Responses

Success

Bodyapplication/json

catenaMatchmakerConfigobject(Services.CatenaMatchmaking.CatenaMatchmakerConfig)

flexMatchConfigobject(Services.CatenaMatchmaking.FlexMatchConfig)

customMatchmakerConfigstring

Response

application/json

{
  "catenaMatchmakerConfig": {
    "matchmakingQueues": { … },
    "statusExpirationMinutes": 0,
    "customHooks": "string"
  },
  "flexMatchConfig": {
    "sqsQueueUrl": "string",
    "gameliftConfig": { … }
  },
  "customMatchmakerConfig": "string"
}

catena.catena_matchmaking.CatenaMatchmaking_AdminXReconfigureMatchmaker

Request

Bodyapplication/json

configstring

curl -i -X POST \
  https://docs.catenatools.com/_mock/apis/catena-tools-core/api/v1/matchmaking/admin/config \
  -H 'Content-Type: application/json' \
  -d '{
    "config": "string"
  }'

Responses

Success

Bodyapplication/json

successboolean

Response

application/json

{
  "success": true
}

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

CatenaFriends

Events

CatenaEntitlements

CatenaLeaderboards

CatenaMatchmaking

catena.catena_matchmaking.CatenaMatchmaking_StartMatchmaking

RequestExpand all

Responses

Was this helpful?

catena.catena_matchmaking.CatenaMatchmaking_CancelMatchmaking

Request

Responses

Was this helpful?

catena.catena_matchmaking.CatenaMatchmaking_GetMatchmakingStatus

Request

Responses

Was this helpful?

catena.catena_matchmaking.CatenaMatchmaking_ServerStartMatchmaking

RequestExpand all

Responses

Was this helpful?

catena.catena_matchmaking.CatenaMatchmaking_ServerCancelMatchmaking

Request

Responses

Was this helpful?

catena.catena_matchmaking.CatenaMatchmaking_ServerGetMatchmakingStatus

Request

Responses

Was this helpful?

catena.catena_matchmaking.CatenaMatchmaking_ListTickets

Request

Responses

Was this helpful?

catena.catena_matchmaking.CatenaMatchmaking_GetServiceHealth

Request

Responses

Was this helpful?

catena.catena_matchmaking.CatenaMatchmaking_AdminXGetMatchmakerConfig

Request

Responses

Was this helpful?

catena.catena_matchmaking.CatenaMatchmaking_AdminXReconfigureMatchmaker

Request

Responses

Was this helpful?

CatenaServerCatalog

CatenaSteamDiag

Request

Request