REST API Reference

Back Next

Start a file listener

Use a POST request to start a file listener job.

To start a file listener, use the following URI:

POST <server URL>/mftsaas/api/v1/filelisteners/<file listener ID>/start

Include the following field in the request:

Field	Type	Description
file listener ID	String	ID number associated with the file listener.

If the request to start the file listener is successful, you might receive a response similar to the following example:

{
    "status": "STARTED",
    "jobId": 1038
}

If the request to start the file listener is unsuccessful, you might receive a response similar to the following example:

{   
 "responseCode": "NOT_FOUND",   
"message": "File listener not found for ListenerId:  bQdKQmGlFUUgS85AevLkqisd"
}

{   
 "responseCode": "NOT_FOUND",   "message": "Agent \"01000008000000000002\" in Agent Group \"01000025000000000002\" is not accessible."}