docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Namespace Unity.Services.Apis.Admin.Multiplay

    Classes

    BuildConfiguration

    A build configuration associated with the fleet.

    ConfigurationPair

    A key/value pair to configure a build configuration.

    ConfigurationPair1

    A key/value pair to configure a build configuration.

    CreateBuild424Response

    CreateBuild424Response

    CreateFleet409Response

    CreateFleet409Response

    CreateOrUpdateBuildFile503Response

    CreateOrUpdateBuildFile503Response

    FleetRegion

    A region associated with the fleet.

    MultiplayAddedRegion

    Newly added fleet region

    MultiplayAllocationsAdminApi

    Represents a collection of functions to interact with the API endpoints

    MultiplayAllocationsListTestAllocationsResponse

    Response to a request to list test allocations, including pagination.

    MultiplayAllocationsPagination

    Pagination data for a list of test allocations.

    MultiplayAllocationsTestAllocateRequest

    Multipart-form request to process a test allocation. The form size is capped at 32Mb to prevent overloading.

    MultiplayAllocationsTestAllocateResponse

    Response to a request to process a test allocation.

    MultiplayAllocationsTestAllocation

    A single test allocation, possibly within an allocations list.

    MultiplayBuildConfiguration

    A build configuration for configuring game builds to run on servers.

    MultiplayBuildConfigurationConfigPair

    A single configuration key/value pair.

    MultiplayBuildConfigurationCreateRequest

    Request to create a build configuration with the provided configuration.

    MultiplayBuildConfigurationListItem

    A build configuration for configuring game builds to run on servers.

    MultiplayBuildConfigurationUpdateRequest

    Request to update a build configuration with the provided configuration.

    MultiplayBuildConfigurationsAdminApi

    Represents a collection of functions to interact with the API endpoints

    MultiplayBuildsAdminApi

    Represents a collection of functions to interact with the API endpoints

    MultiplayBuildsBuild

    A single build response.

    MultiplayBuildsBuildCreateReq

    Request to create a build.

    MultiplayBuildsBuildFileCreateOrUpdateReq

    Request to create or update a build file.

    MultiplayBuildsBuildFilesList

    List of build files for an given build ID.

    MultiplayBuildsBuildFilesListItem

    A single build file within the Build Files List response

    MultiplayBuildsBuildInstall

    A single build install within the Build Installs List response

    MultiplayBuildsBuildInstallFailure

    A single build install failure

    MultiplayBuildsBuildInstallRegions

    A single build install region within a build installs list response.

    MultiplayBuildsBuildUpdateReq

    Request to update a build.

    MultiplayBuildsBuildVersionUpdateReq

    Request to update a build by creating a new build version.

    MultiplayBuildsBuilds

    A single build within a build list response.

    MultiplayBuildsCcdCreate

    The CCD block indicating that the created build is a direct file upload build. Now deprecated, please use buildType FILE_UPLOAD instead.

    MultiplayBuildsCcdDetails

    CCD based build details.

    MultiplayBuildsCcdUpdate

    CCD based new build version details.

    MultiplayBuildsContainer

    Container image based build details.

    MultiplayBuildsS3CreateUpdate

    Amazon S3 bucket upload based build create or update request.

    MultiplayBuildsS3Details

    Amazon S3 bucket upload based build details.

    MultiplayConflictError

    A conflict error providing a list of conflicts blocking an operation.

    MultiplayConflictItem

    A conflict blocking an operation.

    MultiplayFleet

    A fleet of servers to host games.

    MultiplayFleetAddRegionRequest

    Request to add a region to a fleet with the provided configuration.

    MultiplayFleetBuildConfiguration

    A build configuration associated with the fleet.

    MultiplayFleetBuildConfigurationSwitchRequest

    The request body to trigger a fleet active build configuration switch.

    MultiplayFleetBuildConfigurationSwitchStatus

    The status of the active build configuration switch for a reservations-based fleet.

    MultiplayFleetCreateRequest

    Request to create a fleet with the provided configuration.

    MultiplayFleetCreateRequestRegion

    A region association to create.

    MultiplayFleetGenericServers

    Server breakdown for the fleet.

    MultiplayFleetListItem

    A fleet for managing game servers and machines.

    MultiplayFleetRegion

    An association between the fleet and a region.

    MultiplayFleetRegionTemplateListItem

    Single fleet-regions for the template fleet.

    MultiplayFleetServers

    Server data for the fleet.

    MultiplayFleetUpdateRegionRequest

    Request to update the settings of a fleet region with the provided configuration.

    MultiplayFleetUpdateRequest

    Request to update a fleet with the provided configuration.

    MultiplayFleetUsageSetting

    A usage setting associated with the fleet.

    MultiplayFleetsAdminApi

    Represents a collection of functions to interact with the API endpoints

    MultiplayMachinesAdminApi

    Represents a collection of functions to interact with the API endpoints

    MultiplayMachinesMachine

    A single machine.

    MultiplayMachinesServersStates

    Servers states show number of machine servers in each state

    MultiplayMachinesSpec

    A machine specification.

    MultiplayProviderCreateRequestV1

    Request to create new provider.

    MultiplayProviderProviderListV1

    The response containing a list of providers for a given project.

    MultiplayProviderProviderV1

    The details of a single provider.

    MultiplayProvidersAdminApi

    Represents a collection of functions to interact with the API endpoints

    MultiplayRegistryAdminApi

    Represents a collection of functions to interact with the API endpoints

    MultiplayRegistryTagsList

    list of tags for the given build.

    MultiplayServersActionLog

    A server action log.

    MultiplayServersActionsRequest

    A request to trigger a action.

    MultiplayServersActionsResponse

    Response from triggering a action.

    MultiplayServersAdminApi

    Represents a collection of functions to interact with the API endpoints

    MultiplayServersLocation

    Location of a server.

    MultiplayServersLogFile

    A server log file.

    MultiplayServersLogFileLink

    A link to download a log file.

    MultiplayServersMachineSpec

    A machine specification.

    MultiplayServersServer1

    A single server.

    MultiplayUpdatedRegion

    Updated fleet region

    ProcessTestAllocation400Response

    ProcessTestAllocation400Response

    ProcessTestAllocation401Response

    ProcessTestAllocation401Response

    ProcessTestAllocation403Response

    ProcessTestAllocation403Response

    ProcessTestAllocation404Response

    ProcessTestAllocation404Response

    ProcessTestAllocation429Response

    ProcessTestAllocation429Response

    ProcessTestAllocation500Response

    ProcessTestAllocation500Response

    ServerStatus

    Server counts by server status.

    Interfaces

    IMultiplayAllocationsAdminApi

    Represents a collection of functions to interact with the API endpoints

    IMultiplayBuildConfigurationsAdminApi

    Represents a collection of functions to interact with the API endpoints

    IMultiplayBuildsAdminApi

    Represents a collection of functions to interact with the API endpoints

    IMultiplayFleetsAdminApi

    Represents a collection of functions to interact with the API endpoints

    IMultiplayMachinesAdminApi

    Represents a collection of functions to interact with the API endpoints

    IMultiplayProvidersAdminApi

    Represents a collection of functions to interact with the API endpoints

    IMultiplayRegistryAdminApi

    Represents a collection of functions to interact with the API endpoints

    IMultiplayServersAdminApi

    Represents a collection of functions to interact with the API endpoints

    Enums

    MultiplayAllocationType

    The type of allocation method used by the fleet: * ALLOCATION - The fleet accepts requests following the allocations-based model. * RESERVATION - The fleet accepts requests following the reservations-based model. (Closed Beta)

    MultiplayBuildType

    The upload type of the build: * FILE_UPLOAD - The build is created using directly uploaded game files, backed by CCD as the storage driver. * CONTAINER - The build is created using a container image containing game files. * S3 - The build is created using an external Amazon S3 Bucket containing game files.

    MultiplayBuildsOsFamily

    The operating system family of the build: * ANY - Deprecated, for legacy builds. * LINUX - The build is for Linux.

    MultiplayBuildsOsFamilyCreate

    The operating system family to use for the build: * LINUX - The build is for Linux.

    MultiplayBuildsSyncStatus

    CCD Bucket Synchronisation Status: * PENDING: Source bucket synchronisation is pending * SYNCING: Source bucket synchronisation is in progress * SYNCED: The source bucket has been synchronised * FAILED: Source bucket synchronisation has failed

    MultiplayConflictType

    The type of conflict: * DEPENDENT - The conflicting resource is dependent on the subject resource. * DEPENDENCY - The conflicting resource is a dependency of the subject resource. * ACTIVE - The conflict is due to the subject resource being in an active state. * INACTIVE - The conflict is due to the subject resource being in an inactive state.

    MultiplayCreateAllocationType

    The type of allocation method used by the fleet: * ALLOCATION - The fleet accepts requests following the allocations-based model. * RESERVATION - The fleet accepts requests following the reservations-based model. (Closed Beta)

    MultiplayFleet.OsFamilyEnum

    The os family that the build is based on.

    MultiplayFleetCreateRequest.OsFamilyEnum

    The os family that the build is based on.

    MultiplayFleetStatus

    Current status of the fleet.

    MultiplayFleetSwitchState

    The state of the switch of the active build configuration for a fleet: * PENDING - The build configuration switch has been queue and is waiting to start. * PROCESSING - The build configuration switch has been started and is in progress. * COMPLETE - The build configuration switch is completed. * NOT_REQUESTED - No build configuration switch has been requested for this fleet.

    MultiplayFleetUsageSetting.HardwareTypeEnum

    The hardware type of a machine.

    MultiplayMachinesHardwareType

    Hardware type of the machine.

    MultiplayMachinesMachine.OsFamilyEnum

    Defines OsFamily

    MultiplayMachinesStatus

    Status of the machine.

    MultiplayProviderProviderStatusV1

    The status of the provider.

    MultiplayServersAction

    Action to trigger for the server.

    MultiplayServersHardwareType

    Hardware type of the server.

    MultiplayServersServerStatus

    Status of the server.

    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)