api-halos.md

API: Halos

API functions for screating and deleting Halos. There are two types of Halos in The Ark, default and redirect.

default halos: Default Halos request reservation of Ark IP addresses, however, The Ark does nothing else with these IPs.

redirect halos: For redirect Halos, The Ark will reserve IP addresses, claim the IP addresses, and setup forwarders for the specified ports of the IP.

/registerHalo

Register a new default Halo with The Ark, The Ark will then return a list of the IP addresses that are assigned to it.

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 reserve (max 50)

Request Example:

{
    "haloName": "HaloName",
    "count": 20
}

Response Example:

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

Response Example:

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

/getHalos

Get all the Halos from The Ark/

Type: GET

Request Parameters:

None

Request Example:

{}

Response Example:

{
    "halos": [
        "halo1",
        "halo2",
        ...
    ]
}

/deleteHalo

Delete a Halo from The Ark and cleanup all the forwards

Type: POST

Request Parameters:

Name	Type	Optional (Default)	Description
haloName	string	no	The name of the Halo

Request Example:

{
    "haloName": "ServerName"
}

Response Example:

{
    "haloName": "ServerName"
}