IBM API Hub
Maximo Application Suite Admin APIs 9.0.x

By IBM Maximo

Provides REST APIs for performing Suite administration operations.


API reference

Get current SMTP configuration

GET

/config/smtp/default

Requires User administration and System administration permissions . Retrieve the connection information for an SMTP server that MAS should use for sending emails to users

Request URL
https://api.{mas-instance-id}.{mas-domain}/config/smtp/default
Security
apiKey
x-access-token
required in header
Responses
  • 200

    SMTPConfig configuration

  • 401

    Authentication token is empty or invalid

  • 403

    Authenticated user is not permitted to make the request

  • 404

    The requested resource could not be found

  • 500

    An internal server error occured

Code snippet
    1curl --request GET \
    2  --url https://api.replace_mas-instance-id_variable.replace_mas-domain_variable/config/smtp/default \
    3  --header 'accept: application/json' \
    4  --header 'x-access-token: REPLACE_THIS_VALUE'

      Example response

        1{
        2  "metadata": {
        3    "creationTimestamp": "2020-02-20T13:54:00",
        4    "deletionTimestamp": "2020-02-20T13:58:00"
        5  },
        6  "spec": {
        7    "displayName": "Millie Morales",
        8    "config": {
        9      "hostname": "na.relay.ibm.com",
        10      "port": 25,
        11      "security": "SSL",
        12      "authentication": true,
        13      "defaultSenderEmail": "gpmxT)8b>5NH<@tiN9enz=`==Z1;w<UW+;_J6[HZ1Y<|8]=|La>_]X{(@F8|~.Fw=nmg?+~.;.Sg*F+O_U$w_/w6+!<e2Cs4~]>g.Uo6bGHdl@nRC}8mYM+0TWMSA*lEvIw;s'XnY@eDGFl},OCQAY{vdI)}=aBOk",
        14      "defaultSenderName": "Lottie Harris",
        15      "defaultRecipientEmail": "`a_fKmCxoT6z[bH!@(MC\"qEGiU+!_urEqVR6\\Xvk!.0v]*\\h~w<Ck])^~+No!Xr-3zRc[;OdN@f-#GK{v?!:H'9f<v>Es#c@+!4{\\e- ;RG\\([k<M8k\\t}n<?&h]^|t?N-|?QWb+!",
        16      "defaultShouldEmailPasswords": true,
        17      "credentials": {
        18        "secretName": "smtp-ibmcloud-admin"
        19      }
        20    },
        21    "certificates": [
        22      {
        23        "alias": "intermediate",
        24        "crt": "-----BEGIN CERTIFICATE-----MIIGxTCCBa2g...<snip>-----END CERTIFICATE-----"
        25      }
        26    ]
        27  },
        28  "status": {
        29    "conditions": [
        30      {
        31        "lastTransitionTime": "2020-08-10T16:45:47Z",
        32        "reason": "Ready",
        33        "message": "Configuration was updated successfully",
        34        "status": "True",
        35        "type": "Ready"
        36      }
        37    ],
        38    "config": {
        39      "hostname": "na.relay.ibm.com",
        40      "port": 25,
        41      "security": "SSL",
        42      "authentication": true,
        43      "defaultSenderEmail": "znFf>&wMn]z&!\\T$6V#U8uO2.\\cNsWK6v*QgIUvL;1NQpI5s^_3*qY@J5;MF<Y^xg1fMy@l -bv`Z.p:gaqN",
        44      "defaultSenderName": "Christine Schneider",
        45      "defaultRecipientEmail": "^+fbPQ!Si)ex/^k1&8SfNP<s,D3L@e:_r1w,_0,f06cM<XcOV{ui\"f<Q {w4 _1Pw6Gdx@u{_N;X|t%>I`a ajl\"!m$[&z!?Rj.=.6T:cxE$?\\jpe#hFAu_pf",
        46      "defaultShouldEmailPasswords": false,
        47      "credentials": {
        48        "secretName": "smtp-ibmcloud-admin"
        49      }
        50    }
        51  }
        52}