Smtp connections API

get listing

GET /api/rest/admin/system/smtp-connections

Parameters

Name	Description
filter[id]	id filter
filter[name]	name filter

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3MzE1Nzg3NjUsInN1YiI6MjM0fQ.rCDbXRMeENEQ5KFTT9ySpy0HENE_JH7BAgmx_2jRrJ0
Host: example.org
Cookie: 

Route

GET /api/rest/admin/system/smtp-connections

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
ETag: W/"1ec31c94c72db56d6167f7744d2c7ed0"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 53c5619b-fd28-4987-a0c9-d7aff2ab2ee9
X-Runtime: 0.009346
Content-Length: 790

Status

200 OK

Body

{
  "data": [
    {
      "id": "1",
      "type": "smtp-connections",
      "links": {
        "self": "http://example.org/api/rest/admin/system/smtp-connections/1"
      },
      "attributes": {
        "name": "smtp_connection1",
        "host": "host",
        "port": 25,
        "from-address": "address@email.com",
        "auth-user": null,
        "auth-password": null,
        "global": true
      }
    },
    {
      "id": "2",
      "type": "smtp-connections",
      "links": {
        "self": "http://example.org/api/rest/admin/system/smtp-connections/2"
      },
      "attributes": {
        "name": "smtp_connection2",
        "host": "host",
        "port": 25,
        "from-address": "address@email.com",
        "auth-user": null,
        "auth-password": null,
        "global": true
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/admin/system/smtp-connections?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/system/smtp-connections?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}