Get a list of service statuses of an existing player

  • Published on Jan 24, 2025
  • 1 minute(s) reading time
Prev Next
Get
/v{version}/Players/{playerId}/Services
Security
API Key
Header parameter nameX-ApiKey

Api Key

API Key
Header parameter nameX-Session-Id

Session Id

Path parameters
playerId
integer (int32) Required

Unique ID of the player

version
stringRequired

The requested API version

Default"1.18"
Responses
200

OK

Array of object
object

Player's service status

LastUpdate
string (date-time)

Last update time of the service in UTC

Name
string

Name of the service

Status
string

Type of the service status

Valid values[ "Unknown", "Stopped", "StartPending", "StopPending", "Running", "ContinuePending", "PausePending", "Paused" ]
Version
string

Version of the service

400

Bad request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
403

Player access denied

404

Player not found.

500

Unexpected error

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties