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
IP entry management13 matching interfaces

Create an IP entry

createIPItem

POST/IPItemService/createIPItem
Original definition
rpc createIPItem (CreateIPItemRequest) returns (CreateIPItemResponse);

Request message

CreateIPItemRequest

Create an IP entry

Request message · Field definitions
message CreateIPItemRequest {
	int64 ipListId = 1; // Parent IP list ID
	string value = 15; // Original IP value, such as a single IP, IP range or CIDR; when specified, ipFrom and ipTo are not required
	string ipFrom = 2; // Starting IP address
	string ipTo = 3; // Ending IP address (optional)
	int64 expiredAt = 4; // Expiration timestamp (optional)
	string reason = 5; // Reason for adding the entry (optional)
	string type = 6; // IP type: ipv4 or ipv6
	string eventLevel = 7; // Severity: debug, notice, warning, error, critical, fatal

	int64 nodeId = 8; // Optional: owner node ID
	int64 serverId = 9; // Optional: owner website ID

	int64 sourceNodeId = 10; // Optional: source node
	int64 sourceServerId = 11;  // Optional: source website ID
	int64 sourceHTTPFirewallPolicyId = 12; // Optional: source WAF policy ID
	int64 sourceHTTPFirewallRuleGroupId = 13; // Optional: source WAF rule group ID
	int64 sourceHTTPFirewallRuleSetId = 14; // Optional: source WAF rule set ID
}

Response message

CreateIPItemResponse
Response message · Field definitions
message CreateIPItemResponse {
	int64 ipItemId = 1;
}

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

Setup guide