REST API – Servicios de WEDOS.protection

GET /services

Devuelve la lista de los servicios WEDOS Global Protection independientes propios del usuario de OAuth2 conectado (creados directamente como servicio WGP, tabla hosting_wedos_protection).

Parámetros:

• status – opcional, query – filtro por un estado de servicio concreto (el valor no se valida contra la lista de códigos de estado)

Códigos de retorno:

• 1000 – OK

Datos de la respuesta: Un array de servicios; cada elemento contiene ID, name, status, expiration.

Ejemplo:

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

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

POST /services/{service_id}/cache/purge

Purga la caché de la CDN de un dominio conectado a WGP. Puede referirse tanto a un servicio WGP independiente como a un dominio con WGP como complemento (hosting_domain); el tipo de servicio se indica con el parámetro service_type .

Parámetros:

• service_id – obligatorio, path – ID local del servicio
• service_type – opcional – tipo de servicio, hosting_wedos_protection (predeterminado) o hosting_domain
• limiter_decay – opcional, número – tiempo en segundos durante el cual se limita la purga repetida; predeterminado 5
• limiter_reset – opcional, booleano – cancela el límite actual; predeterminado false

Códigos de retorno:

• 1000 – OK
• 2100 – falta un parámetro obligatorio
• 2101 – valor de parámetro no válido
• 2406 – dominio o servicio no encontrado
• 2415 – el limitador sigue activo: la purga no se puede repetir ahora mismo
• 3223 – el servicio pertenece a otra cuenta de cliente
• 2400 – error interno – código de retorno no registrado

Datos de la respuesta:

• domain – nombre de dominio
• domain_id – ID del dominio en WGP
• domain_tld – TLD del dominio
• service_id – ID del servicio
• wedos_client_id – ID del cliente en WGP
• limiter_available_in – dentro de cuántos segundos se puede volver a usar la función (documentado solo para el error 2415; sin embargo, la implementación actual no devuelve la parte data en caso de error, véanse las notas)

Ejemplo:

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

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

POST /services/{service_id}/renew

Renueva el servicio WGP por otro periodo de facturación.

Parámetros:

• service_id – obligatorio, path – ID del servicio

Códigos de retorno:

• 1000 – OK
• 2100 – falta un parámetro obligatorio
• 2101 – valor de parámetro no válido
• 2152 – la renovación no está permitida en el estado actual del servicio
• 2279 – la cuenta de prepago está bloqueada
• 2281 – la cuenta de prepago no está activa
• 2282 – no se puede pagar desde la cuenta de prepago en la moneda indicada
• 2283 – saldo insuficiente en la cuenta de prepago
• 2284 – error en los datos de contacto de la cuenta de prepago
• 2293 – no se puede obtener el saldo de crédito de la cuenta de prepago
• 2297 – no se puede determinar si la cuenta de prepago incluye IVA
• 2406 – servicio no encontrado
• 2409 – no se pudo renovar el servicio

Datos de la respuesta:

• service_id – ID del servicio
• name – nombre de dominio
• date_from, date_to – fechas de validez del nuevo periodo
• fakt_order_num – número de pedido de la renovación
• currency – moneda de la cuenta de prepago
• price – importe de la renovación
• credit – saldo de la cuenta de prepago después (null en los servicios FREE/TRIAL)

Ejemplo:

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

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

POST /services/{service_id}/template-replicate

Replica (aplica) la configuración de un dominio de plantilla a un dominio o servicio WGP existente.

Parámetros:

• service_id – obligatorio, path – ID del servicio al que se replica la configuración
• template_domain_id – obligatorio – ID del dominio de plantilla (véase GET /domains/templates)
• service_type – opcional – tipo de servicio, hosting_wedos_protection (predeterminado) o hosting_domain

Códigos de retorno:

• 1000 – OK
• 2100 – falta un parámetro obligatorio
• 2101 – valor de parámetro no válido
• 2401 – dominio no válido para la replicación
• 2402 – dominio de plantilla no válido
• 2403 – el usuario del dominio y el del dominio de plantilla no coinciden
• 2404 – el plan de suscripción del dominio y el del dominio de plantilla no coinciden
• 2405 – se ha alcanzado el límite diario de replicaciones
• 2406 – dominio o servicio no encontrado
• 2407 – dominio de plantilla no encontrado
• 2400 – error interno – código de retorno no registrado

Datos de la respuesta:

• domain – nombre de dominio
• domain_id – ID del dominio
• service_id – ID del servicio
• service_type – tipo de servicio
• template_domain_id – ID del dominio de plantilla utilizado
• replications_count – número de replicaciones realizadas hasta ahora
• replications_limit – número máximo de replicaciones permitidas

Ejemplo:

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

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

PATCH /services/{service_id}

Cambia la variante o el periodo de suscripción de un servicio WGP existente.

Parámetros:

• service_id – obligatorio, path – ID del servicio
• new_variant_id – opcional, número – nueva variante del servicio
• new_period_id – opcional, número – nuevo periodo de suscripción

Debe indicarse al menos uno de los parámetros new_variant_id/new_period_id .

Códigos de retorno:

• 1000 – OK
• 2100 – falta un parámetro obligatorio
• 2101 – valor de parámetro no válido
• 2203 – valor no válido de new_period_id
• 2273 – valor no válido de new_variant_id
• 2279 – la cuenta de prepago está bloqueada
• 2281 – la cuenta de prepago no está activa
• 2282 – no se puede pagar desde la cuenta de prepago en la moneda indicada
• 2283 – saldo insuficiente en la cuenta de prepago
• 2284 – error en los datos de contacto de la cuenta de prepago
• 2293 – no se puede obtener el saldo de crédito de la cuenta de prepago
• 2294 – no se puede obtener el precio del servicio
• 2406 – dominio o servicio no encontrado
• 2408 – parámetro new_variant_id o new_period_id no indicados (no se ha indicado ninguno)
• 2400 – error interno – código de retorno no registrado

Datos de la respuesta:

• domain – nombre de dominio
• domain_id – ID del dominio
• wedos_client_id – ID del cliente en WGP
• service_id – ID del servicio
• service_type – tipo de servicio
• variant_id – ID de la variante de servicio actual tras el cambio
• period_id – ID del periodo de suscripción actual tras el cambio
• dirty – indicador de si realmente se produjo un cambio (0 = sin cambios, 1 = cambiado)

Ejemplo:

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

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

DELETE /services/{service_id}

Elimina o cancela un servicio WGP a petición del cliente.

Parámetros:

• service_id – obligatorio, path – ID del servicio
• force – opcional, query, 0/1 – fuerza la eliminación incluso cuando WGP no dispone de token para reescribir el DNS (restaurar los registros A/AAAA a sus valores originales)

Códigos de retorno:

• 1000 – OK
• 2100 – falta un parámetro obligatorio
• 2292 – el dominio no se encontró en WGP para esta cuenta de cliente
• 2400 – error interno
• 2410 – servicio no encontrado
• 2411 – no hay ningún token disponible para reescribir el DNS
• 2412 – la solicitud a la API para reescribir el DNS ha fallado
• 2413 – no se puede ejecutar el comando, WGP no tiene permiso para manipular el DNS del dominio (se requiereforce=1 )
• 2414 – no existe ningún token para WGP y no se ha indicado el parámetro force .
• 3223 – el servicio pertenece a otra cuenta de cliente

Datos de la respuesta:

• domain – nombre de dominio
• domain_id – ID del dominio
• wedos_client_id – ID del cliente en WGP
• service_id – ID del servicio
• service_type – tipo de servicio
• wdns_data – array de los cambios realizados en los registros DNS (direcciones IP que dejan de resolverse a través de WGP tras su cancelación)

Ejemplo:

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

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