Administrator Guide

Back Next

Run Inbound Endpoints REST API

Use the

runEndpoint

REST API to run an endpoint in the

B2B Data Exchange

server. This API uses the POST method.

Use the following URL for the REST API call:

POST https://<host>:<tomcat_embedded_port>/dx-server-rest-api/v1/runEndpoint/{endpointName}

<host>

is the host name or IP address of the

B2B Data Exchange

server.

<tomcat_embedded_port>

is the port number of the

B2B Data Exchange

server. The default port is 19553.

For example,

https://myserver:19553

You can provide a request body to the REST API call. The following table describes the request body objects:

Object	Arguments
username	The username (login name) used to connect to the mailbox server.
password	The password to connect to the mailbox server.
isPasswordEncrypted	Indicates whether the password is encrypted. Run the dxpasswd.bat or dxpasswd.sh command to encrypt the password.

The run endpoint REST API supports the following endpoint types:

MFT Remote Endpoint- Receive

MFT Hosted Endpoint- Receive

You must enable the "Run Endpoint" privilege to run an endpoint.

URL:

https://myserver:19553/dx-server-rest-api/v1/runEndpoint/MFT_Remote_Receive

The following code shows the request body syntax as form-data:

The following code shows the response body syntax:

The Run Endpoint request is submitted successfully. Check the events section in the DX console for more information.