Administrator Guide

Back Next

Pause All Endpoints REST API

Use the Pause All REST API to pause all new files (inbound and outbound) from being picked up from the

B2B Data Exchange

endpoints. This API uses the POST method.

Use the following URL for the REST API call:

POST https://<hostName>:<portNumber>/dx-server-rest-api/v1/pause_all_dx_endpoints

is the host name or IP address of the

B2B Data Exchange

server.

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.