GreenProxyDocs
Sign in

Documentation

Guides for running GreenProxy and a reference for the REST API at api.greenproxy.cfd.

Start

Add a domain and get it served.

Getting startedThis guide takes a domain from "registered elsewhere" to "served and protected by GreenProxy" in five steps.

DNS

Records, wildcards, nameservers and registrars.

DNSGreenProxy runs authoritative DNS for every pending_ns and active domain. Nameservers serve from memory and pick up changes within about 15 seconds; if the control plane is unavailable they keep answering from the…

Proxy & SSL

Proxied records, certificates, caching and origin protection.

Proxy and SSLA proxied record sends visitors to the GreenProxy edge, which terminates TLS, applies your security and caching rules, and forwards the request to your server (the origin).

Security

Firewall, WAF, rate limiting and bot protection.

Security: firewall, WAF, rate limiting and bot protectionEvery request to a proxied hostname passes through these layers at the edge, in this order. A layer that blocks or challenges stops the request.

Account

Team access, alerts, webhooks and log delivery.

Team and accessGive colleagues access to your account without sharing credentials. Each person signs in with their own account, their own password and their own two-factor authentication, and acts on yours with the role you assign.
Alerts and webhooksKnow about attacks, outages and account activity as they happen, and ship your security data to the tools you already use.

Connect

Servers and applications that join the platform.

ConnectConnect lets your own applications and servers manage their domains on the platform — register themselves as origins, create records, request wildcard certificates, switch protection — with your approval, instead of…
cPanel / WHMA cPanel/WHM server can join through Connect like any other server. The agent on it then carries out cPanel operations locally on your behalf, so you can put cPanel sites behind the edge from the panel: create or…

API

The REST API, authentication and the endpoint reference.

GreenProxy APIEverything the GreenProxy panel does is available through a JSON REST API. The complete reference — every operation with its parameters, schemas, errors, token scope and examples — is the OpenAPI 3.1 document:
API referenceEvery REST endpoint by tag: parameters, request and response schemas, authentication and examples.
API tokens and authenticationEvery API request carries Authorization: Bearer <credential>. There are two kinds of credential: