Clientes

Los clientes son los clientes finales de una agencia. Cada zona puede ser de un cliente, y los miembros, las invitaciones y los tokens de API limitados a un cliente solo ven sus zonas. Estas rutas aún no tienen métodos en los SDK; los ejemplos usan curl.

#Listar clientes

GET /v1/orgs/{org}/clients

Lista los clientes de la organización con su número de zonas.

Rol necesario: readonly o superior. Un token limitado a un cliente solo ve el suyo.

#Parámetros

#Respuesta

• 200: Devuelve items, un array de Client.

#Errores

#Ejemplo

Aún sin método en los SDK: usa la petición HTTP.

curl "https://dash.openwaf.dev/v1/orgs/$OPENWAF_ORG/clients" \
  -H "Authorization: Bearer $OPENWAF_TOKEN"

{
  "items": [
    {
      "id": "a5614527-0ce6-43be-ad1d-d012b7394867",
      "org_id": "1e7c9a3b-5d2f-4b8a-9c6e-0f2a4b6c8d1e",
      "name": "example.com",
      "contact_email": "[email protected]",
      "note": "Managed by the platform team",
      "zone_count": 128,
      "created_at": "2026-10-27T09:30:00Z",
      "updated_at": "2026-10-27T09:30:00Z"
    }
  ]
}

#Crear un cliente

POST /v1/orgs/{org}/clients

Crea un cliente. name es obligatorio y único en la organización (sin distinguir mayúsculas).

Rol necesario: tech o superior. De toda la organización.

#Parámetros

#Cuerpo de la petición

Tipo de contenido application/json. Esquema: ClientInput.

#Respuesta

• 201: Creado. Devuelve Client.

#Errores

#Ejemplo

Aún sin método en los SDK: usa la petición HTTP.

curl -X POST "https://dash.openwaf.dev/v1/orgs/$OPENWAF_ORG/clients" \
  -H "Authorization: Bearer $OPENWAF_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
    "name": "Acme Retail",
    "contact_email": "[email protected]"
  }'

{
  "id": "a5614527-0ce6-43be-ad1d-d012b7394867",
  "org_id": "1e7c9a3b-5d2f-4b8a-9c6e-0f2a4b6c8d1e",
  "name": "example.com",
  "contact_email": "[email protected]",
  "note": "Managed by the platform team",
  "zone_count": 128,
  "created_at": "2026-10-27T09:30:00Z",
  "updated_at": "2026-10-27T09:30:00Z"
}

#Ver un cliente

GET /v1/orgs/{org}/clients/{client}

Devuelve un cliente.

Rol necesario: readonly o superior.

#Parámetros

#Respuesta

• 200: Devuelve Client.

#Errores

#Ejemplo

Aún sin método en los SDK: usa la petición HTTP.

curl "https://dash.openwaf.dev/v1/orgs/$OPENWAF_ORG/clients/7c1e3a5d-9b2f-4d6a-8e0c-2f4a6c8e0b1d" \
  -H "Authorization: Bearer $OPENWAF_TOKEN"

{
  "id": "a5614527-0ce6-43be-ad1d-d012b7394867",
  "org_id": "1e7c9a3b-5d2f-4b8a-9c6e-0f2a4b6c8d1e",
  "name": "example.com",
  "contact_email": "[email protected]",
  "note": "Managed by the platform team",
  "zone_count": 128,
  "created_at": "2026-10-27T09:30:00Z",
  "updated_at": "2026-10-27T09:30:00Z"
}

#Modificar un cliente

PATCH /v1/orgs/{org}/clients/{client}

Cambia el nombre, el correo de contacto o la nota de un cliente. Los campos ausentes conservan su valor.

Rol necesario: admin o superior. De toda la organización.

#Parámetros

#Cuerpo de la petición

Tipo de contenido application/json. Esquema: ClientInput.

#Respuesta

• 200: Devuelve Client.

#Errores

#Ejemplo

Aún sin método en los SDK: usa la petición HTTP.

curl -X PATCH "https://dash.openwaf.dev/v1/orgs/$OPENWAF_ORG/clients/7c1e3a5d-9b2f-4d6a-8e0c-2f4a6c8e0b1d" \
  -H "Authorization: Bearer $OPENWAF_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
    "note": "Renewal in March"
  }'

{
  "id": "a5614527-0ce6-43be-ad1d-d012b7394867",
  "org_id": "1e7c9a3b-5d2f-4b8a-9c6e-0f2a4b6c8d1e",
  "name": "example.com",
  "contact_email": "[email protected]",
  "note": "Managed by the platform team",
  "zone_count": 128,
  "created_at": "2026-10-27T09:30:00Z",
  "updated_at": "2026-10-27T09:30:00Z"
}

#Borrar un cliente

DELETE /v1/orgs/{org}/clients/{client}

Borra un cliente sin zonas. Antes hay que mover sus zonas a otro cliente (o a ninguno) con Asignar el cliente de una zona, o borrarlas.

Rol necesario: admin o superior. De toda la organización.

#Parámetros

#Respuesta

• 204: Borrado. Sin cuerpo.

#Errores

#Ejemplo

Aún sin método en los SDK: usa la petición HTTP.

curl -X DELETE "https://dash.openwaf.dev/v1/orgs/$OPENWAF_ORG/clients/7c1e3a5d-9b2f-4d6a-8e0c-2f4a6c8e0b1d" \
  -H "Authorization: Bearer $OPENWAF_TOKEN"

#Asignar el cliente de una zona

PATCH /v1/orgs/{org}/zones/{zone}

Asigna una zona a un cliente, o a ninguno con null. El cliente forma parte de la configuración de la zona, así que el cambio crea una versión.

Rol necesario: tech o superior. De toda la organización.

Controles de cambio: dry_run · If-Match (opcional) · X-Change-Reason (obligatorio)

#Parámetros

#Cuerpo de la petición

Tipo de contenido application/json.

#Respuesta

• 200: Zona modificada (con X-Config-Version y ETag) o, con dry_run, el plan (Applied). Devuelve Zone o Applied.

Cabeceras de la respuesta: ETag, X-Config-Version.

#Errores

#Ejemplo

Aún sin método en los SDK: usa la petición HTTP.

curl -X PATCH "https://dash.openwaf.dev/v1/orgs/$OPENWAF_ORG/zones/6f1d2c3b-8a4e-4b7d-9c21-5e3f7a8b9c0d" \
  -H "Authorization: Bearer $OPENWAF_TOKEN" \
  -H "X-Change-Reason: Move the zone to its client" \
  -H 'If-Match: "12"' \
  -H "Content-Type: application/json" \
  --data '{
    "client_id": "7c1e3a5d-9b2f-4d6a-8e0c-2f4a6c8e0b1d"
  }'

{
  "id": "6f1d2c3b-8a4e-4b7d-9c21-5e3f7a8b9c0d",
  "org_id": "1e7c9a3b-5d2f-4b8a-9c6e-0f2a4b6c8d1e",
  "name": "example.com",
  "status": "active",
  "dns_mode": "delegated",
  "ns_pair": [
    "ns1.example-dns.net",
    "ns2.example-dns.net"
  ],
  "delegation_checked_at": "2026-10-27T09:00:00Z",
  "activated_at": "2026-03-02T11:40:00Z",
  "config_version": 12,
  "proxied_names": 3,
  "client_id": null,
  "created_at": "2026-03-02T10:20:00Z",
  "updated_at": "2026-10-27T09:00:00Z"
}