REST Endpoints Reference
This is a reference for the REST Endpoints integration. The endpoint configuration follows the same pattern as the REST.V2 moogdb module; there is a minimum set of required parameters and an optional set of parameters.
Name
A unique name for the endpoint for use in Workflow Engine configuration.
Type | String |
Required | Yes |
Default | N/A |
URL
URL of the endpoint. May contain substitutions from the in-scope object allowing a dynamic path to the object. For example, if the object path is https://myserver.com/alerts/$alert_id, when processing an alert with an alert_id of 99, Moogsoft Enterprise dynamically creates a target URL of https://myserver.com/alerts/99.
Substitutions can contain any valid object field (including custom_info) to any depth as long as it is a string. A substitutions that contains an array or object results in an invalid URL.
Type | String |
Required | Yes |
Default | N/A |
Method
Method to associate with this endpoint. Some actions are tied to a specific set of verbs. For example, exportViaRest is only compatible with PUT, POST, and PATCH. To use the same endpoint with multiple methods, configure separate endpoints for each method you want to use.
Type | One of: |
Required | Yes |
Default |
|
Timeout
Length of time to wait before halting a connection or read attempt, in seconds.
Type | Integer |
Required | Yes |
Default |
|
Headers
Content-type
Specifies the format of the response. If the drop-down does not show the content-type you require, use the Other field to specify an alternative.
Type | One of: |
Required | Yes |
Default | N/A |
Other
Allows you to specify a content-type other than those available in the Content-type drop-down.
Type | String |
Required | No |
Default | N/A |
Additional Headers
Any additional headers you want to add to the request. Click Add Header to configure an additional header. Cannot currently contain substitutions.
Name
Header name.
Type | String |
Required | No |
Default | N/A |
Value
Header value.
Type | String |
Required | No |
Default | N/A |
Security
Disable Certificate Validation
Specifies whether to disable SSL certificate validation. If set to Yes, the data transmission between Moogsoft Enterprise and the endpoint is not protected by the encryption protocol.
Type | Boolean |
Required | Yes |
Default | Yes |
Authentication
Allows you to configure basic authentication. Click Add Basic Authentication to configure a set of credentials. Note that Moogsoft Enterprise only uses the first set of credentials you configure here.
Username
Basic authentication username.
Type | String |
Required | Yes, if using Basic Authentication. |
Default | N/A |
Password
Basic authentication password.
Type | String |
Required | Yes, if using Basic Authentication. |
Default | N/A |
Proxy settings
Specifies connection details for a proxy server if you want to connect to the external system through a proxy.
Use proxy in request
Property description.
Type | Boolean |
Required | Yes |
Default | No |
Proxy host
Property description.
Type | String |
Required | If Use Proxy in Request is set to Yes. |
Default | N/A |
Proxy user
Property description.
Type | String |
Required | If Use Proxy in Request is set to Yes. |
Default | N/A |
Proxy port
Property description.
Type | Integer |
Required | If Use Proxy in Request is set to Yes. |
Default | N/A |
Proxy password
Property description.
Type | String |
Required | If Use Proxy in Request is set to Yes. |
Default | N/A |