Endpoint-referens

KernelHost API

Alla endpoints returnerar application/json. Fel följer RFC 7807 (Problem+JSON). Svaret innehåller alltid headern X-Request-Id för korrelation med den serversida granskningsloggen.

MethodPathBehörighetSyfte
GET/v1/healthpublicHälsokontroll utan autentisering.
GET/v1/meanyEgen kontoinformation samt nyckelmetadata.
GET/v1/productsread:productsLista över alla offentligt listade produkter med priser.
GET/v1/products/{id}read:productsProduktdetaljer inklusive konfigurationsalternativ.
POST/v1/orderswrite:ordersLägg en beställning. Idempotency-Key krävs.
GET/v1/orders/{id}read:ordersStatus för en egen beställning.
GET/v1/servicesread:servicesLista över egna tjänster (paginerad).
GET/v1/services/{id}read:servicesDetaljer för en egen tjänst.
GET/v1/services/{id}/credentialsread:credentialsTjänstens inloggningsuppgifter (separat behörighet, granskad).
POST/v1/services/{id}/actionswrite:servicesTjänsteåtgärd: start, stop, reboot, cancel (till faktureringsperiodens slut), cancel_revoke.
GET/v1/services/{id}/metricsread:servicesServermätvärden för en egen tjänst (CPU, minne, nätverk).
GET/v1/services/{id}/ddos/profilesread:ddosTillgängliga profiler för Advanced DDoS Protection.
GET/v1/services/{id}/ddos/rulesread:ddosAktuella regler för den tilldelade skyddade IP-adressen.
POST/v1/services/{id}/ddos/ruleswrite:ddosLägg till en skyddsregel. Idempotency-Key krävs.
DELETE/v1/services/{id}/ddos/rules/{rule_id}write:ddosTa bort en egen regel. Idempotency-Key krävs.
GET/v1/services/{id}/ddos/attacksread:ddosUpptäckta attacker mot den skyddade IP-adressen (Remote DDoS Protection).
GET/v1/services/{id}/ddos/attacks/{attack_id}read:ddosDetaljer om en attack: trafik och fördelningar.
GET/v1/billing/balanceread:billingSaldo.
GET/v1/billing/invoicesread:billingLista över dina fakturor (paginerad).
GET/v1/billing/invoices/{id}/pdfread:billingFaktura-PDF.
GET/v1/webhooksread:webhooksAktuell Webhook-URL.
PUT/v1/webhookswrite:webhooksStäll in eller ta bort Webhook-URL.

Regler för Advanced DDoS Protection

Dessa endpoints kräver en Advanced DDoS Protection-tjänst som tillhör ditt konto. Läsning fungerar med status active eller suspended; ändringar kräver status active. Aktivera read:ddos för läsning och write:ddos för ändringar uttryckligen på din API-nyckel. Befintliga nycklar får inga nya behörigheter automatiskt. Hantering av tunnlar och vitlistor är inte tillgänglig.

Välj app_code ur profilkatalogen. port måste vara ett heltal från 1 till 65535; för icmp kan det utelämnas eller sättas till 0. Det valfria objektet extra_ports kopplar profilens exakta etiketter till heltalsportar; utelämnade etiketter behåller profilens standardvärden. Servern bestämmer protokollen, så skicka inte protocol. Okända fält eller etiketter ger HTTP 400.

GET /v1/services/{id}/ddos/profiles

{
  "data": [{
    "app_code": "rust",
    "name": "Rust",
    "default_port": 28015,
    "protocol": "UDP",
    "extra_ports": [
      {"name": "Query", "port": 28016, "protocol": "UDP"},
      {"name": "RCON", "port": 28016, "protocol": "TCP"},
      {"name": "RustPlus", "port": 28082, "protocol": "TCP"}
    ]
  }],
  "meta": {"service_id": 1234, "protection_ip": "192.0.2.10", "max_rules": 1000}
}

POST /v1/services/{id}/ddos/rules

{
  "app_code": "rust",
  "port": 28015,
  "extra_ports": {"Query": 28016, "RCON": 28016, "RustPlus": 28082}
}

POST returnerar HTTP 201 med den skapade regeln i data. GET returnerar reglerna och meta med service_id, protection_ip och max_rules. DELETE använder en tom body och returnerar HTTP 200 enligt exemplet nedan. Både POST och DELETE kräver Idempotency-Key.

GET /v1/services/{id}/ddos/rules

{
  "data": [{
    "id": "example-rule-id",
    "app_code": "rust",
    "port": 28015,
    "protocol": "UDP",
    "extra_ports": [
      {"name": "Query", "port": 28016, "protocol": "UDP"},
      {"name": "RCON", "port": 28016, "protocol": "TCP"},
      {"name": "RustPlus", "port": 28082, "protocol": "TCP"}
    ]
  }],
  "meta": {"service_id": 1234, "protection_ip": "192.0.2.10", "max_rules": 1000}
}

DELETE /v1/services/{id}/ddos/rules/{rule_id}

{"data": {"id": "example-rule-id", "deleted": true}}

Panelen och API:et delar fasta UTC-fönster: 10 skrivförsök per minut och konto, 5 per minut och skyddad IP-adress samt 200 per UTC-dygn och konto. Tillåtna men ogiltiga eller misslyckade försök räknas; lyckade idempotenta upprepningar räknas inte. DDoS-läsningar via API:et delar 30 anrop per minut och konto. Högst 1000 regler per skyddad IP-adress.

HTTP 404: okänd tjänst eller någon annans tjänst, någon annans regel, saknad regel eller systemregel. HTTP 409: ingen Advanced DDoS Protection-tjänst (not_supported_for_product), inaktiv tjänst, portkonflikt eller samtidig ändring. HTTP 429: gränsen nådd, följ Retry-After. HTTP 502: skyddstjänsten kunde inte slutföra anropet. Systemregeln block döljs och kan inte tas bort. HTTP 503: kontrollen av anropsgränser är tillfälligt otillgänglig, följ Retry-After.

Rapporter om DDoS-attacker

Dessa endpoints kräver en Remote DDoS Protection-tjänst som tillhör ditt konto, med status active eller suspended, samt behörigheten read:ddos, som måste aktiveras uttryckligen. Listan visar de DDoS-attacker som har upptäckts mot tjänstens skyddade IP-adress, de senaste först.

Frågeparametrar: from och to som datum (YYYY-MM-DD) eller som datum och tid enligt ISO 8601 med tidszon (standard: de senaste 30 dagarna), limit från 1 till 100 (standard 25) och offset från 0 till 9999 (standard 0). Perioden sträcker sig aldrig längre tillbaka än 90 dagar och aldrig till tiden innan den skyddade IP-adressen tilldelades tjänsten; meta.from och meta.to visar den period som faktiskt användes.

GET /v1/services/{id}/ddos/attacks?from=2026-10-10

{
  "data": [{
    "id": "3f6c1a2e-9b47-4d8a-b5e2-7c0d9e4a1f63",
    "type": "ddos_attack",
    "started_at": "2026-11-07T18:34:06Z",
    "ended_at": null,
    "detected_bps": 20938227712,
    "detected_pps": 1998848,
    "source_ip_count": 341,
    "target_ip": "203.0.113.111",
    "details_available": true
  }],
  "paging": {"limit": 25, "offset": 0, "total": 1, "truncated": false},
  "meta": {"service_id": 5678, "protected_ip": "203.0.113.111", "from": "2026-10-10T00:00:00Z", "to": "2026-11-09T11:10:16Z", "retention_days": 90}
}

Varje attack innehåller id (UUID), type (ddos_attack, eller blackhole om mål-IP-adressen tillfälligt blockerades med nollroutning), started_at, ended_at (kan vara null), detected_bps, detected_pps, source_ip_count, target_ip och details_available. detected_bps och detected_pps anger nivån i det ögonblick attacken upptäcktes; filtreringen hade då redan börjat, så de kan vara lägre än toppvärdet i detaljerna. paging innehåller limit, offset, total och truncated (true om perioden omfattar fler än 500 attacker), meta innehåller service_id, protected_ip, from, to och retention_days (90). Listor cachas i 60 sekunder.

GET /v1/services/{id}/ddos/attacks/{attack_id}

{
  "data": {
    "id": "3f6c1a2e-9b47-4d8a-b5e2-7c0d9e4a1f63",
    "type": "ddos_attack",
    "started_at": "2026-11-07T18:34:06Z",
    "ended_at": null,
    "detected_bps": 20938227712,
    "detected_pps": 1998848,
    "source_ip_count": 341,
    "target_ip": "203.0.113.111",
    "details_available": true,
    "peak_bps": 20938227712,
    "peak_pps": 1998848,
    "total_bytes": 104809201664,
    "total_packets": 81887232,
    "interval_seconds": 1,
    "traffic": [{"time": "2026-11-07T18:34:06Z", "bps": 20938227712, "pps": 1998848}],
    "protocols": [{"protocol": "UDP", "avg_bps": 695618765, "avg_pps": 65645, "bytes": 104342814720, "packets": 78774272, "bps_percent": 99.56, "pps_percent": 96.2}],
    "destination_ports": [{"port": 58675, "protocol": "UDP", "avg_bps": 695556506, "avg_pps": 65481, "bps_percent": 99.55, "pps_percent": 95.96}],
    "source_ports": [{"port": 53, "protocol": "UDP", "avg_bps": 41896312, "avg_pps": 3511, "bps_percent": 5.996, "pps_percent": 5.15}],
    "source_countries": [{"country": "MX", "avg_bps": 96051528, "avg_pps": 8656}],
    "source_ips": [{"ip": "198.51.100.7", "avg_bps": 46162248, "avg_pps": 4151, "bps_percent": 6.61, "pps_percent": 6.08}],
    "packet_sizes": [{"range": "1400-1499", "avg_bps": 374806938, "percent": 54.076}]
  },
  "meta": {"service_id": 5678, "cached": false}
}

Detaljerna innehåller alla fält från listan samt peak_bps, peak_pps, total_bytes, total_packets och interval_seconds. traffic listar den inkommande attacktrafiken per intervall ({time, bps, pps}) så som filtreringsnätet såg den, från cirka 10 minuter före till cirka 10 minuter efter upptäckten. Fördelningarna protocols, destination_ports, source_ports, source_countries, source_ips och packet_sizes innehåller oftast de 5 största posterna: avg_bps och avg_pps är medelvärden över mätfönstret, bps_percent och pps_percent är andelar. protocols innehåller dessutom bytes och packets, packet_sizes innehåller range, avg_bps och percent. Detaljer cachas i upp till 15 minuter.

HTTP 400 validation_failed: ogiltigt värde eller okänd frågeparameter. HTTP 404: okänd tjänst eller någon annans tjänst, okänt attack-ID eller attack mot en annan IP-adress. HTTP 409 not_supported_for_product: ingen Remote DDoS Protection-tjänst (till exempel Advanced DDoS Protection eller en server). HTTP 409 service_not_active: tjänsten har varken status active eller suspended. HTTP 409 protection_not_ready: skyddet håller fortfarande på att konfigureras.

Servermätvärden

Denna endpoint kräver en aktiv tjänst i ditt konto och behörigheten read:services. Edge Unlimited Traffic VPS levererar mätvärden för CPU, minne och inkommande och utgående nätverkstrafik (bit/s och paket/s) samt utgående trafik per dag och hittills under månaden. Vanliga Unlimited Traffic VPS på platserna Europa, Tyskland, Frankrike, östra Kanada, Storbritannien och Polen levererar endast mätvärden för inkommande och utgående nätverkstrafik i bit/s.

Frågeparameter range: 1h, 6h, 24h, 7d eller 14d (standard 1h). Avståndet mellan mätpunkterna beror på perioden: för Edge Unlimited Traffic VPS cirka 15 sekunder (1h), 20 sekunder (6h), 2 minuter (24h), 10 minuter (7d) och 20 minuter (14d); för vanliga Unlimited Traffic VPS 5 minuter upp till 24h, 30 minuter för 7d och 2 timmar för 14d. step_seconds visar avståndet i svaret.

GET /v1/services/{id}/metrics?range=24h

{
  "data": {
    "service_id": 1234,
    "range": "24h",
    "step_seconds": 120,
    "available": ["cpu_percent", "memory_percent", "network_in_bps", "network_out_bps", "network_in_pps", "network_out_pps"],
    "summary": {
      "cpu_percent": {"avg": 3.1, "max": 41.7, "last": 2.9},
      "network_in_bps": {"avg": 64012.5, "max": 912345.0, "last": 60026.2}
    },
    "points": [
      {"time": "2026-11-08T11:12:00Z", "cpu_percent": 3.254, "memory_percent": 43.001, "network_in_bps": 68515.425, "network_out_bps": 650.767, "network_in_pps": 119.992, "network_out_pps": 0.775},
      {"time": "2026-11-08T11:14:00Z", "cpu_percent": 3.118, "memory_percent": 43.004, "network_in_bps": 66120.871, "network_out_bps": 702.134, "network_in_pps": 115.317, "network_out_pps": 0.825}
    ],
    "traffic": {
      "month_to_date_out_bytes": 111844510,
      "daily": [{"date": "2026-11-09", "out_bytes": 10485760, "final": false}],
      "as_of": "2026-11-09T11:00:01Z",
      "unit": "bytes",
      "direction": "outbound"
    }
  },
  "meta": {"generated_at": "2026-11-09T11:12:30Z", "cached": false, "measured_at": "server_network_interface"}
}

Värdena mäts vid serverns nätverksgränssnitt och visar alltså den trafik som faktiskt nådde servern. Minnet kräver gästagenten i servern. Värden som inte kunde mätas är null; available listar de mätvärden som har uppmätta data och summary visar avg, max och last för vart och ett. traffic innehåller utgående trafik i byte per dag och hittills under månaden (final är true när en dag är avslutad) och är null för produkter utan trafikräknare. Svar cachas i 30 sekunder (1h) upp till 10 minuter (14d); meta.cached visar om svaret kom från cachen.

HTTP 400 validation_failed: annat värde för range eller okänd frågeparameter. HTTP 404: okänd tjänst eller någon annans tjänst. HTTP 409 not_supported_for_product: inga mätvärden finns för denna tjänst (andra produkter och platser). HTTP 409 service_not_active: tjänsten är inte aktiv.

För servermätvärden och attackrapporter gäller de allmänna hastighetsbegränsningarna. Dessutom är hämtningar som inte kan besvaras från cachen begränsade till 20 per minut och konto för dessa tre endpoints tillsammans; därutöver får du HTTP 429 med Retry-After. HTTP 502 monitoring_unavailable eller reports_unavailable: datakällan är tillfälligt otillgänglig, försök igen senare. HTTP 503 temporarily_unavailable med Retry-After: ett parallellt anrop förbereder just nu samma data.

Inte tillgängligt via API:et: attackrapporter för Advanced DDoS Protection och för servrar som Edge Unlimited Traffic VPS; statistik över ren eller kasserad trafik per skyddad IP-adress; CPU och minne för vanliga Unlimited Traffic VPS; leverans av webhooks och CSV-export.

Idempotens

POST /v1/orders och POST /v1/services/{id}/actions kräver headern Idempotency-Key (1 till 80 tecken från [A-Za-z0-9_.-]). Nyckeln är knuten till metod, sökväg och body. Om du upprepar samma förfrågan med samma nyckel inom en timme får du det sparade svaret; därefter får du 410 med reason replay_stale och bör skicka en ny nyckel. Samma nyckel med en annan body eller på en annan endpoint avvisas med 409 idempotency_conflict.

Hastighetsbegränsningar

Som standard gäller 60 förfrågningar per minut (plus en burst på 20) och 5 000 per dag per nyckel, 120 per minut per konto över alla nycklar och 600 per minut per käll-IP. När en gräns överskrids får du HTTP 429 med headern Retry-After. Svarets headers X-RateLimit-Remaining och X-RateLimit-Reset visar aktuell status för gränsen per nyckel.