6.2. API reference

The API request and response bodies are defined by the Protocol Buffer schemas. The following section describes them in more detail.

6.2.1. Command list

This is a list of all the API commands; which program that implements them, their command identifier, and request/response body format.

Command	Request	Response	Description
a	ConfigGreenDeployRequest		Live stage
b		ConfigGreenStatusResponse	” (status)
c			” (cancel)
e		HSLBreakPointResponse	Breakpoint
f			” (continue)
g		HSLCacheResponse	Script cache
h	HSLCacheClearRequest	HSLCacheClearResponse	” (clear)
y	HSLMemoryRequest	HSLMemoryResponse	Script memory
K	HSLMemoryListRequest	HSLMemoryListResponse	” (list)
z	HSLMemoryStoreRequest	HSLMemoryStoreResponse	” (store)
A	HSLMemoryDeleteRequest	HSLMemoryDeleteResponse	” (delete)
i		ConfigResponse	Contains parts of the running configuration
j	HealthRequest		Set the system health
l	ResolverQueueListRequest	ResolverQueueListResponse	Get the list of queued DNS queries
m	QueueAnalyzeRequest	QueueAnalyzeResponse	The the queue analyze output
r			Reload config
o			” (suspend)
p			” (policy)
H			” (delivery)
s	SuspendRequest	SuspendResponse	Queue suspend
t	SuspendAddRequest	SuspendAddResponse	” (add)
O	SuspendUpdateRequest	SuspendUpdateResponse	” (update)
u	SuspendDeleteRequest	SuspendDeleteResponse	” (delete)
v	PolicyConditionRequest	PolicyConditionResponse	Queue policy
w	PolicyConditionAddRequest	PolicyConditionAddResponse	” (add)
P	PolicyConditionUpdateRequest	PolicyConditionUpdateResponse	” (update)
x	PolicyConditionDeleteRequest	PolicyConditionDeleteResponse	” (delete)
B	PolicyRateRefillRequest	PolicyRateRefillResponse	” (rate refill)
D	QueueGroupByRequest	QueueGroupByResponse	Queue distr.
F	QueueListRequest	QueueListResponse	Queue list
G	QueueUpdateRequest	QueueUpdateResponse	Queue update
E	QueueImportRequest	QueueImportResponse	Queue import
J	QueueUnloadRequest	QueueUnloadResponse	Queue unload
I	QueueQuotaRequest	QueueQuotaResponse	Queue quota
q		ProcessStatsResponse	Show stats
C	ResolverCacheClearRequest	ResolverCacheClearResponse	Clear DNS
L	ServerConnectionsListRequest	ServerConnectionsListResponse
M	ServerConnectionsCloseRequest	ServerConnectionsCloseResponse
N	PluginCommandRequest	PluginCommandResponse
Q	QueueExportRequest	<raw-data>	Export a queued message’s content. The response is not an protobuf object.
V		VersionResponse
X	TraceSMTPRequest	<raw-data>	Send a message trace. The response is not an protobuf object.
T	PolicyMatchRequest	PolicyMatchResponse
R	QueueConnectionsListRequest	QueueConnectionsListResponse
S	QueueConnectionsCloseRequest	QueueConnectionsCloseResponse
U	PolicyGroupingRequest	PolicyGroupingResponse
W	PolicyGroupingListRequest	PolicyGroupingListResponse
Y	QueueUpdateStatusRequest	QueueUpdateStatusResponse
Z	ResolverQueryListRequest	ResolverQueryListResponse	Get the list of running DNS queries

6.3. Version compatibility

The protobuf API is versioned, below you will find the version compatibility for different versions.

Version	Min
6.11	5.6
6.10	5.6
6.9	5.6
6.8	5.6
6.7	5.6
6.6	5.6
6.5	5.6
6.4	5.6
6.3	5.6
6.2	5.6
6.1	5.6
6.0	5.6
5.13	5.6
5.12	5.6
5.11	5.6
5.10	5.6
5.9	5.6
5.8	5.6
5.7	5.6
5.6	5.6
5.5	5.3
5.4	5.3
5.3	5.3
5.2	5.2