Skip to content

Routes API

List all routes configured for the authenticated server.

{
"status": "success",
"data": [
{
"id": 1,
"uuid": "rte-abc-123",
"name": "Default Route",
"domain_id": 1,
"endpoint_id": 1,
"mode": "Endpoint",
"spam_mode": "Mark"
}
]
}

Create a new routing rule.

ParameterTypeRequiredDescription
namestringYesRoute name
domain_idintegerYesDomain to match
endpoint_idintegerYesDestination endpoint
modestringNoEndpoint (default), Bounce, Hold, Reject
spam_modestringNoMark (default), Quarantine, Fail

Returns the created route record.

Update an existing route.

ParameterTypeRequiredDescription
idintegerYesRoute ID
namestringNoUpdated name
endpoint_idintegerNoUpdated endpoint
modestringNoUpdated mode
spam_modestringNoUpdated spam handling

Delete a route.

ParameterTypeRequiredDescription
idintegerYesRoute ID