WAPI – WEDOS Protection (WGP)

Este artículo ofrece información sobre los siguientes comandos:

• wgp-domain-create – añade un dominio a WEDOS Protection
• wgp-domain-info – muestra la información del dominio en WEDOS Protection
• wgp-domain-renew – renueva el servicio
• wgp-domain-delete – cancela el servicio
• wgp-domain-update-subscription – cambia el plan de suscripción
• wgp-domain-create-retry – resuelve algunos errores
• wgp-domain-cache-purge – purga la caché de WP
• wgp-domain-template-replicate – replica una plantilla en un dominio existente
• wgp-domain-templates-list – lista de dominios plantilla
• wgp-services-list – lista de dominios de WEDOS Protection

---

wgp-domain-create

Utilice la wgp-domain-create solicitud para crear un registro de dominio en WEDOS Protection. Esta solicitud es asíncrona y se comunica mediante notificaciones ⧉.

Parámetros

• dominio = nombre de dominio (obligatorio)
• variant_id = plan de servicio (obligatorio) – 1 = Start, 2 = Advanced, 3 = Expert (encontrará los planes y sus precios en la página del producto ⧉)
• period_id = periodo de servicio (obligatorio) – 1 = mensual, 4 = anual
• upstream_ips = array de direcciones IP de destino (opcional) – encontrará más información sobre las IP de destino en el Protection – Destinos upstream artículo
• template_domain_id = ID del dominio plantilla (opcional)
• modo = modo del dominio (opcional)
  • ns = usa los NS de WEDOS (predeterminado); el sistema activará el dominio solo si comprueba correctamente que utiliza WEDOS DNS.
  • cname = permite utilizar los servidores DNS de otro proveedor o añadir subdominios mediante un registro CNAME; el modo para cualquier dominio de tercer nivel o superior es siempre cname.

Valores devueltos

• 1000 = OK
• 1001 = Solicitud pendiente
• 2101 = Los parámetros no coinciden
• 2202 = Formato de nombre de dominio no válido o no admitido
• 2203 = period_id no válido
• 2206 = Solicitud no válida – error interno
• 2272 = Formato de dirección IP no válido
• 2273 = Variante no válida
• 2274 = Error interno – falta el parámetro user_id
• 2275 = Error interno – usuario no encontrado
• 2276 = TLD no admitido o nivel máximo de dominio superado
• 2277 = No se permite anteponer explícitamente www. al nombre de dominio
• 2278 = No se puede usar el nombre de dominio – ya existe un servicio con este nombre de dominio
• 2279 = La cuenta de crédito está bloqueada
• 2280 = Cuenta de crédito activa
• 2281 = Cuenta de crédito inactiva
• 2282 = Moneda de la cuenta de crédito no válida
• 2283 = Importe no válido o crédito insuficiente
• 2284 = Error en los datos de la cuenta de crédito
• 2285 = Configuración de IVA incorrecta
• 2286 = Cuenta de crédito – error interno
• 2290 = Cuenta de crédito – el movimiento no se ha añadido a la cuenta de crédito
• 2291 = El dominio ya existe para esta cuenta de cliente en la API de WGP
• 2293 = No se puede obtener el saldo de la cuenta de crédito
• 2294 = No se puede obtener el precio del servicio
• 2295 = No se puede crear el dominio en WGP. El pago se ha cancelado.
• 2296 = No se puede cancelar el movimiento de la cuenta de crédito
• 2400 = Error interno de WGP
• 2401 = No se puede aplicar la plantilla al dominio
• 2402 = Dominio plantilla no válido
• 2403 = El dominio plantilla y el usuario no coinciden
• 2404 = El dominio plantilla y el plan del dominio no coinciden
• 2405 = Límite diario de dominios plantilla alcanzado
• 2416 = Modo de dominio no válido

Datos de respuesta

• WGP_ID = ID del registro de dominio en WGP
• dominio = nombre de dominio
• order_num = número de pedido
• moneda = moneda de la cuenta de crédito
• importe = precio del servicio
• acc_amount_before = saldo de la cuenta de crédito antes de activar el servicio
• acc_amount_current = saldo de la cuenta de crédito después de activar el servicio

Datos de respuesta de la notificación

• WGP_ID = ID del registro de dominio en WGP
• dominio = nombre de dominio
• order_num = número de pedido

Plantillas

Solicitud JSON:

{
  "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 = Start, 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)"
    }
  }
}

Respuesta JSON (solicitud pendiente):

{
  "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"
    }
  } 
}

Notificación JSON tras completar la configuración:

{
  "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

Utilice la wgp-domain-info solicitud para mostrar la información de estado del dominio en el servicio WEDOS Protection.

Parámetros

• dominio = nombre de dominio (obligatorio)

Valores devueltos

• 1000 = OK
• 2100 = Falta un parámetro obligatorio
• 2101 = Los parámetros no coinciden
• 2202 = Formato de nombre de dominio no válido o no admitido
• 2206 = Solicitud no válida – error interno
• 2292 = Dominio no encontrado para esta cuenta de cliente en la API de WGP

Datos de respuesta

• wgp = estado del dominio en WEDOS Protection; el parámetro state tiene uno de los siguientes valores, algunos de los cuales pueden contener datos distintos:
  • pending_dns = resolución de los registros DNS del dominio en curso
  • procesando = esperando la configuración del servicio
  • atascado = esperando los requisitos de software
  • pending_txt = esperando la verificación del registro TXT (plantilla parcial)
  • pending_ns = esperando la configuración de los servidores de nombres (plantilla parcial para el modo NS y modo CNAME)
  • pending_dns_refresh = resolución DNS repetida, si el pending_dns anterior no encontró ningún registro DNS
  • pending_crt = esperando el certificado de Let’s Encrypt para WG
  • activo = dominio activo (plantilla completa)
• servicio = estado del dominio en el sistema de WEDOS

Encontrará información más detallada sobre los datos devueltos en la plantilla.

Plantillas

Solicitud JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "generated authentication string",
    "command": "wgp-domain-info",
    "clTRID": "own ID code",
    "data": {
      "domain": "domain_name.tld"
    }
  }
}

Respuesta JSON (OK, estado activo):

{
  "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"
      }
    }
  }
}

Datos JSON (OK, estado 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"
        }
    }
}

Datos JSON (OK, estado pending_ns en ns modo):

{
    ...
    "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"
        }
    }
}

Datos JSON (OK, estado pending_ns en cname modo; crt_name y cname son los nombres y valores de los registros que el usuario debe configurar en su proveedor de DNS):

{
    ...
    "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

Utilice la wgp-domain-renew solicitud para prolongar el dominio en el servicio WEDOS Protection por otro periodo.

Parámetros

• service_id = ID del servicio (obligatorio)

Valores devueltos

• 1000 = OK
• 2100 = Falta un parámetro obligatorio
• 2101 = Los parámetros no coinciden
• 2152 = Renovación del servicio bloqueada
• 2206 = Falta user_id
• 2279 = Cuenta de crédito bloqueada
• 2281 = Cuenta de crédito inactiva
• 2282 = Moneda de la cuenta de crédito no válida
• 2283 = Importe no válido o crédito insuficiente
• 2284 = Error en los datos de la cuenta de crédito
• 2286 = Cuenta de crédito – error interno
• 2293 = No se puede obtener el saldo de la cuenta de crédito
• 2406 = Dominio/servicio no encontrado
• 2409 = Error al renovar el servicio

Datos de respuesta

• service_id = ID del servicio
• name = Nombre de dominio
• date_from = Fecha de validez del servicio
• date_to = Fecha de caducidad del servicio
• fakt_order_num = Número de pedido de la renovación del servicio
• moneda = Moneda de la cuenta de crédito
• price = Precio de la renovación
• crédito = Saldo de la cuenta de crédito tras la renovación

Plantillas

Solicitud JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-renew",
    "clTRID": "your ID",
    "data": {
      "service_id": "service ID"
    }
  }
}

Respuesta JSON (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

Utilice la wgp-domain-delete comando para eliminar un dominio del servicio WEDOS Protection.

Parámetros

• service_id = ID del servicio (obligatorio)
• force = Forzar la eliminación independientemente de los registros A/AAAA del dominio (opcional si existe un token para reescribir los registros DNS)

Valores devueltos

• 1000 = OK
• 2100 = Falta un parámetro obligatorio
• 2274 = Error interno – falta el parámetro user_id
• 2292 = Dominio no encontrado en esta cuenta de usuario
• 2400 = Error interno
• 2410 = Servicio no encontrado
• 2411 = Token para reescribir el DNS no disponible
• 2412 = Error en la solicitud a la API para reescribir el DNS
• 2413 = La solicitud ha fallado, WGP no tiene permiso para actualizar el DNS
• 2414 = WGP no tiene token y el usuario no ha establecido el parámetro force en WAPI

Datos de respuesta

• dominio = nombre de dominio
• domain_id = ID del dominio
• wedos_client_id = ID del cliente
• service_id = ID del servicio
• service_type = tipo de servicio
• wdns_data = array de actualizaciones de IP

Plantillas

Solicitud JSON:

{
  "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)
    }
  }
}

Respuesta JSON (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

Utilice la wgp-domain-delete comando para eliminar un pedido de dominio del servicio WEDOS Protection. Resulta útil para eliminar servicios que han fallado durante su creación.

Esta solicitud no elimina los servicios existentes. Para ello, utilice wgp-domain-delete.

Parámetros

• dominio = nombre de dominio (obligatorio)

Valores devueltos

• 1000 = OK
• 2100 = Falta un parámetro obligatorio
• 2274 = Error interno – falta el parámetro user_id
• 2292 = Dominio no encontrado en esta cuenta de usuario
• 2400 = Error interno
• 2410 = Servicio no encontrado
• 2421 = El servicio WGP existe, el dominio no se eliminará

Datos de respuesta

• dominio = nombre de dominio
• domain_id = ID del dominio
• wedos_client_id = ID del cliente

Plantillas

Solicitud JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-delete-order",
    "clTRID": "your ID",
    "data": {
      "domain": "domain_name.tld"
    }
  }
}

Respuesta JSON (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
    }
  }
}

Respuesta JSON (Error – el servicio WEDOS Protection ya existe):

{
  "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

Utilice la wgp-domain-update-subscription solicitud para cambiar el plan o el periodo de facturación del servicio WEDOS Protection.

Parámetros

• service_id = ID del servicio (obligatorio)
• new_variant_id = plan de servicio (obligatorio) – 1 = Start, 2 = Advanced, 3 = Expert
• new_period_id = periodo de facturación (obligatorio) – 1 = mensual, 4 = anual

Valores devueltos

• 1000 = OK
• 2100 = Falta un parámetro obligatorio
• 2101 = Los parámetros no coinciden
• 2203 = period_id no válido
• 2273 = Variante no válida
• 2293 = no se puede obtener el valor del crédito
• 2294 = no se puede obtener el precio del servicio
• 2279 = cuenta de crédito bloqueada
• 2281 = cuenta de crédito inactiva
• 2282 = no se puede pagar con la moneda del crédito
• 2283 = importe no válido o crédito restante insuficiente
• 2284 = datos de contacto de la cuenta de crédito no válidos
• 2285 = facturación de IVA no válida
• 2286 = cuenta de crédito – código de respuesta desconocido
• 2400 = Error interno de WGP
• 2406 = Dominio/servicio no encontrado
• 2408 = Falta variant_id o period_id

Datos de respuesta

• dominio = nombre de dominio
• domain_id = ID del dominio
• wedos_client_id = ID del cliente
• service_id = ID del servicio
• service_type = tipo de servicio
• variant_id = ID del plan de servicio
• period_id = ID del periodo de facturación
• dirty = indicador de actualización (0 = igual que antes, 1 = modificado)

Plantillas

Solicitud JSON:

{
  "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"
    }
  }
}

Respuesta JSON (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

Con el comando wgp-domain-create-retry se repite la solicitud de emisión de un certificado. Puede utilizarlo para resolver el estado error_crt devuelto por el comando wgp-domain-info .

Parámetros

• dominio = nombre de dominio (obligatorio)

Valores devueltos

• 1000 = OK
• 2100 = Falta un parámetro obligatorio
• 2292 = Dominio no encontrado en esta cuenta de usuario
• 2400 = Error interno
• 4000 = Error interno

Datos de respuesta

• dominio = Nombre de dominio
• domain_id = ID del dominio en WGP
• wedos_client_id = ID del cliente

Plantillas

Solicitud JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-create-retry",
    "clTRID": "your ID",
    "data": {
      "domain": "nazev_domeny.tld"
    }
  }
}

Respuesta JSON (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

Utilice wgp-domain-cache-purge para purgar la caché del dominio en WEDOS Protection.

Parámetros

• service_id = ID del servicio (obligatorio)
• service_type = tipo de servicio (opcional)
  • valores: hosting_wedos_protection (predeterminado), hosting_domain
• limiter_decay = tiempo de bloqueo en segundos (opcional)
  • valor predeterminado 5
• limiter_reset = cancelar el limitador (opcional)
  • 0 (no, predeterminado), 1 (sí)

Valores devueltos

• 1000 = OK
• 2100 = Falta un parámetro obligatorio
• 2101 = Los parámetros no coinciden
• 2274 = error interno – falta user_id
• 2400 = error interno – código de retorno desconocido
• 2406 = dominio/servicio no encontrado
• 2415 = valor del limitador alcanzado
• 4000 = error del sistema

Datos de respuesta

• dominio = Nombre de dominio
• domain_id = ID del dominio
• domain_tld = TLD del dominio
• service_id = ID del servicio
• wedos_client_id = ID del cliente
• limiter_available_in = tiempo en segundos hasta que la función vuelva a estar disponible

Plantillas

Solicitud JSON:

{
  "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)
    }
  }
}

Respuesta JSON (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

Utilice la wgp-domain-template-replicate solicitud para cambiar la configuración del dominio de destino según el dominio plantilla seleccionado.

Parámetros

• service_id – ID del servicio (obligatorio)
• template_domain_id – ID del dominio plantilla de destino (obligatorio)
• service_type – tipo de servicio (opcional)
  • valores: hosting_domain, hosting_wedos_protection

Valores devueltos

• 1000 = OK
• 2100 = Falta un parámetro obligatorio
• 2101 = Los parámetros no coinciden
• 2400 = Error interno de WGP
• 2401 = No se puede aplicar la plantilla al dominio
• 2402 = Dominio plantilla no válido
• 2403 = El dominio plantilla y el usuario no coinciden
• 2404 = El dominio plantilla y el plan del dominio no coinciden
• 2405 = Límite diario de dominios plantilla alcanzado
• 2406 = Dominio/servicio no encontrado
• 2407 = Dominio plantilla no encontrado
• 4000 = Error interno

Datos de respuesta

• dominio = nombre de dominio
• domain_id = ID del dominio
• service_id = ID del servicio
• service_type = tipo de servicio
• template_domain_id = ID del dominio plantilla
• replications_count = número de replicaciones realizadas
• replications_limit = número máximo de replicaciones

Plantillas

Solicitud JSON:

{
  "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)"
    }
  }
}

Respuesta JSON (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

Utilice la wgp-domain-templates-list solicitud para obtener la lista de dominios plantilla del plan de WEDOS Protection seleccionado.

Parámetros

• variant_id = ID del plan (obligatorio)
• per_page = número de registros por página (predeterminado = 15, todos los registros = -1) (opcional)
• página = número de página (predeterminado = 1) (opcional)
• locale = idioma (predeterminado = en, admitidos = cs, en) (opcional)
• search = búsqueda por las columnas custom_name, name (opcional)

Valores devueltos

• 1000 = OK
• 2100 = Falta un parámetro obligatorio
• 2400 = error interno
• 4000 = error interno

Datos de respuesta

• datos = lista de dominios plantilla
  • id = ID del dominio plantilla
  • custom_name = nombre del dominio plantilla (definido por el usuario)
  • name = nombre del dominio plantilla (del sistema)
  • url = URL del dominio plantilla
• first_page_url = URL de la primera página de la lista
• de = inicio de la paginación
• last_page = número de la última página
• last_page_url = URL de la última página de la lista
• enlaces = array de enlaces de paginación
  • url = URL del enlace
  • etiqueta = etiqueta del botón
  • activo = null|1
• next_page_url = URL de la página siguiente
• path = URL de la lista de dominios plantilla
• per_page = número de entradas por página
• prev_page_url = URL de la página anterior
• a = fin de la paginación
• total = número total de páginas

Plantillas

Solicitud JSON:

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wgp-domain-templates-list",
    "clTRID": "your ID",
    "data": {
      "variant_id": plan ID 1 = Start, 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)"
    }
  }
}

Respuesta JSON (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

Con el comando wgp-services-list puede obtener la lista de dominios con el servicio WEDOS Protection. Puede filtrar por estado.

Parámetros

• status = estado del servicio (opcional)

Valores devueltos

• 1000 = OK
• 2206 = Solicitud no válida – error interno

Datos de respuesta

• ID = ID del registro de dominio
• name = nombre de dominio
• status = estado del servicio
• caducidad = fecha de caducidad del servicio WG

Plantillas

Solicitud JSON

{
  "request": {
    "user": "your@login.tld",
    "auth": "generated authentication string",
    "command": "wgp-services-list",
    "clTRID": "own ID code",
    "data": {
      "status": "active, expired, disabled or deleted"
    }
  }
}

Respuesta JSON (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"
    }
  }
}