SMTP Gateway

List gateways

Lists registered gateways

get/v1/gateways

Request

  • Base URL: https://your-emailengine-host
  • URL: https://your-emailengine-host/v1/gateways
  • Auth: HTTP bearer

Query parameters

pageinteger

Page number (zero indexed, so use 0 for first page)

pageSizeinteger

How many entries per page

Example:20

Headers

x-ee-timeoutinteger

Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect

Example:30000

Response

Returns a page of configured SMTP gateways.

totalinteger

How many matching entries

pageinteger

Current page (0-based index)

pagesinteger

Total page count

Example response

{
  "total": 120,
  "pages": 24,
  "gateways": [
    {
      "gateway": "example",
      "name": "My Email Gateway",
      "deliveries": 100,
      "lastUse": "2021-02-17T13:43:18.860Z",
      "lastError": {
        "created": 1623868624153,
        "status": "error",
        "response": "535 Authentication failed",
        "responseCode": 535,
        "code": "EAUTH",
        "command": "AUTH PLAIN",
        "description": "Authentication failed",
        "networkRouting": {
          "localAddress": "198.51.100.24",
          "name": "relay.example.com"
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.