Smtp connections API

create new entry

POST /api/rest/admin/smtp-connections

Parameters

Name Description
data[type] Resource type (smtp-connections)
data[attributes][name] Name
data[attributes][host] Host
data[attributes][port] Port
data[attributes][from-address] From address
data[attributes][auth-user] Auth user
data[attributes][auth-password] Auth password
data[attributes][global] Global

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjIzNywiYXVkIjpbImFkbWluIl0sImV4cCI6MTc2NzM1ODU3Mn0.NUMg86buPppBEekLydgo0aQP-82YLh9IE0TmAuFE74M
Host: example.org
Cookie: 

Route

POST /api/rest/admin/smtp-connections

Body

{"data":{"type":"smtp-connections","attributes":{"name":"name","host":"host","port":25,"from-address":"address@email.com"}}}

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
location: http://example.org/api/rest/admin/smtp-connections/4
vary: Accept
etag: W/"0045c219e74bc8e04ca1ce23c52a6cc2"
cache-control: max-age=0, private, must-revalidate
x-request-id: e6d4651f-9f07-4d22-ad80-8fc992784333
x-runtime: 0.009714
content-length: 257

Status

201 Created

Body

{
  "data": {
    "id": "4",
    "type": "smtp-connections",
    "links": {
      "self": "http://example.org/api/rest/admin/smtp-connections/4"
    },
    "attributes": {
      "name": "name",
      "host": "host",
      "port": 25,
      "from-address": "address@email.com",
      "auth-user": null,
      "auth-password": null,
      "global": true
    }
  }
}