Command Center and Internet Server Administrative (Admin) REST Calls

The Admin REST calls only work on Command Center or Internet Server when admin-service-enabled is true in the web.xml file. For information on rights to run an Admin REST call, see TIBCO® Managed File Transfer Command Center User Guide or TIBCO® Managed File Transfer Internet Server User Guide.

MFT-Install/server/webapps/cfcc/public/docs/admin.json

REST URL: The URLs for the Admin REST calls are as follows:
  • Command Center - https://your.company.com:8443/cfcc/rest/admin/v5/resource/{parameters}
  • Internet Server - https://your.company.com:7443/cfcc/rest/admin/v5/resource/{parameters}

where,

ComponentDescription
https://your.company.com:8443Defines the protocol, host name, and port.
cfccDefines the MFT default context.
restDefines that this is a REST call.
adminDefines that this is an admin REST call.
v5Defines the REST call version.
resourceDefines the object of the REST call (like users and servers).
parametersDefines the URL files required for the REST call.

Note that the REST version is used to insulate users from changes in the REST calls. The following REST call versions are supported:

  • v2: For MFT 8.2.x

  • v3: for MFT 8.3.x

  • v4, v4.1, v4.2: for MFT 8.4.x

  • v5: for MFT 8.5.x

New MFT releases maintain support for older versions of REST calls.

Note that while the version corresponds with the MFT release number, this may not be the case in future releases.

For Admin REST calls, the following table lists the resource, the HTTP method, the description, and the URL that starts with the resource.

Resource HTTP Method Description URL Resource and Parameters
departments POST Adds departments. departments
  GET Searches departments. departments
  GET Gets a department. departments/{deptName}
  DELETE Deletes a department. departments/{deptName}
  PUT Updates a department. departments/{deptName}
    
errorEventsGETSearches for error events.

/errorevents?initiatingUser=

<string>&serverHostName=

<string>&sourceProtocol=

<string>&destinationServer=

<string>&destinationProtocol=

<string>&errorType=

<string>&searchStartDate=

<string>&searchStartTime=

<string>&searchEndDate=

<string>&searchEndTime=

<string>&numberOfDays=<string>

 GETRetrieves error event details./errorevents/{errorEventId}
    
groups POST Adds groups. groups
  GET Searches groups. groups?
userId=<string>
  GET Gets a group. groups/{groupId}
  DELETE Deletes a group. groups/{groupId}
  PUT Updates a group. groups/{groupId}
  PUT

Adds a user to a group./

Removes a user from a group.

groups/{groupId}/{userId}
  GET Retrieves user IDs assigned to a group. groups/{groupId}/users
    
isaudits GET Searches Internet Server audit records. /isaudits?

auditId=

<string>&localTransactionId=

<string>& clientFileName=

<string>&serverFileName=

<string>& serverName=

<string>&processName=

<string>& userData=

<string>&transferUserId=

<string>& transferStatus=

<string>&department=

<string>& fromDateAndTime=

<string>&toDateAndTime=

<string>& noOfDays=

<string>&recordsReturned=

<string>&pageNumber=

<string>& as2MDNStatusSuccess=

<string>& as2MDNStatusFailure=

<string>& as2MDNStatusPending=

<string>& transferId=

<string>&virtualAlias=

<string>

  GET Gets Internet Server audit record. isaudits/{auditId}
  DELETE Deletes audits by date. isaudits/date
 DELETE Deletes audits by number of days. isaudits/days
    
ldap PUT Synchronizes a user or an authenticator. ldap
    

lockout

release

PUT Releases an invalid login lock(s). lockoutrelease
    
mftversion GET Gets the version. mft/version
    

pgp

publickeys

POST Adds PGP public keys. pgppublickeys
  GET Searches PGP public keys.

pgppublickeys?
userServerFlag=
<string>&status=
<string>&name=
<string>&keyId=
<string>&lastKeyId=
<string>

  GET Gets a PGP public key. pgppublickeys/{keyId}
  PUT Updates a PGP public key. pgppublickeys/{keyId}
  DELETE Deletes a PGP public key. pgppublickeys/{keyId}
    

pgp

systemkeys

POST Adds PGP system key. pgpsystemkeys
 PUT Imports a PGP system key. pgpsystemkeys
 PUT Updates a PGP system key. pgpsystemkeys/{keyId}
 GET Searches all the PGP system keys. pgpsystemkeys
 GET Gets details of a PGP system key. pgpsystemkeys/{keyId}
 DELETE Removes a PGP system key. pgpsystemkeys/{keyId}
    

protocol

publickeys

POST Adds a public key. protocolpublickeys
  GET Searches public keys. protocolpublickeys?

keyType=

<string>&userServerFlag=

<string>& keyStatus=

<string>&userOrServerName=

<string>& lastKeyId=

<string>

  PUT Updates a public key.

protocolpublickeys

/{keyType}/{keyId}

  DELETE Deletes a public key

protocolpublickeys

/{keyType}/{keyId}

  GET Gets a public key.

protocolpublickeys/{UserServerFlag}/{keyType}/

{keyId}

 PUT Retrieves public keys for a server. protocolpublickeys/server
    

protocol

systemkeys

POST Adds a protocol system key. protocolsystemkeys
 PUT Imports a protocol system key. protocolsystemkeys
 GET Exports a protocol system key. protocolsystemkeys/:keyId?

serverFileName=<string>&

keyType=<string>

 PUT Updates a protocol system key. protocolsystemkeys/{keyType}/{keyId}
 GET Searches all the protocol system keys. protocolsystemkeys?

keyType=

<string>&description=

<string>& lastKeyId=

<string>

 GET Gets the details of a protocol system key. protocolsystemkeys/{keyType}/{keyId}
 DELETE Removes a protocol system key. protocolsystemkeys/{keyType}/{keyId}
    
roles GET Gets all roles.

You must have AdministratorRight, UpdateTransferUserRight to run this call.

roles
  PUT

Adds a user to a role.

/Removes a user from a role.

roles/{userId}
  GET Gets roles for a user. roles/{userId}
 GET Gets a role.

You must have AdministratorRight, UpdateTransferUserRight to run this call.

roles/id/{roleId}
 GET Gets all users in a role.

You must have AdministratorRight, UpdateTransferUserRight to run this call.

roles/users/id/{roleId}
    

server

credentials

POST Creates server credentials. servercredentials
  PUT Updates server credentials. servercredentials
  DELETE Removes server credentials from a user.

servercredentials/{userOrGroupType}/

{userOrGroupId}/{serverName}

  GET Gets server credentials for a user.

servercredentials/{userOrGroupType}/

{userOrGroupId}/{serverName}

  GET Searches server credentials. servercredentials?
userOrGroupType=
<string>&userOrGroupId=
<string>&serverName=
<string>&remoteUserId=
<string>&remoteUserWindowsDomain=
<string>
    
servers POST Adds servers. servers
  GET Searches servers. servers?

serverName=<string>&

ipName=<string>&

serverType=<string>&

serverPlatform=<string>&

department=<string>

  PUT Updates a server. servers/{servername}
  DELETE Deletes a server. servers/{servername}
  GET Gets a server. servers/{servername}
    
transfers POST Adds transfers. transfers
  GET Searches transfers. transfers?

transferId=<string>&

serverFileName=<string>&

authUserId=<string>&

authGroupId=<string>&

serverName=<string>&

department=<string>&

description=< string>&

virtualAlias=<string>&

expiredFlag=<string>&
processName=<string>&
userData=<string>&

lastFileId=<string>

 GETLists all transfer definitions of a user.users/{userId}/transfers
  GET Gets a transfer. transfers/{transferId}
  PUT Updates a transfer. transfers/{transferId}
  DELETE Deletes a transfer transfers/{transferId}
 DELETE Deletes expired transfers.

You must have AdministratorRight, UpdateTransferDefinitionRight to run this call.

transfers/expired
    

transferservers

 PUT

Provides the status, starts, or stops the transfer server.

Note: The transferservers REST call has been deprecated. It has been replaced by the transferserverstatus REST call.
transferservers/{hostname}
    

transfer

serversconfig

GETRetrieves the AS2 transfer server configuration./tranferserverconfig/as2/{hostName}
 PUT Updates the AS2 transfer server configuration./tranferserverconfig/as2/{hostName}
 GETRetrieves FTP transfer server configuration./tranferserverconfig/ftp/{hostName}
 PUTUpdates FTP transfer server configuration./tranferserverconfig/ftp/{hostName}
 GETRetrieves OFTP2 transfer server configuration./tranferserverconfig/oftp2/{hostName}
 PUT Updates OFTP2 transfer server configuration./tranferserverconfig/oftp2/{hostName}
 GETRetrieves Platform Server configuration./tranferserverconfig/ps/{hostName}
 PUTUpdates Platform Server configuration./tranferserverconfig/ps/{hostName}
 GETRetrieves SSH transfer server configuration./tranferserverconfig/ssh/{hostName}
 PUTUpdates SSH transfer server configuration./tranferserverconfig/ssh/{hostName}
    

transfer

serverstatus

PUT Provides the status and starts or stops the transfer server./transferserverstatus/{hostname}
    
users POST Adds users. users
 GET Gets a user. users/{userId}
 PUT Updates a user. users/{userId}
  DELETE Deletes a user. users/{userId}
 GET Searches users. users?

userId=<string>&

FullName=<string>&

AssignedRight=<string>&

Group=<string>&

EmailAddress=<string>&

UserType=<string>&

Department=<string>&

fromExpirationDate=<string>&

toExpirationDate=<string>&

DisabledUsers=<string>&

LockedUsers=<string>&

canChangeOwnPassword=<string>&

PasswordNeverExpires=<string>&

PasswordExpired=<string>&

lastUserId=<string>

 PUTChanges Password/user/password

Important Guidelines for REST Calls

  • Public Key / PGP Public Key REST Calls: Enter key data with \r\n characters. 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 an 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 the 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": ""
    ftpPoolingIdleTimeoutThe default value is 5 "ftpPoolingIdleTimeout": ""
    sshPoolingIdleTimeoutThe 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 ("").

Note:

If you want to reset the values of PPA using the update transfer definition, then you must pass "postActionType1": "NONE" in the update request.

{

"transferId": "F204K0001807",

"postActionType1": "NONE",

"postActionType2": "NONE",

"postActionType3": "NONE",

"postActionType4": "NONE"

}