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

Request

Path Parameters

session_id Session Idrequired

Possible values: non-empty and <= 128 characters

application/json

Body

required

instance_health InstanceHealthStatus (string)required

Possible values: [healthy, unhealthy, degraded, unknown]

An enumeration.

instance_id Instance Id (string)required

Possible values: non-empty and <= 128 characters

The instance ID for the instance whose health you are reporting

Responses

200

Successful Response

application/json

Schema

Schema

updated_instance_health InstanceHealthStatus (string)required

Possible values: [healthy, unhealthy, degraded, unknown]

An enumeration.

Example (from schema)

{
  "updated_instance_health": "healthy"
}

403

Forbidden

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

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

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...