This article deals with WAPI commands specifically for the WEDOS Protection service. For information on how to set up WAPI and troubleshoot common issues, see the article WAPI – Manual.
This article provides information on the following commands:
- wgp-domain-create – add a domain to WEDOS Protection
- wgp-domain-info – list WEDOS Protection domain information
- wgp-domain-renew – renew service
- wgp-domain-delete – terminate service
- wgp-domain-update-subscription – change subscription plan
- wgp-domain-create-retry – resolve some errors
- wgp-domain-cache-purge – purge WP cache
- wgp-domain-template-replicate – replicates a template to an existing domain
- wgp-domain-templates-list – domain template list
- wgp-services-list – WEDOS Protection domain list
wgp-domain-create
Use the wgp-domain-create request to create a domain record in WEDOS Protection. This request is asynchronous and communicates via notifications ⧉.
Parameters
- domain = ime domene (obvezno)
- variant_id = service plan (required) – 1 = Free, 2 = Advanced, 3 = Expert (you can find the plans and their prices on the product site ⧉)
- period_id = obračunsko obdobje storitve (obvezno) – 1 = mesečno, 4 = letno
- upstream_ips = polje ciljnih naslovov IP (neobvezno) – več informacij o ciljnih naslovih IP najdete v Protection – Upstream Targets article
- template_domain_id = ID domene iz predloge (neobvezno)
- mode = način domene (neobvezno)
- ns= uporablja NS WEDOS (privzeto); sistem domeno aktivira le, če uspešno preveri, da uporablja DNS WEDOS.
- cname= omogoča uporabo strežnikov DNS drugega ponudnika ali dodajanje poddomen prek zapisa CNAME; način za vsako domeno 3. ali višje ravni je vednocname.
You can find more information about adding a domain to WEDOS Protection in the Protection – Add New Domain article.
The default mode for 2nd level domains is ns. Privzeta in edina razpoložljiva mode for 3rd and higher level domains (subdomains) is cname.
Return Values
- 1000 OK
- 1001 Zahteva čaka na obdelavo
- 2101 Parametri se ne ujemajo
- 2202 Neveljavna ali nepodprta oblika imena domene
- 2203 = Neveljaven period_id
- 2206 Neveljavna zahteva – notranja napaka
- 2272 = Neveljavna oblika naslova IP
- 2273 = Neveljavna različica
- 2274 = Notranja napaka – manjka parameter user_id
- 2275 Notranja napaka – uporabnik ni najden
- 2276 Nepodprt TLD ali presežena največja raven domene
- 2277 Izrecno dodajanje www. pred imenom domene ni dovoljeno
- 2278 = Imena domene ni mogoče uporabiti – obstaja storitev s tem imenom domene
- 2279 = Predplačniški račun je zaklenjen
- 2280 = Predplačniški račun je aktiven
- 2281 Neaktiven predplačniški račun
- 2282 Neveljavna valuta predplačniškega računa
- 2283 Neveljaven znesek ali premalo kredita
- 2284 = Napaka pri podatkih o predplačniškem računu
- 2285 Napačne nastavitve DDV
- 2286 = Predplačniški račun – notranja napaka
- 2290 = Predplačniški račun – gibanje ni bilo dodano na predplačniški račun
- 2291 = Domena za ta uporabniški račun v API-ju WGP že obstaja
- 2293 Stanja kredita na predplačniškem računu ni mogoče pridobiti
- 2294 Cene storitve ni mogoče pridobiti
- 2295 Domene v WGP ni mogoče ustvariti. Plačilo je bilo preklicano.
- 2296 = Gibanja na predplačniškem računu ni mogoče preklicati
- 2400 = Notranja napaka WGP
- 2401 = Predloge ni mogoče uporabiti za domeno
- 2402 Neveljavna predloga domene
- 2403 = Predloga domene in uporabnik se ne ujemata
- 2404 = Predloga domene in paket domene se ne ujemata
- 2405 = Dosežena dnevna omejitev domen iz predlog
- 2416 Neveljaven način domene
Response Data
- WGP_ID = ID zapisa domene v WGP
- domain = ime domene
- order_num = številka naročila
- currency = valuta predplačniškega računa
- amount = cena storitve
- acc_amount_before = stanje predplačniškega računa pred aktivacijo storitve
- acc_amount_current = stanje predplačniškega računa po aktivaciji storitve
Notification Response Data
- WGP_ID = ID zapisa domene v WGP
- domain = ime domene
- order_num = številka naročila
Templates
JSON request:
{
"request": {
"user": "your@login.tld",
"auth": "generated authentication string",
"command": "wgp-domain-create",
"clTRID": "own ID code",
"data": {
"domain": "domain_name.tld",
"variant_id": "1 = Free, 2 = Advanced, 3 = Expert",
"period_id": "1 = monthly billing, 4 = yearly billing",
"upstream_ips": ["IP address 1", "IP address 2", "(optional)"],
"template_domain_id": "ID of the template domain (optional)",
"mode": "domain mode (optional)"
}
}
}
JSON response (request pending):
{
"response": {
"code": 1001,
"result": "Request pending",
"timestamp": "UTF time",
"clTRID": "own ID code",
"svTRID": "server ID code",
"command": "wgp-domain-create",
"data": {
"WGP_ID": "assigned domain ID in WG",
"domain": "domain_name.tld",
"order_num": "order number",
"currency": "currency code",
"amount": "price",
"acc_amount_before": "credit account balance before transaction",
"acc_amount_current": "credit account balance after transaction"
}
}
}
JSON notification after setup is complete:
{
"notify": {
"code": "1000",
"result": "OK",
"timestamp": "UTF time",
"clTRID": "own ID code",
"svTRID": "server ID code",
"command": "wgp-domain-create",
"id": "POLL queue ID",
"data": {
"WGP_ID": "assigned domain ID in WG",
"domain": "domain_name.tld",
"order_num": "order number",
}
}
}
wgp-domain-info
Use the wgp-domain-info request to display domain status information in the WEDOS Protection service.
Parameters
- domain = ime domene (obvezno)
Return Values
- 1000 OK
- 2100 Manjka obvezni parameter
- 2101 Parametri se ne ujemajo
- 2202 Neveljavna ali nepodprta oblika imena domene
- 2206 Neveljavna zahteva – notranja napaka
- 2292 = Domena za ta uporabniški račun v API-ju WGP ni bila najdena
Response Data
- wgp = stanje domene v WEDOS Protection; state parameter has one of the following values, some of which can contain different data:
- pending_dns = poteka razreševanje zapisov DNS domene
- processing = čaka se na nastavitev storitve
- stuck = čaka se na programske zahteve
- pending_txt = čaka se na preverjanje zapisa TXT (partial template)
- pending_ns = čaka se na nastavitev imenskih strežnikov (partial template for NS mode and CNAME mode)
- pending_dns_refresh = ponovno razreševanje DNS, če prejšnji pending_dns ni našel nobenih zapisov DNS
- pending_crt = čaka se na certifikat Let’s Encrypt za WG
- active = domena je aktivna (full template)
- service = stanje domene v sistemu WEDOS
You can find more detailed information on return data in the template.
Templates
JSON request:
{
"request": {
"user": "your@login.tld",
"auth": "generated authentication string",
"command": "wgp-domain-info",
"clTRID": "own ID code",
"data": {
"domain": "domain_name.tld"
}
}
}
JSON response (OK, state active):
{
"response": {
"code": 1000,
"result": "ok",
"timestamp": "UTF time",
"clTRID": "own ID code",
"svTRID": "server ID code",
"command": "wgp-domain-info",
"data": {
"wgp":{
"domain": "domain_name.tld",
"domain_id": "assigned domain ID",
"domain_tld": "tld",
"modes": ["režim domény"],
"settings": {
"cache": "cache status (empty off, 1 on)"
},
"url": "https:\/\/client.wedos.global\/protection\/domains\/domain_name.tld",
"state": "active",
"state_data": {
"dns_ip_addresses": ["WG proxy IPv4 address", "WG proxy IPv6 address"],
"dns_pointing_to_proxy": "DNS proxy routing check, empty false, 1 true",
"dns_records_new": [
{
"name": "",
"data": "WG proxy IPv4 address",
"type": "A",
"ttl": 300
},
{
"name": "*",
"data": "WG proxy IPv4 address",
"type": "A",
"ttl": 300
},
{
"name": "",
"data": "WG proxy IPv6 address",
"type": "AAAA",
"ttl": 300
},
{
"name": "*",
"data": "WG proxy IPv6 address",
"type": "AAAA",
"ttl": 300
}
],
"dns_records": [
{
"name": "",
"data": "current IPv4 address",
"type": "A",
"ttl": 300
},
{
"name": "*",
"data": "current IPv4 address",
"type": "A",
"ttl": 300
},
{
"name": "",
"data": "current IPv6 address",
"type": "AAAA",
"ttl": 300
},
{
"name": "",
"data": "current IPv6 address",
"type": "AAAA",
"ttl": 300
}
]
}
},
"service": {
"ID": "service ID in the system",
"name": "domain_name.tld",
"num": "order number",
"user_id": "user ID in the system",
"lang": "language code",
"currency": "currency code",
"cli_legal_type": "Billing - 1 = natural person, 2 = enterpreneur, 3 = legal person",
"cli_company" :"Billing – Company name",
"cli_fname": "Billing – Name",
"cli_lname": "Billing – Surname",
"cli_email": "Billing – Email",
"cli_email2": "Billing – Backup email",
"cli_phone": "Billing – Phone",
"cli_mobile": "Billing – Mobile",
"cli_fax": "Billing – Fax",
"cli_ic": "Billing – Company ID",
"cli_dic": "Billing – VAT ID",
"cli_taxpayer": "Billing – VAT payer (0/1)",
"cli_addr_street": "Billing – Street and number",
"cli_addr_city": "Billing – Town",
"cli_addr_zip": "Billing – ZIP",
"cli_addr_country": "Billing – Country code",
"cli_name_vies": "Billing – VIES name",
"own_legal_type": "Operator - 1 = natural person, 2 = enterpreneur, 3 = legal person",
"own_company": "Operator – Company name",
"own_fname": "Operator - Name",
"own_lname": "Operator - Surname",
"own_email": "Operator - Email",
"own_phone": "Operator - Phone",
"own_ic": "Operator - Company ID",
"own_dic": "Operator - VAT ID",
"own_addr_street": "Operator – Street and number",
"own_addr_city": "Operator - Town",
"own_addr_zip": "Operator - ZIP",
"own_addr_country": "Operator – Country code",
"status": "service status in WEDOS customer administration",
"expiration": "expiration date YYYY-MM-DD"
}
}
}
}
JSON data (OK, state pending_txt):
{
...
"data": {
...
"state": "pending_txt",
"state_data": {
"name": "_TXT_record_name",
"name_formatted": "_TXT_record_name_with_domain.tld",
"value": "TXT-record-value--verification-code"
}
}
}
JSON data (OK, state pending_ns in ns mode):
{
...
"data": {
...
"state": "pending_ns",
"state_data": {
"assigned": [
"assigned-nameserver.ns.wedos.net",
"assigned-nameserver.ns.wedos.com",
"assigned-nameserver.ns.wedos.eu",
"assigned-nameserver.ns.wedos.cz"
],
"assigned_own": [
[
"own-ns1.if-permitted.tld",
"own-ns2.if-permitted.tld"
]
],
"resolved": [
"current-resolved-ns1.domain.tld",
"current-resolved-ns2.domain.tld"
],
"resolved_at": "UTF timestamp of last performed DNS check",
"next_resolve_at": "UTF timestamp of next scheduled DNS check"
}
}
}
JSON data (OK, state pending_ns in cname mode; crt_name and cname are record names and values for the user to set with their DNS provider):
{
...
"state_data": {
"crt_cname": [
{
"name": "_acme-challenge",
"value": "_acme-challenge.verification_code.wgp123.wedos.global"
}
],
"cname": [
{
"name": "*",
"value": "verification_code.wgp123.wedos.global"
},
{
"name": "www",
"value": "verification_code.wgp123.wedos.global"
}
],
"resolved_at": "UTF timestamp of last performed DNS check",
"next_resolve_at": "UTF timestamp of next scheduled DNS check"
}
}
}
wgp-domain-renew
Use the wgp-domain-renew request to extend the domain in the WEDOS Protection service for another period.
Parameters
- service_id = ID storitve (obvezno)
Return Values
- 1000 OK
- 2100 Manjka obvezni parameter
- 2101 Parametri se ne ujemajo
- 2152 = Podaljšanje storitve je blokirano
- 2206 = Manjka user_id
- 2279 = Predplačniški račun je blokiran
- 2281 Neaktiven predplačniški račun
- 2282 Neveljavna valuta predplačniškega računa
- 2283 Neveljaven znesek ali premalo kredita
- 2284 = Napaka pri podatkih o predplačniškem računu
- 2286 = Predplačniški račun – notranja napaka
- 2293 Stanja kredita na predplačniškem računu ni mogoče pridobiti
- 2406 = Domena/storitev ni bila najdena
- 2409 Obnovitev storitve ni uspela
Response Data
- service_id = ID storitve
- name = Ime domene
- date_from = Datum veljavnosti storitve
- date_to = Datum poteka storitve
- fakt_order_num = Številka naročila za podaljšanje storitve
- currency = Valuta predplačniškega računa
- price = Cena podaljšanja
- credit = Stanje predplačniškega računa po podaljšanju
Templates
JSON request:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "wgp-domain-renew",
"clTRID": "your ID",
"data": {
"service_id": "service ID"
}
}
}
JSON response (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "wgp-domain-renew",
"data": {
"service_id":"service ID",
"domain":"domain_name.tld",
"date_from":"YYYY-MM-DD",
"date_to":"YYYY-MM-DD",
"fakt_order_num":"Order nr.",
"currency":"Currency code",
"price": Amount,
"credit":"Credit account balance"
}
}
}
wgp-domain-delete
Use the wgp-domain-delete command to delete a domain from the WEDOS Protection service.
Parameters
- service_id = ID storitve (obvezno)
- force = Vsiljena izbrisa ne glede na zapise A/AAAA domene (neobvezno, če obstaja žeton za prepis zapisov DNS)
Return values
- 1000 OK
- 2100 Manjka obvezni parameter
- 2274 = Notranja napaka – manjka parameter user_id
- 2292 = Domena v tem uporabniškem računu ni bila najdena
- 2400 Notranja napaka
- 2410 Storitev ni najdena
- 2411 Žeton za prepis DNS ni na voljo
- 2412 = Zahteva API za prepis DNS ni uspela
- 2413 Zahteva ni uspela, WGP nima dovoljenja za posodobitev DNS
- 2414 WGP nima žetona in uporabnik v WAPI ni nastavil zastavice force
Response Data
- domain = ime domene
- domain_id = ID domene
- wedos_client_id = ID odjemalca
- service_id = ID storitve
- service_type = vrsta storitve
- wdns_data = polje posodobitev IP
Templates
JSON request:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "wgp-domain-delete",
"clTRID": "your ID",
"data": {
"service_id": "service ID",
"force": true (forces delete without updating DNS) | false (restores original DNS if able)
}
}
}
JSON response (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "wgp-domain-delete",
"data":{
"domain":"domain_name.tld",
"domain_id": id,
"wedos_client_id":"id",
"service_id":id,
"service_type":"hosting_wedos_protection",
"wdns_data":{
"domain":"domain_name.tld",
"rows_a":{
"rem":{
"removed A record ID":{
"name":"removed A record name",
"ttl":"removed A record TTL",
"rdtype":"A",
"rdata":"removed A record IP"
}
},
"add":{
"added A record ID":{
"name":"added A record name",
"ttl":"added A record TTL",
"rdtype":"A",
"rdata":"added A record IP"
}
},
"stay":[ "list of unchanged addresses" ]
},
"rows_aaaa":
"rem":{
"removed AAAA record ID":{
"name":"removed AAAA record name",
"ttl":"removed AAAA record TTL",
"rdtype":"AAAA",
"rdata":"removed AAAA record IP"
}
},
"add":{
"added AAAA record ID":{
"name":"added AAAA record name",
"ttl":"added AAAA record TTL",
"rdtype":"AAAA",
"rdata":"added AAAA record IP"
}
},
"stay":[ "list of unchanged addresses" ]
}
}
}
}
}
wgp-domain-delete-order
Use the wgp-domain-delete command to delete a domain order from the WEDOS Protection service. This is useful for deleting services which failed during creation.
This request will not delete existing services. For those, use wgp-domain-delete.
Parameters
- domain = ime domene (obvezno)
Return values
- 1000 OK
- 2100 Manjka obvezni parameter
- 2274 = Notranja napaka – manjka parameter user_id
- 2292 = Domena v tem uporabniškem računu ni bila najdena
- 2400 Notranja napaka
- 2410 Storitev ni najdena
- 2421 = Storitev WGP obstaja, domena ne bo izbrisana
Response Data
- domain = ime domene
- domain_id = ID domene
- wedos_client_id = ID odjemalca
Templates
JSON request:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "wgp-domain-delete-order",
"clTRID": "your ID",
"data": {
"domain": "domain_name.tld"
}
}
}
JSON response (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "wgp-domain-delete-order",
"data":{
"domain":"domain_name.tld",
"domain_id": id,
"wedos_client_id":"id"WGP service exists, the domain will not be deleted
}
}
}
JSON response (Error – WEDOS Protection service already exists):
{
"response": {
"code": 2421,
"result": "WGP service exists, the domain will not be deleted",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "wgp-domain-delete-order"
}
}
wgp-domain-update-subscription
Use the wgp-domain-update-subscription request to change the plan or billing period of the WEDOS Protection service.
Parameters
- service_id = ID storitve (obvezno)
- new_variant_id = service plan (required) – 1 = Free, 2 = Advanced, 3 = Expert
- new_period_id = obračunsko obdobje (obvezno) – 1 = mesečno, 4 = letno
Return Values
- 1000 OK
- 2100 Manjka obvezni parameter
- 2101 Parametri se ne ujemajo
- 2203 = Neveljaven period_id
- 2273 = Neveljavna različica
- 2293 = vrednosti kredita ni mogoče pridobiti
- 2294 = cene storitve ni mogoče pridobiti
- 2279 = predplačniški račun je zaklenjen
- 2281 = neaktiven predplačniški račun
- 2282 = plačilo z valuto kredita ni mogoče
- 2283 = neveljaven znesek ali premalo preostalega kredita
- 2284 = neveljavni podatki kontakta predplačniškega računa
- 2285 = neveljavna fakturacija DDV
- 2286 = predplačniški račun – neznana koda odgovora
- 2400 = Notranja napaka WGP
- 2406 = Domena/storitev ni bila najdena
- 2408 Manjka variant_id ali period_id
Response Data
- domain = ime domene
- domain_id = ID domene
- wedos_client_id = ID odjemalca
- service_id = ID storitve
- service_type = vrsta storitve
- variant_id = ID paketa storitve
- period_id = ID obračunskega obdobja
- dirty = potrditveno polje za posodobitev (0 = enako kot prej, 1 = spremenjeno)
Templates
JSON request:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "wgp-domain-update-subscription",
"clTRID": "your ID",
"data": {
"service_id": "service ID",
"new_variant_id": "1, 2, or 3",
"new_period_id": "1, or 4"
}
}
}
JSON response (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "wgp-domain-update-subscription",
"data":{
"domain": "domain_name.tld",
"domain_id": domain ID,
"wedos_client_id": "customer ID",
"service_id": service ID,
"service_type": "service type ID",
"variant_id": plan ID,
"period_id": billing period ID,
"dirty": 0|1
}
}
}
wgp-domain-create-retry
With the wgp-domain-create-retry command, you repeat the request to issue a certificate. You can use it to resolve the error_crt status returned by the wgp-domain-info command.
Parametry
- domain = ime domene (obvezno)
Return Values
- 1000 OK
- 2100 Manjka obvezni parameter
- 2292 = Domena v tem uporabniškem računu ni bila najdena
- 2400 Notranja napaka
- 4000 Notranja napaka
Response Data
- domain = Ime domene
- domain_id = ID domene v WGP
- wedos_client_id = ID odjemalca
Templates
JSON request:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "wgp-domain-create-retry",
"clTRID": "your ID",
"data": {
"domain": "nazev_domeny.tld"
}
}
}
JSON response (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "wgp-domain-create-retry",
"data":{
"domain": "domain_name.tld",
"domain_id": domain ID,
"wedos_client_id": "customer ID"
}
}
}
wgp-domain-cache-purge
Use wgp-domain-cache-purge to purge the WEDOS Protection domain cache.
Parameters
- service_id = ID storitve (obvezno)
- service_type = Vrsta storitve (neobvezno)
- values: hosting_wedos_protection (default), hosting_domain
- limiter_decay = Čas blokiranja v sekundah (neobvezno)
- default value 5
- limiter_reset = Prekliči omejevalnik (neobvezno)
- 0 (ne, privzeto), 1 (da)
Return Values
- 1000 OK
- 2100 Manjka obvezni parameter
- 2101 Parametri se ne ujemajo
- 2274 = notranja napaka – manjka user_id
- 2400 = notranja napaka – neznana povratna koda
- 2406 = domena/storitev ni bila najdena
- 2415 = dosežena vrednost omejevalnika
- 4000 = sistemska napaka
Response Data
- domain = Ime domene
- domain_id = ID domene
- domain_tld = TLD domene
- service_id = ID storitve
- wedos_client_id = ID odjemalca
- limiter_available_in = Čas v sekundah, do ponovne razpoložljivosti funkcije
Templates
JSON request:
{
"request": {
"user": "your@login.tld",
"auth": "generated authentication string",
"command": "wgp-domain-cache-purge",
"clTRID": "own ID code",
"data": {
"service_id": Service ID,
"service_type": "service type code (optional)",
"limiter_decay": limiter timeout (in seconds, optional),
"limiter_reset": 0|1 (optional)
}
}
}
JSON response (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF time",
"clTRID": "own ID code",
"svTRID": "server ID code",
"command": "wgp-domain-cache-purge",
"data":{
"domain":"domain_name.tld",
"domain_id": domain ID,
"domain_tld":"tld",
"wedos_client_id":"customer account ID"
}
}
}
wgp-domain-template-replicate
Use the wgp-domain-template-replicate request to change the target domain settings according to the selected template domain.
To create a template, follow the guide in the article Protection – Templates. Trenutno prek WAPI ni mogoče ustvarjati predlog.
Parameters
- service_id – service ID (required)
- template_domain_id – target template domain ID (required)
- service_type – service type (optional)
- values: hosting_domain, hosting_wedos_protection
Return values
- 1000 OK
- 2100 Manjka obvezni parameter
- 2101 Parametri se ne ujemajo
- 2400 = Notranja napaka WGP
- 2401 = Predloge ni mogoče uporabiti za domeno
- 2402 Neveljavna predloga domene
- 2403 = Predloga domene in uporabnik se ne ujemata
- 2404 = Predloga domene in paket domene se ne ujemata
- 2405 = Dosežena dnevna omejitev domen iz predlog
- 2406 = Domena/storitev ni bila najdena
- 2407 Domena predloge ni najdena
- 4000 Notranja napaka
Response Data
- domain = ime domene
- domain_id = ID domene
- service_id = ID storitve
- service_type = vrsta storitve
- template_domain_id = ID domene iz predloge
- replications_count = število izvedenih replikacij
- replications_limit = največje število replikacij
Templates
JSON request:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "wgp-domain-template-replicate",
"clTRID": "your ID",
"data": {
"service_id": service ID,
"template_domain_id": template domain ID,
"service_type": "hosting_domain, or hosting_wedos_protection (optional)"
}
}
}
JSON response (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "wgp-domain-template-replicate",
"data":{
"domain":"domain_namey.tld",
"domain_id": domain ID,
"service_id": service ID,
"service_type": "service type",
"template_domain_id": template domain ID,
"replications_count": replication count,
"replications_limit": replication limit
}
}
}
wgp-domain-templates-list
Use the wgp-domain-templates-list request to retrieve a list of template domains for the selected WEDOS Protection plan.
To create a template, follow the guide in the article Protection – Templates. Trenutno prek WAPI ni mogoče ustvarjati predlog.
Parameters
- variant_id = ID paketa (obvezno)
- per_page = Število zapisov na stran (privzeto = 15, vsi zapisi = -1) (neobvezno)
- page = Številka strani (privzeto = 1) (neobvezno)
- locale = Jezik (privzeto = en, podprta = cs, en) (neobvezno)
- search = Iskanje po stolpcih custom_name, name (neobvezno)
Return Values
- 1000 OK
- 2100 Manjka obvezni parameter
- 2400 = notranja napaka
- 4000 = notranja napaka
Response Data
- data = Seznam domen predlog
- id = ID domene iz predloge
- custom_name = Ime domene predloge (kot ga je nastavil uporabnik)
- name = Ime domene predloge (sistemsko)
- url = URL domene predloge
- first_page_url = URL prve strani seznama
- from = Začetek oštevilčenja strani
- last_page = Številka zadnje strani
- last_page_url = URL zadnje strani seznama
- links = Polje povezav oštevilčenja strani
- url = URL povezave
- label = Oznaka gumba
- active = null|1
- next_page_url = URL naslednje strani
- path = URL seznama domen predlog
- per_page = Število vnosov na stran
- prev_page_url = URL prejšnje strani
- to = Konec oštevilčenja strani
- total = Skupno število strani
Templates
JSON request:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "wgp-domain-templates-list",
"clTRID": "your ID",
"data": {
"variant_id": plan ID 1 = Free, 2 = Advanced, 3 = Expert,
"per_page": entries per page (optional),
"page": page nr. (optional),
"locale": "cs, or en (optional)",
"search": "Search by custom_name, name (optional)"
}
}
}
JSON response (OK):
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF timestamp",
"clTRID": "your ID",
"svTRID": "server ID",
"command": "wgp-domain-templates-list",
"data":{
[
{
"id": Template domain ID,
"custom_name":"termplate domain user name",
"name":"system-name.template",
"url":"https:\/\/template.domain.url\/system-name.template"
}
],
"first_page_url":"https:\/\/first.page.url",
"from": 1st page number,
"last_page": last page number,
"last_page_url":"https:\/\/last.page.url",
"links":[
{
"url": "https:\/\/page.url",
"label":"Button label",
"active": null|1
}
],
"next_page_url": "https:\/\/next.page.url",
"path":"https:\/\/list.url",
"per_page": entries per page,
"prev_page_url":"https:\/\/previous.page.url",
"to": last list item,
"total": total page count
}
}
}
wgp-services-list
With the wgp-services-list request, you can retrieve a list of domains with the WEDOS Protection service. You can filter by status.
The wgp-services-list only lists domains that have been added as services. For domains added in B2B mode, this only happens once the domain is fully set up. Until then, you can use the wgp-domain-info command to check that domain’s status.
Parameters
- status = stanje storitve (neobvezno)
Return Values
- 1000 OK
- 2206 Neveljavna zahteva – notranja napaka
Response Data
- ID = ID zapisa domene
- name = ime domene
- status = stanje storitve
- expiration = Datum poteka storitve WG
Templates
JSON request
{
"request": {
"user": "your@login.tld",
"auth": "generated authentication string",
"command": "wgp-services-list",
"clTRID": "own ID code",
"data": {
"status": "active, expired, disabled or deleted"
}
}
}
JSON response (OK)
{
"response": {
"code": 1000,
"result": "OK",
"timestamp": "UTF time",
"clTRID": "own ID code",
"svTRID": "server ID code",
"command":"wgp-services-list",
"data":{
"service ID in the system":{
"ID":"service ID in the system",
"domain":"domain_name.tld",
"status":"service status",
"expiration": "expiration date YYYY-MM-DD"
}
}
}