WAFGOPreparing your page
Setup guide

API documentation

DEVELOPER RESOURCES · API REFERENCE

Explore WAFGO API services, request paths and message definitions. Browse by permission role to find the parameters and response structures for your integration.

Download JSON documentation
69 services354 interfaces

References

HTTPS protocol configuration

json:https_protocol

Original definition
# HTTPS protocol configuration

## Definition
~~~json
{
	"isOn": "Whether enabled",
  	"listen": [
      {
		"protocol": "Protocol",
		"host": "Host address, usually empty",
		"portRange": "Port or port range"
	  },
	  ...
	],
  	"sslPolicyRef": {
	  "isOn": "Enable the SSL policy",
	  "sslPolicyId": "SSL policy ID"
	}
}
~~~

Create the `SSL policy ID` through `/SSLPolicyService/createSSLPolicy`.

## Examples

### Listen on port 443
~~~json
{
  "isOn": true,
  "listen": [
    {
      "protocol": "https",
      "host": "",
      "portRange": "443"
	}
  ],
  "sslPolicyRef": {
    "isOn": true,
    "sslPolicyId": 123
  }
}
~~~

The SSL policy ID `123` is created through `/SSLPolicyService/createSSLPolicy`.

### Listen on ports 443 and 8443
~~~json
{
  "isOn": true,
  "listen": [
    {
      "protocol": "https",
      "portRange": "443"
	},
    {
      "protocol": "https",
      "portRange": "8443"
	}
  ],
  "sslPolicyRef": {
    "isOn": true,
    "sslPolicyId": 123
  }
}
~~~

The SSL policy ID `123` is created through `/SSLPolicyService/createSSLPolicy`.

Descriptions and comments follow your language. Request paths, method names, field names and types match the original API definitions.

Setup guide