Interface IMultiplayServersAdminApi

Represents a collection of functions to interact with the API endpoints

Inherited Members

IApiAccessor.Configuration

IApiAccessor.GetBasePath()

Namespace: Unity.Services.Apis.Admin.Multiplay

Assembly: Unity.Services.Apis.dll

Syntax

public interface IMultiplayServersAdminApi : IApiAccessor

Methods

GetServer(string, string, long, CancellationToken)

View a server

Declaration

ApiOperation<MultiplayServersServer1> GetServer(string projectId, string environmentId, long serverId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	The project's Project ID
string	environmentId	The Environment ID of a project
long	serverId	A Multiplay server ID
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<MultiplayServersServer1>	The operation

GetServerActions(string, string, long, DateTime?, CancellationToken)

List action logs

Declaration

ApiOperation<List<MultiplayServersActionLog>> GetServerActions(string projectId, string environmentId, long serverId, DateTime? date = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	The project's Project ID
string	environmentId	The Environment ID of a project
long	serverId	A Multiplay server ID
DateTime?	date	Date (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<List<MultiplayServersActionLog>>	The operation

GetServerLogsLink(string, string, long, string, CancellationToken)

Get Log File Link

Declaration

ApiOperation<MultiplayServersLogFileLink> GetServerLogsLink(string projectId, string environmentId, long serverId, string file, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	The project's Project ID
string	environmentId	The Environment ID of a project
long	serverId	A Multiplay server ID
string	file	Log file name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<MultiplayServersLogFileLink>	The operation

GetServerLogsPreview(string, string, long, string, CancellationToken)

Get Preview of Log File

Declaration

ApiOperation<string> GetServerLogsPreview(string projectId, string environmentId, long serverId, string file, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	The project's Project ID
string	environmentId	The Environment ID of a project
long	serverId	A Multiplay server ID
string	file	Log file name
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<string>	The operation

ListServerLocations(string, string, CancellationToken)

List server locations

Declaration

ApiOperation<List<MultiplayServersLocation>> ListServerLocations(string projectId, string environmentId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	The project's Project ID
string	environmentId	The Environment ID of a project
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<List<MultiplayServersLocation>>	The operation

ListServerLogs(string, string, long, CancellationToken)

List log files

Declaration

ApiOperation<List<MultiplayServersLogFile>> ListServerLogs(string projectId, string environmentId, long serverId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	The project's Project ID
string	environmentId	The Environment ID of a project
long	serverId	A Multiplay server ID
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<List<MultiplayServersLogFile>>	The operation

ListServers(string, string, string, string, string, string, string, string, string, string, string, string, string, string, CancellationToken)

List servers

Declaration

ApiOperation<List<MultiplayServersServer1>> ListServers(string projectId, string environmentId, string limit = null, string lastId = null, string lastVal = null, string sortBy = null, string sortDir = null, string fleetId = null, string machineId = null, string locationId = null, string buildConfigurationId = null, string hardwareType = null, string partial = null, string status = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	The project's Project ID
string	environmentId	The Environment ID of a project
string	limit	Results limit (optional)
string	lastId	Last ID (optional)
string	lastVal	Last value (optional)
string	sortBy	Sort column (optional)
string	sortDir	Sort direction (optional, default to ASC)
string	fleetId	Fleet ID (optional)
string	machineId	Machine ID (optional)
string	locationId	Location ID (optional)
string	buildConfigurationId	Build Configuration ID (optional)
string	hardwareType	HardwareType (optional)
string	partial	Partial Filter (optional)
string	status	Status (optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<List<MultiplayServersServer1>>	The operation

TriggerServerAction(string, string, long, MultiplayServersActionsRequest, CancellationToken)

Trigger action

Declaration

ApiOperation<MultiplayServersActionsResponse> TriggerServerAction(string projectId, string environmentId, long serverId, MultiplayServersActionsRequest multiplayServersActionsRequest = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	projectId	The project's Project ID
string	environmentId	The Environment ID of a project
long	serverId	A Multiplay server ID
MultiplayServersActionsRequest	multiplayServersActionsRequest	(optional)
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
ApiOperation<MultiplayServersActionsResponse>	The operation