Skip to main content
A newer release of this product is available.

Retrieve an EMS configuration

Contributors
PDFs

GET /support/ems

Introduced In: 9.6

Retrieves the EMS configuration.

  • event config show

Parameters

Name Type In Required Description

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

mail_from

string

Mail from

mail_server

string

Mail server (SMTP)

proxy_password

string

Password for HTTP/HTTPS proxy

proxy_url

string

HTTP/HTTPS proxy URL

proxy_user

string

User name for HTTP/HTTPS proxy

pubsub_enabled

boolean

Is Publish/Subscribe Messaging Enabled?
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "mail_from": "administrator@mycompany.com",
  "mail_server": "mail.mycompany.com",
  "proxy_password": "password",
  "proxy_url": "https://proxyserver.mycompany.com",
  "proxy_user": "proxy_user",
  "pubsub_enabled": 1
}

Error

Status: Default, Error
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.