Machine report

Warning: The API documentation here is for Managed Game Server Hosting (Clanforge). If you’re using Game Server Hosting (Multiplay), refer to the Game Server API documentation.

Get a list of machines under the provided account service ID (ASID).

https://api.multiplay.co.uk/cfp/v4/machines/views/report

METHOD

GET

Request parameters

VARIABLEDESCRIPTIONOPTIONAL
accountServiceIdThe <accountserviceid> parameter accepts an account service ID (ASID) associated with the specified resource. The credentials in the request header must have access to the ASID to perform the request.No
limitThe <limit> parameter accepts an integer representing the number of results to return. By default, the number of results returned is 100. You can specify a value up to 20,000.Yes

Response fields

This endpoint returns an array of the following objects.

FieldTypeDescriptionOptional
ipstringIP address of the machineNo
locationnamestringName of the location of this machineNo
machinecontractlengthintInitial contract length in monthsNo
machineenddatestringEstimated original contract end dateNo
machineidintegerID of the machineNo
machinestartdatestringEstimated original contract start dateNo

Example request

curl --location --request GET "https://api.multiplay.co.uk/cfp/v4/machines/views/report?accountServiceId=<accountserviceid>&limit=<limit>" \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'

Example response

[
    {
        "ip": <ip>,
        "locationName": <locationname>,
        "machineContractLength": <machinecontractlength>,
        "machineEndDate": <machineenddate>,
        "machineId": <machineid>,
        "machineStartDate": <machinestartdate>
    },
    ...
]