Kehittäjät/REST-rajapinta

REST-rajapinnan viite

Perus-URL: https://panel.hostwolf.net/api/client

Tunnistautuminen: lähetä Authorization: Bearer ptlc_... ja Accept: application/json. Luo avaimet kohdassa Tili → API-avaimet. Avaimen voi rajata tiettyihin osoitteisiin; katso sallittujen IP-osoitteiden lista.

Rajapinta on yhteensopiva Pterodactylin asiakasrajapinnan kanssa, joten olemassa olevat Pterodactyl-työkalut ja -kirjastot toimivat sen kanssa. Hostwolfin omat päätepisteet on merkitty HW.

Käytännöt#

Vastaukset. Yksittäiset oliot tulevat käärittyinä muodossa {"object": "server", "attributes": {...}}. Listat tulevat muodossa {"object": "list", "data": [...], "meta": {...}}. Hostwolfin omat rajapinnat palauttavat tavallista JSONia.

Sivutus. Sivutetut listat hyväksyvät ?page= ja ?per_page= (enintään 100 palvelimille, 50 varmuuskopioille) ja palauttavat meta.pagination-kentän, jossa on total, count, per_page, current_page ja total_pages.

Virheet.

{
  "errors": [
    { "code": "ValidationException", "status": "422", "detail": "The name field is required." }
  ]
}

Jotkin Hostwolfin päätepisteet palauttavat sen sijaan {"error": "...", "code": "..."}, esim. 409 downgrade_requires_reset, kun peli vaihdetaan vanhempaan versioon, tai 422 unknown_version versiolle, jota ei ole olemassa.

Tilakoodit:

• 204: onnistui, ei sisältöä.
• 401: avain puuttuu, on väärä tai peruttu.
• 403: puuttuva oikeus (alikäyttäjät), jäädytetty palvelin tai pyyntö osoitteesta, joka ei ole avaimen sallittujen IP-osoitteiden listalla.
• 404: ei löytynyt.
• 409: palvelin on varattu (asennus, palautus tai siirto käynnissä).
• 422: validointivirhe.
• 429: pyyntöraja täynnä. Retry-After kertoo odotusajan sekunteina; katso rajat.
• 502: palvelimen nodeen ei saada yhteyttä, tai palvelimen täytyy olla käynnissä.

Palvelinten tunnukset. {server} on palvelimen identifier, sen paneelin URL-osoitteen 8 merkkiä. Myös koko UUID toimii.

Tili#

Palvelimet#

Tiedostot#

Kaikki polut ovat suhteessa palvelimen juurihakemistoon. root on hakemisto, jossa files-merkinnät ovat.

Varmuuskopiot#

Peli, pelaajat ja diagnostiikka HW#

Modit, lisäosat ja modipaketit HW#

Ajastukset#

Verkko, tietokannat ja aliakäyttäjät#

Tietokannat toimivat palvelimen omalla koneella. Palvelimen ensimmäinen POST /databases käynnistää tietokantapalvelun, mikä kestää noin 40 sekuntia, ja vastaa tietokannan sijaan 202 Accepted sekä palvelun tilan ({"object": "hostwolf_database_service", "attributes": {"status": "provisioning", …}}). Kysele GET /databases, kunnes tietokanta näkyy, tai käytä databases.create(id, name, { wait: true }). Seuraavat tietokannat luodaan heti (200). Pelipalvelimet yhdistävät osoitteeseen host.address (172.18.0.1:3306); remote_address toimii vain sallimistasi remote_ips-osoitteista tai mistä tahansa, kun remote_anywhere on päällä. Katso tietokantaopas.

Palvelimen lisät HW#

Paketit ja tilaukset HW#

Vain luku. Tilaaminen, peruminen ja maksaminen tapahtuvat paneelissa.

Konsoli#

Reaaliaikainen konsoli on websocket nodessa, jossa palvelimesi toimii.

1. GET /servers/{server}/websocket palauttaa {"data": {"token": "...", "socket": "wss://..."}}.
2. Yhdistä socket-osoitteeseen otsakkeella Origin: https://panel.hostwolf.net.
3. Lähetä {"event": "auth", "args": ["<token>"]} ja odota vastausta auth success.
4. Lähetä {"event": "send logs", "args": [null]}, niin saat viimeisimmän tulosteen uudelleen.

Viestit ovat JSONia muodossa {"event": "...", "args": [...]}.

Tapahtumat, joita vastaanotat:

• console output
• status
• stats (JSON-merkkijono)
• install output
• daemon message ja daemon error
• token expiring: hae uusi token ja lähetä auth uudelleen.
• token expired

Tapahtumat, joita voit lähettää:

• send command ja komennon teksti.
• set state ja start, stop, restart tai kill.
• send logs
• send stats

SDK hoitaa kaiken tämän: hw.console(id) tai hw.tail(id).

SFTP#

Tiedostoihin pääsee myös SFTP:llä. Käytä GET /servers/{server} -kutsun sftp_details-kentän osoitetta ja käyttäjänimeä <your username>.<server identifier>. Kirjaudu paneelin salasanalla tai SSH-avaimella, jonka olet lisännyt kohdassa /account/ssh-keys.