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 = доменне ім’я (обов’язково)
- 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 = період послуги (обов’язково) – 1 = щомісяця, 4 = щороку
- upstream_ips = масив цільових IP-адрес (необов’язково) – докладніше про цільові IP-адреси див. у Protection – Upstream Targets article
- template_domain_id = ID домену-шаблону (необов’язково)
- mode = режим домену (необов’язково)
- ns= використовує NS WEDOS (за замовчуванням); система активує домен, лише якщо успішно перевірить, що він використовує DNS WEDOS.
- cname= дає змогу використовувати DNS-сервери іншого провайдера або додавати піддомени через CNAME-запис; режим для будь-якого домену 3-го або вищого рівня завждиcname.
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. Типовий і єдиний доступний mode for 3rd and higher level domains (subdomains) is cname.
Return Values
- 1000 = OK
- 1001 = Запит очікує на обробку
- 2101 = Невідповідність параметрів
- 2202 = Недійсний або непідтримуваний формат доменного імені
- 2203 = Недійсний period_id
- 2206 = Недійсний запит – внутрішня помилка
- 2272 = Недійсний формат IP-адреси
- 2273 = Недійсний варіант
- 2274 = Внутрішня помилка – відсутній параметр user_id
- 2275 = Внутрішня помилка – користувача не знайдено
- 2276 = Непідтримуваний TLD або перевищено максимальний рівень домену
- 2277 = Явне додавання www. перед доменним іменем не дозволено
- 2278 = Доменне ім’я використати неможливо – існує послуга з таким доменним іменем
- 2279 = Кредитний рахунок заблоковано
- 2280 = Кредитний рахунок активний
- 2281 = Неактивний кредитний рахунок
- 2282 = Недійсна валюта кредитного рахунку
- 2283 = Недійсна сума або недостатній кредит
- 2284 = Помилка інформації про кредитний рахунок
- 2285 = Некоректні налаштування ПДВ
- 2286 = Кредитний рахунок – внутрішня помилка
- 2290 = Кредитний рахунок – операцію не додано до кредитного рахунку
- 2291 = Домен для цього облікового запису клієнта вже існує в WGP API
- 2293 = Не вдалося отримати баланс кредиту на кредитному рахунку
- 2294 = Не вдалося отримати ціну послуги
- 2295 = Не вдалося створити домен у WGP. Платіж скасовано.
- 2296 = Операцію на кредитному рахунку неможливо скасувати
- 2400 = Внутрішня помилка WGP
- 2401 = Не вдалося застосувати шаблон до домену
- 2402 = Недійсний шаблон домену
- 2403 = Шаблон домену не відповідає користувачеві
- 2404 = Шаблон домену не відповідає тарифному плану домену
- 2405 = Досягнуто денний ліміт доменів за шаблоном
- 2416 = Недійсний режим домену
Response Data
- WGP_ID = ID запису домену у WGP
- domain = доменне ім’я
- order_num = номер замовлення
- currency = валюта кредитного рахунку
- amount = ціна послуги
- acc_amount_before = баланс кредитного рахунку перед активацією послуги
- acc_amount_current = баланс кредитного рахунку після активації послуги
Notification Response Data
- WGP_ID = ID запису домену у WGP
- domain = доменне ім’я
- order_num = номер замовлення
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 = доменне ім’я (обов’язково)
Return Values
- 1000 = OK
- 2100 = Відсутній обов’язковий параметр
- 2101 = Невідповідність параметрів
- 2202 = Недійсний або непідтримуваний формат доменного імені
- 2206 = Недійсний запит – внутрішня помилка
- 2292 = Домен для цього облікового запису клієнта в WGP API не знайдено
Response Data
- wgp = статус домену в WEDOS Protection; значення state parameter has one of the following values, some of which can contain different data:
- pending_dns = триває визначення DNS-записів домену
- processing = очікується налаштування послуги
- stuck = очікується виконання програмних вимог
- pending_txt = очікується підтвердження TXT-записом (partial template)
- pending_ns = очікується налаштування серверів імен (partial template for NS mode and CNAME mode)
- pending_dns_refresh = повторне визначення DNS, якщо попередній pending_dns не знайшов жодних DNS-записів
- pending_crt = очікується сертифікат Let’s Encrypt для WG
- active = домен активний (full template)
- service = статус домену в системі 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 послуги (обов’язково)
Return Values
- 1000 = OK
- 2100 = Відсутній обов’язковий параметр
- 2101 = Невідповідність параметрів
- 2152 = Продовження послуги заблоковано
- 2206 = Відсутній user_id
- 2279 = Кредитний рахунок заблоковано
- 2281 = Неактивний кредитний рахунок
- 2282 = Недійсна валюта кредитного рахунку
- 2283 = Недійсна сума або недостатній кредит
- 2284 = Помилка інформації про кредитний рахунок
- 2286 = Кредитний рахунок – внутрішня помилка
- 2293 = Не вдалося отримати баланс кредиту на кредитному рахунку
- 2406 = Домен/послугу не знайдено
- 2409 = Не вдалося продовжити послугу
Response Data
- service_id = ID послуги
- name = Доменне ім’я
- date_from = Дата дії послуги
- date_to = Дата завершення дії послуги
- fakt_order_num = Номер замовлення на продовження послуги
- currency = Валюта кредитного рахунку
- price = Ціна продовження
- credit = Баланс кредитного рахунку після продовження
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 послуги (обов’язково)
- force = Примусове видалення незалежно від записів A/AAAA домену (необов’язково, якщо існує токен для перезапису DNS-записів)
Return values
- 1000 = OK
- 2100 = Відсутній обов’язковий параметр
- 2274 = Внутрішня помилка – відсутній параметр user_id
- 2292 = Домен в цьому обліковому записі користувача не знайдено
- 2400 = Внутрішня помилка
- 2410 = Послугу не знайдено
- 2411 = Токен для перезапису DNS недоступний
- 2412 = Невдалий API-запит на перезапис DNS
- 2413 = Запит не вдався, WGP не має дозволу оновлювати DNS
- 2414 = WGP не має токена, а користувач не встановив у WAPI прапорець force
Response Data
- domain = доменне ім’я
- domain_id = ID домену
- wedos_client_id = ID клієнта
- service_id = ID послуги
- service_type = тип послуги
- wdns_data = масив оновлень 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 = доменне ім’я (обов’язково)
Return values
- 1000 = OK
- 2100 = Відсутній обов’язковий параметр
- 2274 = Внутрішня помилка – відсутній параметр user_id
- 2292 = Домен в цьому обліковому записі користувача не знайдено
- 2400 = Внутрішня помилка
- 2410 = Послугу не знайдено
- 2421 = Послуга WGP існує, домен не буде видалено
Response Data
- domain = доменне ім’я
- domain_id = ID домену
- wedos_client_id = ID клієнта
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 послуги (обов’язково)
- new_variant_id = service plan (required) – 1 = Free, 2 = Advanced, 3 = Expert
- new_period_id = період виставлення рахунків (обов’язково) – 1 = щомісяця, 4 = щороку
Return Values
- 1000 = OK
- 2100 = Відсутній обов’язковий параметр
- 2101 = Невідповідність параметрів
- 2203 = Недійсний period_id
- 2273 = Недійсний варіант
- 2293 = не вдалося отримати значення кредиту
- 2294 = не вдалося отримати ціну послуги
- 2279 = кредитний рахунок заблоковано
- 2281 = неактивний кредитний рахунок
- 2282 = не вдалося оплатити у валюті кредиту
- 2283 = недійсна сума або недостатній залишок кредиту
- 2284 = недійсні контактні дані кредитного рахунку
- 2285 = недійсна ставка ПДВ у рахунку-фактурі
- 2286 = кредитний рахунок – невідомий код відповіді
- 2400 = Внутрішня помилка WGP
- 2406 = Домен/послугу не знайдено
- 2408 = Відсутній variant_id або period_id
Response Data
- domain = доменне ім’я
- domain_id = ID домену
- wedos_client_id = ID клієнта
- service_id = ID послуги
- service_type = тип послуги
- variant_id = ID тарифного плану послуги
- period_id = ID періоду виставлення рахунків
- dirty = позначка оновлення (0 = як раніше, 1 = змінено)
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 = доменне ім’я (обов’язково)
Return Values
- 1000 = OK
- 2100 = Відсутній обов’язковий параметр
- 2292 = Домен в цьому обліковому записі користувача не знайдено
- 2400 = Внутрішня помилка
- 4000 = Внутрішня помилка
Response Data
- domain = Доменне ім’я
- domain_id = ID домену у WGP
- wedos_client_id = ID клієнта
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 послуги (обов’язково)
- service_type = Тип послуги (необов’язково)
- values: hosting_wedos_protection (default), hosting_domain
- limiter_decay = Час блокування в секундах (необов’язково)
- default value 5
- limiter_reset = Скасувати обмежувач (необов’язково)
- 0 (ні, за замовчуванням), 1 (так)
Return Values
- 1000 = OK
- 2100 = Відсутній обов’язковий параметр
- 2101 = Невідповідність параметрів
- 2274 = внутрішня помилка – відсутній user_id
- 2400 = внутрішня помилка – невідомий код повернення
- 2406 = домен/послугу не знайдено
- 2415 = досягнуто значення обмежувача
- 4000 = системна помилка
Response Data
- domain = Доменне ім’я
- domain_id = ID домену
- domain_tld = TLD домену
- service_id = ID послуги
- wedos_client_id = ID клієнта
- limiter_available_in = Час у секундах, через який функція знову стане доступною
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. Наразі створювати шаблони через 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 = Відсутній обов’язковий параметр
- 2101 = Невідповідність параметрів
- 2400 = Внутрішня помилка WGP
- 2401 = Не вдалося застосувати шаблон до домену
- 2402 = Недійсний шаблон домену
- 2403 = Шаблон домену не відповідає користувачеві
- 2404 = Шаблон домену не відповідає тарифному плану домену
- 2405 = Досягнуто денний ліміт доменів за шаблоном
- 2406 = Домен/послугу не знайдено
- 2407 = Домен-шаблон не знайдено
- 4000 = Внутрішня помилка
Response Data
- domain = доменне ім’я
- domain_id = ID домену
- service_id = ID послуги
- service_type = тип послуги
- template_domain_id = ID домену-шаблону
- replications_count = кількість виконаних реплікацій
- replications_limit = максимальна кількість реплікацій
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. Наразі створювати шаблони через WAPI неможливо.
Parameters
- variant_id = ID тарифного плану (обов’язково)
- per_page = Кількість записів на сторінці (за замовчуванням = 15, отримати всі записи = -1) (необов’язково)
- page = Номер сторінки (за замовчуванням = 1) (необов’язково)
- locale = Мова (за замовчуванням = en, підтримуються cs, en) (необов’язково)
- search = Пошук за стовпцями custom_name, name (необов’язково)
Return Values
- 1000 = OK
- 2100 = Відсутній обов’язковий параметр
- 2400 = внутрішня помилка
- 4000 = внутрішня помилка
Response Data
- data = Список доменів-шаблонів
- id = ID домену-шаблону
- custom_name = Назва домену-шаблону (задана користувачем)
- name = Назва домену-шаблону (системна)
- url = URL домену-шаблону
- first_page_url = URL першої сторінки списку
- from = Початок пагінації
- last_page = Номер останньої сторінки
- last_page_url = URL останньої сторінки списку
- links = Масив посилань пагінації
- url = URL посилання
- label = Текст кнопки
- active = null|1
- next_page_url = URL наступної сторінки
- path = URL списку доменів-шаблонів
- per_page = Кількість записів на сторінці
- prev_page_url = URL попередньої сторінки
- to = Кінець пагінації
- total = Загальна кількість сторінок
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 = статус послуги (необов’язково)
Return Values
- 1000 = OK
- 2206 = Недійсний запит – внутрішня помилка
Response Data
- ID = ID запису домену
- name = доменне ім’я
- status = статус послуги
- expiration = Дата завершення дії послуги 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"
}
}
}