Instance Health Config

GET /session/v1/instance/health/config

Get config about expected poll rates for instance health, and when instances will go missing/unhealthy

Required Permissions:

For any player (including themselves) any of: session:*, session:read:config

Responses

Successful Response

Schema

cadence_seconds Cadence Seconds (integer)required

How often we expect instance health checks to occur

unhealthy_health_check_percentage Unhealthy Health Check Percentage (number)required

What percentage of health checks must be missing before an instance's status becomes unhealthy

missed_checks_before_unknown Missed Checks Before Unknown (integer)required

How many health checks we must miss in a row before an instance's status becomes unknown

{
  "cadence_seconds": 0,
  "unhealthy_health_check_percentage": 0,
  "missed_checks_before_unknown": 0
}

Forbidden

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required

desc Desc (string)required

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}