Smtp connections API

create new entry

POST /api/rest/admin/system/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

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

Route

POST /api/rest/admin/system/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-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/"fc04d0ba7065d2031932e66380bffc9d"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 57b0c0f0-25d2-4500-8cb0-7c98db2ab33e
X-Runtime: 0.012233
Content-Length: 264

Status

201 Created

Body

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