api-information.md

API: Getting Information

API functions for requesting information from the server.

/getAddresses

Get assigned addreses from The Ark for the given Halo. You may specify a count in which the server will return count number of random addresses from the pool, this is useful for getting a random IP address to use from The Ark. If no count is specified, The Ark will return all of the addresses for the Halo.

Type: GET

Request Parameters:

Name	Type	Optional (Default)	Description
haloName	string	no	The name of the Halo
count	integer	yes (None)	The number of IP addresses to query from The Ark
unused	bool	yes (false)	Ask the server to validate that the IP is unused

Request Example:

{
    "haloName": "ServerName",
    "count": 1,
    "unused": true
}

Response Example:

{
    "haloName": "ServerName",
    "addresses": [
        "1.1.1.1"
    ]
}

/addAddresses

Add the specified number of unused addresses to the registered halo name. Returns all the addresses registered for that halo.

Type: POST

Request Parameters:

Name	Type	Optional (Default)	Description
haloName	string	no	The name of the Halo
count	integer	yes (15)	The number of IP addresses to query from The Ark

Request Example:

{
    "haloName": "ServerName",
    "count": 1,
}

Response Example:

{
    "haloName": "ServerName",
    "addresses": [
        "1.1.1.1"
    ]
}