Skip to content
RallyHere Docs

Instance Health Check

POST
/session/v1/session/{session_id}/instance/health

Endpoint to post health status of an instance

Required Permissions:

  • For any player (including themselves) any of: session:*, session:instance:health

session:instance:health

Authorizations

Parameters

Path Parameters

session_id
required
string
>= 1 characters <= 128 characters

Request Body required

A request body for an instances health check

object
instance_health
required

The health status of the instance

string
Allowed values: healthy unhealthy degraded unknown
instance_id
required

The instance ID for the instance whose health you are reporting

string
>= 1 characters <= 128 characters

Responses

200

Successful Response

Response body for an instance health check

object
updated_instance_health
required

The new health status of the instance. It may not match the status sent up if too few health checks are being recieved

string
Allowed values: healthy unhealthy degraded unknown

403

Forbidden

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string