Skip to content

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:read:config, session:*

Authorizations

Responses

200

Successful Response

object
cadence_seconds
required

How often we expect instance health checks to occur

integer
unhealthy_health_check_percentage
required

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

number
missed_checks_before_unknown
required

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

integer

403

Forbidden

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