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.

Prog.		Request	Response	Description
smtpd	a	ConfigGreenDeployRequest		Live stage
smtpd	b		ConfigGreenStatusResponse	” (status)
smtpd	c			” (cancel)
smtpd	e		HSLBreakPointResponse	Breakpoint
smtpd	f			” (continue)
smtpd	g		HSLCacheResponse	Script cache
smtpd	h	HSLCacheClearRequest	HSLCacheClearResponse	” (clear)
smtpd	y	HSLMemoryRequest	HSLMemoryResponse	Script memory
smtpd	K	HSLMemoryListRequest	HSLMemoryListResponse	” (list)
smtpd	z	HSLMemoryStoreRequest	HSLMemoryStoreResponse	” (store)
smtpd	A	HSLMemoryDeleteRequest	HSLMemoryDeleteResponse	” (delete)
rated	i	HSLRateRequest	HSLRateResponse	Script rate
rated	j	HSLRateClearRequest	HSLRateClearResponse	” (clear)
smtpd	r			Reload config
smtpd	o			” (suspend)
smtpd	p			” (policy)
smtpd	H			” (delivery)
rated	r			” (rated)
dlpd	r			” (dlpd)
smtpd	s	SuspendRequest	SuspendResponse	Queue suspend
smtpd	t	SuspendAddRequest	SuspendAddResponse	” (add)
smtpd	O	SuspendUpdateRequest	SuspendUpdateResponse	” (update)
smtpd	u	SuspendDeleteRequest	SuspendDeleteResponse	” (delete)
smtpd	v	PolicyConditionRequest	PolicyConditionResponse	Queue policy
smtpd	w	PolicyConditionAddRequest	PolicyConditionAddResponse	” (add)
smtpd	P	PolicyConditionUpdateRequest	PolicyConditionUpdateResponse	” (update)
smtpd	x	PolicyConditionDeleteRequest	PolicyConditionDeleteResponse	” (delete)
smtpd	B	PolicyRateRefillRequest	PolicyRateRefillResponse	” (rate refill)
smtpd	D	QueueGroupByRequest	QueueGroupByResponse	Queue distr.
smtpd	F	QueueListRequest	QueueListResponse	Queue list
smtpd	G	QueueUpdateRequest	QueueUpdateResponse	Queue update
smtpd	E	QueueImportRequest	QueueImportResponse	Queue import
smtpd	J	QueueUnloadRequest	QueueUnloadResponse	Queue unload
smtpd	I	QueueQuotaRequest	QueueQuotaResponse	Queue quota
smtpd	q		ProcessStatsResponse	Show stats
smtpd	C			Clear DNS
smtpd	L	ServerConnectionsListRequest	ServerConnectionsListResponse
smtpd	M	ServerConnectionsCloseRequest	ServerConnectionsCloseResponse
smtpd	N	PluginCommandRequest	PluginCommandResponse
smtpd	Q	QueueExportRequest	<raw-data>	Export a queued message’s content. The response is not an protobuf object.
smtpd	V		VersionResponse
smtpd	X	TraceSMTPRequest	<raw-data>	Send a message trace. The response is not an protobuf object.
rated	V		VersionResponse
smtpd	T	PolicyMatchRequest	PolicyMatchResponse
smtpd	R	QueueConnectionsListRequest	QueueConnectionsListResponse
smtpd	U	PolicyGroupingRequest	PolicyGroupingResponse

6.3. Version compatibility

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

Version	Min
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