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 = nome di dominio (obbligatorio)
- 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 = periodo del servizio (obbligatorio) – 1 = mensile, 4 = annuale
- upstream_ips = array degli indirizzi IP di destinazione (facoltativo) – ulteriori informazioni sugli IP di destinazione sono disponibili in Protection – Upstream Targets article
- template_domain_id = ID del dominio template (facoltativo)
- mode = modalità del dominio (facoltativo)
- ns= usa i NS di WEDOS (predefinito); il sistema attiverà il dominio solo se verificherà correttamente che usa il DNS di WEDOS.
- cname= consente di usare i server DNS di un altro provider o di aggiungere sottodomini tramite record CNAME; la modalità per qualsiasi dominio di 3º livello o superiore è semprecname.
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. L’unica opzione predefinita e disponibile è mode for 3rd and higher level domains (subdomains) is cname.
Return Values
- 1000 = OK
- 1001 = Richiesta in sospeso
- 2101 = Parametri non corrispondenti
- 2202 = Formato del nome di dominio non valido o non supportato
- 2203 = period_id non valido
- 2206 = Richiesta non valida – errore interno
- 2272 = Formato dell’indirizzo IP non valido
- 2273 = Variante non valida
- 2274 = Errore interno – parametro user_id mancante
- 2275 = Errore interno – utente non trovato
- 2276 = TLD non supportato o livello massimo del dominio superato
- 2277 = Non è consentito anteporre esplicitamente www. al nome di dominio
- 2278 = Il nome di dominio non può essere utilizzato – esiste già un servizio con questo nome di dominio
- 2279 = Il conto di credito è bloccato
- 2280 = Conto di credito attivo
- 2281 = Conto di credito inattivo
- 2282 = Valuta del conto di credito non valida
- 2283 = Importo non valido o credito insufficiente
- 2284 = Errore nelle informazioni del conto di credito
- 2285 = Impostazioni IVA non corrette
- 2286 = Conto di credito – errore interno
- 2290 = Conto di credito – l’attività non è stata aggiunta al conto di credito
- 2291 = Il dominio esiste già per questo account cliente nell’API WGP
- 2293 = Impossibile ottenere il saldo del credito sul conto di credito
- 2294 = Impossibile ottenere il prezzo del servizio
- 2295 = Impossibile creare il dominio in WGP. Il pagamento è stato annullato.
- 2296 = Il movimento del conto di credito non può essere annullato
- 2400 = Errore WGP interno
- 2401 = Impossibile applicare il template al dominio
- 2402 = Template di dominio non valido
- 2403 = Il template di dominio non corrisponde all’utente
- 2404 = Il template di dominio non corrisponde al piano del dominio
- 2405 = Raggiunto il limite giornaliero di domini template
- 2416 = Modalità del dominio non valida
Response Data
- WGP_ID = ID del record di dominio WGP
- domain = nome di dominio
- order_num = numero d’ordine
- currency = valuta del conto di credito
- amount = prezzo del servizio
- acc_amount_before = saldo del conto di credito prima dell’attivazione del servizio
- acc_amount_current = saldo del conto di credito dopo l’attivazione del servizio
Notification Response Data
- WGP_ID = ID del record di dominio WGP
- domain = nome di dominio
- order_num = numero d’ordine
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 = nome di dominio (obbligatorio)
Return Values
- 1000 = OK
- 2100 = Parametro obbligatorio mancante
- 2101 = Parametri non corrispondenti
- 2202 = Formato del nome di dominio non valido o non supportato
- 2206 = Richiesta non valida – errore interno
- 2292 = Dominio non trovato per questo account cliente nell’API WGP
Response Data
- wgp = stato del dominio in WEDOS Protection; la state parameter has one of the following values, some of which can contain different data:
- pending_dns = risoluzione dei record DNS del dominio in corso
- processing = in attesa della configurazione del servizio
- stuck = in attesa dei requisiti software
- pending_txt = in attesa della verifica del record TXT (partial template)
- pending_ns = in attesa della configurazione dei nameserver (partial template for NS mode and CNAME mode)
- pending_dns_refresh = risoluzione DNS ripetuta, se il precedente pending_dns non ha trovato alcun record DNS
- pending_crt = in attesa del certificato Let’s Encrypt per WG
- active = dominio attivo (full template)
- service = stato del dominio nel sistema 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 servizio (obbligatorio)
Return Values
- 1000 = OK
- 2100 = Parametro obbligatorio mancante
- 2101 = Parametri non corrispondenti
- 2152 = Rinnovo del servizio bloccato
- 2206 = user_id mancante
- 2279 = Conto di credito bloccato
- 2281 = Conto di credito inattivo
- 2282 = Valuta del conto di credito non valida
- 2283 = Importo non valido o credito insufficiente
- 2284 = Errore nelle informazioni del conto di credito
- 2286 = Conto di credito – errore interno
- 2293 = Impossibile ottenere il saldo del credito sul conto di credito
- 2406 = Dominio/servizio non trovato
- 2409 = Rinnovo del servizio non riuscito
Response Data
- service_id = ID servizio
- name = Nome di dominio
- date_from = Data di validità del servizio
- date_to = Data di scadenza del servizio
- fakt_order_num = Numero d’ordine per il rinnovo del servizio
- currency = Valuta del conto di credito
- price = Prezzo di rinnovo
- credit = Saldo del conto di credito dopo il rinnovo
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 servizio (obbligatorio)
- force = Forza l’eliminazione indipendentemente dai record di dominio A/AAAA (facoltativo se esiste un token per riscrivere i record DNS)
Return values
- 1000 = OK
- 2100 = Parametro obbligatorio mancante
- 2274 = Errore interno – parametro user_id mancante
- 2292 = Dominio non trovato in questo account utente
- 2400 = Errore interno
- 2410 = Servizio non trovato
- 2411 = Token per la sovrascrittura del DNS non disponibile
- 2412 = Richiesta API per la riscrittura del DNS non riuscita
- 2413 = Richiesta non riuscita, WGP non ha l’autorizzazione ad aggiornare il DNS
- 2414 = WGP non ha un token e l’utente non ha impostato il flag force in WAPI
Response Data
- domain = nome di dominio
- domain_id = ID dominio
- wedos_client_id = ID cliente
- service_id = ID servizio
- service_type = tipo di servizio
- wdns_data = array degli aggiornamenti 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 = nome di dominio (obbligatorio)
Return values
- 1000 = OK
- 2100 = Parametro obbligatorio mancante
- 2274 = Errore interno – parametro user_id mancante
- 2292 = Dominio non trovato in questo account utente
- 2400 = Errore interno
- 2410 = Servizio non trovato
- 2421 = Il servizio WGP esiste, il dominio non verrà eliminato
Response Data
- domain = nome di dominio
- domain_id = ID dominio
- wedos_client_id = ID cliente
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 servizio (obbligatorio)
- new_variant_id = service plan (required) – 1 = Free, 2 = Advanced, 3 = Expert
- new_period_id = periodo di fatturazione (obbligatorio) – 1 = mensile, 4 = annuale
Return Values
- 1000 = OK
- 2100 = Parametro obbligatorio mancante
- 2101 = Parametri non corrispondenti
- 2203 = period_id non valido
- 2273 = Variante non valida
- 2293 = impossibile recuperare il valore del credito
- 2294 = impossibile recuperare il prezzo del servizio
- 2279 = conto di credito bloccato
- 2281 = conto di credito inattivo
- 2282 = impossibile pagare con la valuta del credito
- 2283 = importo non valido o credito residuo insufficiente
- 2284 = dati di contatto del conto di credito non validi
- 2285 = fatturazione IVA non valida
- 2286 = conto di credito – codice di risposta sconosciuto
- 2400 = Errore WGP interno
- 2406 = Dominio/servizio non trovato
- 2408 = variant_id o period_id mancante
Response Data
- domain = nome di dominio
- domain_id = ID dominio
- wedos_client_id = ID cliente
- service_id = ID servizio
- service_type = tipo di servizio
- variant_id = ID piano del servizio
- period_id = ID del periodo di fatturazione
- dirty = casella di aggiornamento (0 = come prima, 1 = modificato)
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 = nome di dominio (obbligatorio)
Return Values
- 1000 = OK
- 2100 = Parametro obbligatorio mancante
- 2292 = Dominio non trovato in questo account utente
- 2400 = Errore interno
- 4000 = Errore interno
Response Data
- domain = Nome di dominio
- domain_id = ID dominio in WGP
- wedos_client_id = ID client
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 del servizio (obbligatorio)
- service_type = Tipo di servizio (facoltativo)
- values: hosting_wedos_protection (default), hosting_domain
- limiter_decay = Tempo di blocco in secondi (facoltativo)
- default value 5
- limiter_reset = Annulla il limitatore (facoltativo)
- 0 (no, predefinito), 1 (sì)
Return Values
- 1000 = OK
- 2100 = Parametro obbligatorio mancante
- 2101 = Parametri non corrispondenti
- 2274 = errore interno – user_id mancante
- 2400 = errore interno – codice di ritorno sconosciuto
- 2406 = dominio/servizio non trovato
- 2415 = valore limite raggiunto
- 4000 = errore di sistema
Response Data
- domain = Nome di dominio
- domain_id = ID dominio
- domain_tld = TLD del dominio
- service_id = ID del servizio
- wedos_client_id = ID client
- limiter_available_in = Tempo in secondi prima che la funzione torni disponibile
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. Al momento non è possibile creare template tramite WAPI.
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 = Parametro obbligatorio mancante
- 2101 = Parametri non corrispondenti
- 2400 = Errore WGP interno
- 2401 = Impossibile applicare il template al dominio
- 2402 = Template di dominio non valido
- 2403 = Il template di dominio non corrisponde all’utente
- 2404 = Il template di dominio non corrisponde al piano del dominio
- 2405 = Raggiunto il limite giornaliero di domini template
- 2406 = Dominio/servizio non trovato
- 2407 = Dominio template non trovato
- 4000 = Errore interno
Response Data
- domain = nome di dominio
- domain_id = ID dominio
- service_id = ID servizio
- service_type = tipo di servizio
- template_domain_id = ID del dominio template
- replications_count = numero di repliche eseguite
- replications_limit = numero massimo di repliche
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. Al momento non è possibile creare template tramite WAPI.
Parameters
- variant_id = ID piano (obbligatorio)
- per_page = Numero di record per pagina (predefinito = 15, per ottenere tutti i record = -1) (facoltativo)
- page = Numero di pagina (predefinito = 1) (facoltativo)
- locale = Lingua (predefinita = en, supportate = cs, en) (facoltativo)
- search = Ricerca per le colonne custom_name, name (facoltativo)
Return Values
- 1000 = OK
- 2100 = Parametro obbligatorio mancante
- 2400 = errore interno
- 4000 = errore interno
Response Data
- data = Elenco dei domini template
- id = ID del dominio template
- custom_name = Nome del dominio template (impostato dall’utente)
- name = Nome del dominio template (di sistema)
- url = URL del dominio template
- first_page_url = URL della prima pagina dell’elenco
- from = Inizio della paginazione
- last_page = Numero dell’ultima pagina
- last_page_url = URL dell’ultima pagina dell’elenco
- links = Array dei link di paginazione
- url = URL del link
- label = Etichetta del pulsante
- active = null|1
- next_page_url = URL della pagina successiva
- path = URL dell’elenco dei domini template
- per_page = Numero di voci per pagina
- prev_page_url = URL della pagina precedente
- to = Fine della paginazione
- total = Numero totale di pagine
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 = stato del servizio (facoltativo)
Return Values
- 1000 = OK
- 2206 = Richiesta non valida – errore interno
Response Data
- ID = ID del record di dominio
- name = nome di dominio
- status = stato del servizio
- expiration = Data di scadenza del servizio 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"
}
}
}