Smtp connections API

get listing

GET /api/rest/admin/smtp-connections

Parameters

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

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjIzNSwiYXVkIjpbImFkbWluIl0sImV4cCI6MTc2NzM1ODU3Mn0._izefr5BdYot_SwDF22h9cNOPnz37WNOIaRol1R2y5o
Host: example.org
Cookie: 

Route

GET /api/rest/admin/smtp-connections

Response

Headers

x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
content-type: application/vnd.api+json
vary: Accept
etag: W/"b13112d234c289855da97d6d997a8441"
cache-control: max-age=0, private, must-revalidate
x-request-id: 3ef582d1-e149-44b9-ab0e-def2bb0ef9c5
x-runtime: 0.006848
content-length: 762

Status

200 OK

Body

{
  "data": [
    {
      "id": "1",
      "type": "smtp-connections",
      "links": {
        "self": "http://example.org/api/rest/admin/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/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/smtp-connections?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/smtp-connections?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}