Getting started
Services and methods
Learn how WAFGO organizes its API and combines a service name, method name and HTTP endpoint into a request URL. Replace example addresses and parameters with your actual configuration.
What is a service?
APIs are grouped into services by function. Names usually end in Service: ServerService handles website operations, while HTTPAccessLogService handles access logs.
Use the service directory to find an API by function. Directory descriptions are translated for readability; requests must still use the original service identifier, not its translated display label.
ServerService
HTTPAccessLogService
APINodeServiceMethods within a service
A service can contain several methods, each representing a specific operation. For example, ServerService includes methods for creating websites, updating their basic settings and changing their groups.
Allowed roles can differ between methods. Check each method's roles and request message; sharing a service does not imply identical permissions or parameters.
- createServer
- Creates a website. The current definition allows administrators and platform users.
- updateServerBasic
- Updates a website's basic settings. The current definition allows administrators only.
- updateServerGroupIds
- Changes the groups assigned to a website. The current definition allows administrators and platform users.
Build an HTTP request URL
Append the service name and method name to your configured HTTP API base URL, separated by slashes. Use the exact identifiers and capitalization shown in the documented HTTP path.
For an HTTP API base URL of http://192.168.2.100, the create-website URL is shown below. This IP address is an example; replace it with your API node's HTTP endpoint.
API_BASE_URL/SERVICE_NAME/METHOD_NAMEhttp://192.168.2.100/ServerService/createServerRead a method definition
An rpc declaration identifies the method, its request message and its response message. The declaration below says that createServer accepts CreateServerRequest and returns CreateServerResponse. Open those message definitions to inspect the fields.
proto3 describes message structures and RPC interfaces. It does not itself define this platform's HTTP URL structure, authentication headers or POST rules. Those are provided by the API node's HTTP service, so follow the calling overview and authentication guide as well.
rpc createServer (CreateServerRequest) returns (CreateServerResponse);