Command Center and Internet Server Administrative (Admin) REST Calls

The Admin REST calls only work on a Command Center or Internet Server when admin-service-enabled is true in the web.xml file. For information on rights to execute an Admin REST call, see TIBCO® Managed File Transfer Command Center User's Guide or TIBCO® Managed File Transfer Internet Server User's Guide. The URLs for the Admin REST calls are as follows:

• Command Center - https://your.company.com:8443/cfcc/rest/admin/v3/resource/{parameters}
• Internet Server - https://your.company.com:7443/cfcc/rest/admin/v3/resource/{parameters}

Important Guidelines for REST Calls

• Public Key / PGP Public Key REST Calls: You must enter key data with \r\n characters. For example:

  -----BEGIN CERTIFICATE-----\r\n
  MIIBqzCCARSgAwIBAgIGAV8GPboIMA0GCSqGSIb3DQEBBQUAMA8xDTALBgNVBAMMBHRlc3QwHhcN\r\n
  MTcxMDEwMTIyMzQ5WhcNMjIxMDA5MTgzMDAwWjAPMQ0wCwYDVQQDDAR0ZXN0MIGfMA0GCSqGSIb3\r\n
  DQEBAQUAA4GNADCBiQKBgQCD8/xhSXzHHD8D0rRaALRE1l7PwjPKTD3vb1LWSGNMTd1s/FiC/Yeb\r\n
  LD4iZ2dpywhwojqtm4+OeowX/EhhluQQ628o/HV2l9JqpHqt75tNiVhed4YhApzGfpoTAJGAO5q8\r\n
  mtN4nhhsyUZRA4tciB5qSyDUQWy6Fd9yAabm+S0B6wIDAQABoxIwEDAOBgNVHQ8BAf8EBAMCAvQw\r\n
  DQYJKoZIhvcNAQEFBQADgYEAVRf7uTZ8MwmA0oc32BcToWj+xQwf+D3pJZ+XrDP/NDMRcXwimJ0N\r\n
  +zcQO7ZqgZ+Hy/PVEKSWbOBEwAZPtNuvJhLnkZtE9rq+TxfDR4wn1zWPKmJKLLuCSdxNK535xI4n\r\n
  F84cED1MC0ZFh5wZdB3VFh8mXchZw9RnPM/kWP2hZls=\r\n
  -----END CERTIFICATE-----
  

  In TIBCO ActiveMatrix BusinessWorks™, \r\n characters must be replaced with &crlf; character.
• Search REST Calls: The wildcard character used for search requests is asterisk (*).
• Search User and Transfer REST Calls: The search user REST calls return only 100 records at a time. To retrieve the next 100 records, you must set lastUserId parameter to the last user id value that was returned in the previous call. Similarly, for the search transfers rest calls, you must set the lastFileId parameter to the last transfer id value that was returned in the previous call.
• Update Server REST Calls: You can reset to the default value for the following fields as shown.

  Fields	Default Value	Reset Request
  FTPKeepAliveInterval	The default value is 0	"ftpKeepAliveInterval": ""
  ftpPoolingIdleTimeout	The default value is 5	"ftpPoolingIdleTimeout": ""
  sshPoolingIdleTimeout	The default value is 5	"sshPoolingIdleTimeout": ""

  Example:

  1. If you want to update the field values to 20, 60, and 60 respectively, enter the request as follows:

     "ftpKeepAliveInterval":"20"

     "ftpPoolingIdleTimeout":"60"

     "sshPoolingIdleTimeout": "60"

  2. If you want to reset the fields to their default values, enter the request as follows:

     "ftpKeepAliveInterval": "",

     "ftpPoolingIdleTimeout": "",

     "sshPoolingIdleTimeout": ""

     Note: The response for the above entries is set to default values only if the value is blank and enclosed between double quotation marks ("").