AllocationsApi
Import
Import
Constructors
Constructor
-
Parameters
-
Optional configuration: Configuration
-
basePath: string = ...
-
axios: AxiosInstance = ...
Returns AllocationsApi
-
Methods
Get Allocation
-
Parameters
-
projectId: string
ID of the project
-
environmentId: string
Environment Id of a project
-
fleetId: string
Fleet ID
-
allocationId: string
Allocation ID
-
Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<MultiplayAllocationsAllocation, any>>
-
List Allocations
-
Lists the allocations for a given fleet where the last activity took place within a given age duration.
Parameters
-
projectId: string
ID of the project
-
environmentId: string
Environment Id of a project
-
fleetId: string
Fleet ID
-
Optional age: string
-
Optional limit: number
-
Optional offset: number
-
Optional ids: string
-
Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<MultiplayAllocationsListAllocationsResponse, any>>
-
Process Allocation
-
Queues a request to allocate a server in a fleet.
Parameters
-
projectId: string
ID of the project
-
environmentId: string
Environment Id of a project
-
fleetId: string
Fleet ID
-
Optional multiplayAllocationsAllocateRequest: MultiplayAllocationsAllocateRequest
-
Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<MultiplayAllocationsAllocateResponse, any>>
-
Process Deallocation
-
Queues a request to deallocate a server in a fleet.
Parameters
-
projectId: string
ID of the project
-
environmentId: string
Environment Id of a project
-
fleetId: string
Fleet ID
-
allocationId: string
Allocation ID
-
Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<void, any>>
-
Gets the allocation for a given fleet by its UUID.
Get an allocation by its UUID
{RequiredError}
AllocationsApi