REST API – WEDOS.protection Services

GET /services

Liefert eine Liste der eigenständigen WEDOS Global Protection Services des angemeldeten OAuth2-Benutzers (direkt als WGP-Service angelegt, Tabelle hosting_wedos_protection).

Parameter:

• status – optional, Query – Filter nach einem bestimmten Service-Status (der Wert wird nicht gegen die Statusliste validiert)

Rückgabecodes:

• 1000 – OK

Antwortdaten: Ein Array von Services; jedes Element enthält ID, name, status, expiration.

Beispiel:

curl -X GET -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/services?status=active'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": [
    {
      "ID": 435,
      "name": "domain1.tld",
      "status": "active",
      "expiration": "2027-10-01 00:00:00"
    }
  ]
}

POST /services/{service_id}/cache/purge

Leert den CDN-Cache für eine mit WGP verbundene Domain. Das Ziel kann entweder ein eigenständiger WGP-Service oder eine Domain mit WGP als Add-on-Service sein (hosting_domain); der Service-Typ wird mit dem Parameter service_type festgelegt.

Parameter:

• service_id – erforderlich, Pfad – lokale Service-ID
• service_type – optional – Service-Typ, hosting_wedos_protection (Standard) oder hosting_domain
• limiter_decay – optional, Zahl – Zeit in Sekunden, in der wiederholtes Leeren begrenzt ist; Standard 5
• limiter_reset – optional, Bool – aktuelle Begrenzung aufheben; Standard false

Rückgabecodes:

• 1000 – OK
• 2100 – erforderlicher Parameter fehlt
• 2101 – ungültiger Parameterwert
• 2406 – Domain/Service nicht gefunden
• 2415 – der Limiter läuft noch – das Leeren kann derzeit nicht wiederholt werden
• 3223 – der Service gehört zu einem anderen Kundenkonto
• 2400 – interner Fehler – nicht registrierter Rückgabecode

Antwortdaten:

• domain – Domainname
• domain_id – ID der Domain in WGP
• domain_tld – TLD der Domain
• service_id – Service-ID
• wedos_client_id – ID des Kunden in WGP
• limiter_available_in – in wie vielen Sekunden die Funktion wieder genutzt werden kann (nur für den Fehler 2415dokumentiert; die aktuelle Implementierung gibt im Fehlerfall jedoch keinen data-Teil zurück, siehe Hinweise)

Beispiel:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/wgp/services/435/cache/purge' \
  --data '{"limiter_decay":5,"limiter_reset":0}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": "domain1.tld",
    "domain_id": 98765,
    "domain_tld": "tld",
    "service_id": 435,
    "wedos_client_id": 10234
  }
}

POST /services/{service_id}/renew

Verlängert den WGP-Service um eine weitere Abrechnungsperiode.

Parameter:

• service_id – erforderlich, Pfad – Service-ID

Rückgabecodes:

• 1000 – OK
• 2100 – erforderlicher Parameter fehlt
• 2101 – ungültiger Parameterwert
• 2152 – im aktuellen Status des Service ist eine Verlängerung nicht zulässig
• 2279 – das Guthabenkonto ist gesperrt
• 2281 – das Guthabenkonto ist nicht aktiv
• 2282 – Zahlung vom Guthabenkonto in der angegebenen Währung nicht möglich
• 2283 – unzureichendes Guthaben auf dem Guthabenkonto
• 2284 – Fehler in den Kontaktdaten des Guthabenkontos
• 2293 – Guthabenstand des Guthabenkontos kann nicht ermittelt werden
• 2297 – es kann nicht ermittelt werden, ob das Guthabenkonto MwSt. enthält
• 2406 – Service nicht gefunden
• 2409 – Verlängerung des Service fehlgeschlagen

Antwortdaten:

• service_id – Service-ID
• name – Domainname
• date_from, date_to – Gültigkeitsdaten der neuen Periode
• fakt_order_num – Bestellnummer der Verlängerung
• currency – Währung des Guthabenkontos
• price – Betrag der Verlängerung
• credit – Guthabenstand des Guthabenkontos danach (null bei FREE-/TRIAL-Services)

Beispiel:

curl -X POST -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/services/435/renew'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "service_id": 435,
    "name": "domain1.tld",
    "date_from": "2027-10-01",
    "date_to": "2028-10-01",
    "fakt_order_num": "2026123457",
    "currency": "CZK",
    "price": 499,
    "credit": 502
  }
}

POST /services/{service_id}/template-replicate

Repliziert (übernimmt) die Einstellungen einer Vorlagen-Domain auf eine bestehende WGP-Domain bzw. einen bestehenden WGP-Service.

Parameter:

• service_id – erforderlich, Pfad – ID des Service, auf den die Einstellungen repliziert werden
• template_domain_id – erforderlich – ID der Vorlagen-Domain (siehe GET /domains/templates)
• service_type – optional – Service-Typ, hosting_wedos_protection (Standard) oder hosting_domain

Rückgabecodes:

• 1000 – OK
• 2100 – erforderlicher Parameter fehlt
• 2101 – ungültiger Parameterwert
• 2401 – ungültige Domain für die Replikation
• 2402 – ungültige Vorlagen-Domain
• 2403 – unterschiedliche Benutzer bei der Domain und der Vorlagen-Domain
• 2404 – unterschiedliche Tarife bei der Domain und der Vorlagen-Domain
• 2405 – tägliches Replikationslimit erreicht
• 2406 – Domain/Service nicht gefunden
• 2407 – Vorlagen-Domain nicht gefunden
• 2400 – interner Fehler – nicht registrierter Rückgabecode

Antwortdaten:

• domain – Domainname
• domain_id – ID der Domain
• service_id – Service-ID
• service_type – Service-Typ
• template_domain_id – ID der verwendeten Vorlagen-Domain
• replications_count – Anzahl der bisher durchgeführten Replikationen
• replications_limit – maximal zulässige Anzahl von Replikationen

Beispiel:

curl -X POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/wgp/services/435/template-replicate' \
  --data '{"template_domain_id":123}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": "domain1.tld",
    "domain_id": 98765,
    "service_id": 435,
    "service_type": "hosting_wedos_protection",
    "template_domain_id": 123,
    "replications_count": 2,
    "replications_limit": 5
  }
}

PATCH /services/{service_id}

Ändert die Variante und/oder die Abrechnungsperiode eines bestehenden WGP-Service.

Parameter:

• service_id – erforderlich, Pfad – Service-ID
• new_variant_id – optional, Zahl – neue Service-Variante
• new_period_id – optional, Zahl – neue Abrechnungsperiode

Mindestens einer der Parameter new_variant_id/new_period_id muss angegeben werden.

Rückgabecodes:

• 1000 – OK
• 2100 – erforderlicher Parameter fehlt
• 2101 – ungültiger Parameterwert
• 2203 – ungültiger Wert von new_period_id
• 2273 – ungültiger Wert von new_variant_id
• 2279 – das Guthabenkonto ist gesperrt
• 2281 – das Guthabenkonto ist nicht aktiv
• 2282 – Zahlung vom Guthabenkonto in der angegebenen Währung nicht möglich
• 2283 – unzureichendes Guthaben auf dem Guthabenkonto
• 2284 – Fehler in den Kontaktdaten des Guthabenkontos
• 2293 – Guthabenstand des Guthabenkontos kann nicht ermittelt werden
• 2294 – Preis des Service kann nicht ermittelt werden
• 2406 – Domain/Service nicht gefunden
• 2408 – Parameter new_variant_id oder new_period_id fehlt (keiner von beiden wurde angegeben)
• 2400 – interner Fehler – nicht registrierter Rückgabecode

Antwortdaten:

• domain – Domainname
• domain_id – ID der Domain
• wedos_client_id – ID des Kunden in WGP
• service_id – Service-ID
• service_type – Service-Typ
• variant_id – aktuelle ID der Service-Variante nach der Änderung
• period_id – aktuelle ID der Abrechnungsperiode nach der Änderung
• dirty – Flag, das anzeigt, ob tatsächlich eine Änderung erfolgt ist (0 = unverändert, 1 = geändert)

Beispiel:

curl -X PATCH -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' \
  'https://api.wedos.com/v2/wgp/services/435' \
  --data '{"new_variant_id":2,"new_period_id":1}'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": "domain1.tld",
    "domain_id": 98765,
    "wedos_client_id": 10234,
    "service_id": 435,
    "service_type": "hosting_wedos_protection",
    "variant_id": 2,
    "period_id": 1,
    "dirty": 1
  }
}

DELETE /services/{service_id}

Löscht/kündigt einen WGP-Service auf Wunsch des Kunden.

Parameter:

• service_id – erforderlich, Pfad – Service-ID
• force – optional, Query, 0/1 – erzwingt die Löschung, auch wenn WGP kein Token zum Umschreiben des DNS zur Verfügung hat (Wiederherstellung der ursprünglichen Werte der A-/AAAA-Einträge)

Rückgabecodes:

• 1000 – OK
• 2100 – erforderlicher Parameter fehlt
• 2292 – die Domain wurde in WGP für dieses Kundenkonto nicht gefunden
• 2400 – interner Fehler
• 2410 – Service nicht gefunden
• 2411 – kein Token zum Umschreiben des DNS verfügbar
• 2412 – die API-Anfrage zum Umschreiben des DNS ist fehlgeschlagen
• 2413 – der Befehl kann nicht ausgeführt werden, WGP fehlt die Berechtigung, das DNS der Domain zu ändern (force=1 erforderlich)
• 2414 – es existiert kein Token für WGP und der Parameter force wurde nicht angegeben
• 3223 – der Service gehört zu einem anderen Kundenkonto

Antwortdaten:

• domain – Domainname
• domain_id – ID der Domain
• wedos_client_id – ID des Kunden in WGP
• service_id – Service-ID
• service_type – Service-Typ
• wdns_data – Array der vorgenommenen Änderungen an DNS-Einträgen (IP-Adressen, die nach der Kündigung nicht mehr über WGP aufgelöst werden)

Beispiel:

curl -X DELETE -H 'Authorization: Bearer <TOKEN>' \
  'https://api.wedos.com/v2/wgp/services/435?force=1'

{
  "code": 1000,
  "msg": "OK",
  "request_id": "a1b2c3d4",
  "data": {
    "domain": "domain1.tld",
    "domain_id": 98765,
    "wedos_client_id": 10234,
    "service_id": 435,
    "service_type": "hosting_wedos_protection",
    "wdns_data": []
  }
}