public interface MailgunRoutesApi extends MailgunApi
Mailgun Routes Api
Mailgun Routes are a powerful way to handle the incoming traffic.
See user-manual/Routes section in the User Manual to learn more about how they work.
This API allows you to work with routes programmatically.
Routes are comprised of the following arguments:
A filter (when to do something). A priority (in what order). An action (what to do).
| Modifier and Type | Method and Description |
|---|---|
RoutesResponse |
createRoute(RoutesRequest request)
Creates a new route.
|
feign.Response |
createRouteFeignResponse(RoutesRequest request)
Creates a new route.
|
ResponseWithMessage |
deleteRoute(String id)
Deletes a route based on the id.
|
feign.Response |
deleteRouteFeignResponse(String id)
Deletes a route based on the id.
|
RoutesListResponse |
getRoutesList()
Fetches the list of routes (limit to 100 entries).
|
RoutesListResponse |
getRoutesList(RoutesPageRequest pageRequest)
Fetches the list of routes.
|
feign.Response |
getRoutesListFeignResponse()
Fetches the list of routes (limit to 100 entries).
|
feign.Response |
getRoutesListFeignResponse(RoutesPageRequest pageRequest)
Fetches the list of routes.
|
SingleRouteResponse |
getSingleRoute(String id)
Returns a single route object based on its ID.
|
feign.Response |
getSingleRouteFeignResponse(String id)
Returns a single route object based on its ID.
|
Route |
updateRoute(String id,
RoutesRequest request)
Updates a given route by ID.
|
feign.Response |
updateRouteFeignResponse(String id,
RoutesRequest request)
Updates a given route by ID.
|
getApiVersionRoutesListResponse getRoutesList()
Fetches the list of routes (limit to 100 entries).
Note: that routes are defined globally, per account, not per domain as most of other API calls.RoutesListResponsefeign.Response getRoutesListFeignResponse()
Fetches the list of routes (limit to 100 entries).
Note: that routes are defined globally, per account, not per domain as most of other API calls.ResponseRoutesListResponse getRoutesList(RoutesPageRequest pageRequest)
Fetches the list of routes.
Note: that routes are defined globally, per account, not per domain as most of other API calls.pageRequest - RoutesPageRequestRoutesListResponsefeign.Response getRoutesListFeignResponse(RoutesPageRequest pageRequest)
Fetches the list of routes.
Note: that routes are defined globally, per account, not per domain as most of other API calls.pageRequest - RoutesPageRequestResponseSingleRouteResponse getSingleRoute(String id)
Returns a single route object based on its ID.
id - ID of the routeSingleRouteResponsefeign.Response getSingleRouteFeignResponse(String id)
Returns a single route object based on its ID.
id - ID of the routeResponseRoutesResponse createRoute(RoutesRequest request)
Creates a new route.
request - RoutesRequestRoutesResponsefeign.Response createRouteFeignResponse(RoutesRequest request)
Creates a new route.
request - RoutesRequestResponseRoute updateRoute(String id, RoutesRequest request)
Updates a given route by ID.
All parameters are optional: this API call only updates the specified fields leaving others unchanged.id - ID of the routerequest - RoutesRequestRoutefeign.Response updateRouteFeignResponse(String id, RoutesRequest request)
Updates a given route by ID.
All parameters are optional: this API call only updates the specified fields leaving others unchanged.id - ID of the routerequest - RoutesRequestResponseResponseWithMessage deleteRoute(String id)
Deletes a route based on the id.
id - ID of the routeResponseWithMessagefeign.Response deleteRouteFeignResponse(String id)
Deletes a route based on the id.
id - ID of the routeResponseCopyright © 2022. All rights reserved.