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
151 services1063 interfaces
Plan services9 matching interfaces

Create a plan

createPlan

POST/PlanService/createPlan
Original definition
rpc createPlan(CreatePlanRequest) returns (CreatePlanResponse);

Request message

CreatePlanRequest

Create a plan

Request message · Field definitions
message CreatePlanRequest {
	string name = 1; // Plan name
	string description = 19; // Plan summary
	int64 clusterId = 2; // Cluster ID
	bytes trafficLimitJSON = 3; // Traffic limit
	bytes bandwidthLimitPerNodeJSON = 20; // Per-node bandwidth limit @link json:bit_size_capacity
	bool hasFullFeatures = 18; // Whether all permissions are granted
	bytes featuresJSON = 4; // Permissions in the format [code1, code2, ...]
	string priceType = 5; // Pricing type: traffic, bandwidth, period
	bytes trafficPriceJSON = 6; // Traffic pricing configuration
	bytes bandwidthPriceJSON = 10; // Bandwidth pricing configuration
	float monthlyPrice = 7; // Monthly price
	float seasonallyPrice = 8; // Quarterly price
	float yearlyPrice = 9; // Annual price
	int32 totalServers = 11; // Maximum number of websites
	int32 totalServerNamesPerServer = 12; // Maximum domains per website
	int32 totalServerNames = 13; // Maximum total number of domains
	int64 dailyRequests = 14; // Daily request allowance
	int64 monthlyRequests = 15; // Monthly request allowance
	int64 dailyWebsocketConnections = 16; // Daily WebSocket connection allowance
	int64 monthlyWebsocketConnections = 17; // Monthly WebSocket connection allowance
	bytes maxUploadSizeJSON = 21; // Maximum file upload size @link json:size_capacity
}

Response message

CreatePlanResponse
Response message · Field definitions
message CreatePlanResponse {
	int64 planId = 1;
}

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

Setup guide