Command Center Administrative (AdminCC) REST Calls
MFT-Install/server/webapps/cfcc/public/docs/admincc.json
The AdminCC REST calls only work on a Command Center when admincc-service-enabled is true in the web.xml file. file. For information on rights to execute a call, see TIBCO® Managed File Transfer Command Center User's Guide.
The URL for the AdminCC REST calls is as follows:https://your.company.com:8443/cfcc/rest/admincc/v3/resource/{parameters}
| Resource | HTTP Method | Description | URL |
|---|---|---|---|
| activeistransfers | GET | Retrieves active internet transfers for all servers. You must have one of these rights: AdministratorRight or ViewAuditRight. | activeistransfers |
| GET | Retrieves active internet transfers for the defined server. You must have one of these rights: AdministratorRight or ViewAuditRight. | activeistransfers/{serverName} | |
| GET | Retrieves details of active internet transfers. You must have one of these rights: AdministratorRight or ViewAuditRight. | activeistransfers/details/{auditId}?
hostName={Hostname}&wait=Y&timeout=1 |
|
| activepstransfers | GET | Returns active transfer for Platform Server.
You must have one of these rights: AdministratorRight, FTAdminRight, or FTAdminAlterRight. This call returns transfers only if your department or one of the departments that you manage matches the department of the server definition you are inquiring. |
activepstransfers/{serverName) |
| GET | Returns details of an active transfer.
You must have one of these rights: AdministratorRight, FTAdminRight, or FTAdminAlterRight. This call provides return transfers only of your department or one of the departments that you manage. |
activepstransfers/{serverName}/{transactionId}?
wait=Y&timeout=1 |
|
| PUT | Cancels an active transfer.
You must have FTAdminAlterRight. This call provides return transfers only of your department or one of the departments that you manage. |
activepstransfers/{serverName}/{transactionId} | |
| dni | GET | Lists DNI daemons. | dni |
| GET | Lists DNI templates. | dni/{psServerName} | |
| GET | Lists DNI templates. | dni/{psServerName}/{templateName} | |
| POST | Adds DNI templates. | dni/{psServerName}/{templateName} | |
| PUT | Updates a DNI template. | dni/{psServerName}/{templateName} | |
| DELETE | Deletes a DNI template. | dni/{psServerName}/{templateName} | |
| PUT | Starts a DNI template. | dni/{psServerName}/{templateName} | |
| PUT | Stops a DNI template. | dni/{psServerName}/{templateName} | |
| PUT | Status of a DNI template. | dni/{psServerName}/{templateName} | |
| hoststats (host status) | GET | Retrieves host statistics. | hoststats |
| istransfers | PUT | Initiates an Internet Server file transfer. | istransfer/file |
| PUT | Performs a file transfer using JMS and file. | istransfer/jms | |
| PUT | Performs a file transfer using two virtual aliases. | istransfer/virtualalias | |
| psaudits | GET | Searches Platform Server audit records. | psaudits?
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>&pageNumber=<string>& nodeName=<string> |
| GET | Gets a Platform Server audit record. | psaudits/{auditId} | |
| GET | Gets a Platform Server audit record from a Platform Server. | psaudits/{localTransactionId}/psserver/{psServerName} | |
| DELETE | Deletes audits by days. | psaudits/days | |
| DELETE | Deletes audits by dates. | psaudits/date | |
| GET | Searches for a Platform Server audit record from a Platform Server. | psaudits/psserver?
psServerName=<string>&nodeName=<string>& localTransactionId=<string>&localFileName=<string>& transferUserId=<string>&transferStatus=<string>& fromDate=<string>&fromTime=<string>& toDate=<string>&toTime=<string>& noOfDays=<string> |
|
| psnodes | GET | Searches for nodes in a bank. | psnodes |
| POST | Adds nodes to a bank. | psnodes | |
| GET | Gets a node from a bank. | psnodes/{nodeName} | |
| PUT | Updates a node in a bank. | psnodes/{nodeName} | |
| DELETE | Deletes a node from a bank. | psnodes/{nodeName} | |
| GET | Gets a node from a Platform Server. | psnodes/{nodeName}/psserver/{psServerName} | |
| PUT | Adds or updates a node on the Platform Server from a bank. | psnodes/{nodeName}/psserver/{psServerName} | |
| DELETE | Deletes a node from a Platform Server. | psnodes/{nodeName}/psserver/{psServerName} | |
| GET | Gets all nodes on a Platform Server. | psnodes/psserver/{psServerName} | |
| PUT | Adds or updates a node on a Platform Server. | psnodes/psserver/{psServerName} | |
| psresponder profiles | GET | Searches responder profiles in a bank. | psresponderprofiles |
| POST | Adds a responder profile to a bank. | psresponderprofiles | |
| GET | Gets a responder profile from a bank. | psresponderprofiles/{profileId} | |
| PUT | Updates a responder profile in a bank. | psresponderprofiles/{profileId} | |
| DELETE | Deletes a responder profile in a bank. | psresponderprofiles/{profileId} | |
| PUT | Adds/Updates a responder profile in a Platform Server from a bank. | psresponderprofiles/{profileId}/psserver/{psServerName} | |
| GET | Gets a responder profile from a Platform Server. | psresponderprofiles/psserver/{psServerName} | |
| PUT | Adds/Updates a responder profile on a Platform Server. | psresponderprofiles/psserver/{psServerName} | |
| DELETE | Deletes a responder profile on a Platform Server. | psresponderprofiles/psserver/{psServerName} | |
| psuserprofiles | POST | Adds a user profile to a bank. | psuserprofiles |
| GET | Searches user profiles in a bank. | psuserprofiles | |
| DELETE | Deletes a user profile in a bank. | psuserprofiles/{profileId} | |
| GET | Gets a user profile from a bank. | psuserprofiles/{profileId} | |
| PUT | Updates a user profile in a bank. | psuserprofiles/{profileId} | |
| PUT | Adds/Updates a user profile in a Platform Server from a bank. | psuserprofiles/{profileId}/psserver/{psServerName} | |
| SEARCH | Gets a user profile from a Platform Server. | psuserprofiles/psserver/{psServerName} | |
| PUT | Adds/Updates a user profile on a Platform Server. | psuserprofiles/psserver/{psServerName} | |
| DELETE | Deletes a user profile on Platform Server. | psuserprofiles/psserver/{psServerName} | |
| pstransfers | POST | Adds Platform Server transfers. | pstransfers |
| GET | Searches for Platform Server transfers. | pstransfers | |
| GET | Gets a Platform Server transfer. | pstransfers/{transferId} | |
| PUT | Updates a Platform Server transfer | pstransfers/{transferId} | |
| DELETE | Deletes a Platform Server transfer. | pstransfers/{transferId} | |
| PUT | Executes platform transfers ad hoc. | pstransfers/execute | |
| PUT | Executes a platform transfer from a bank. | pstransfers/{transferId}/execute | |
| scheduler | POST | Adds scheduler jobs. | jobs |
| GET | Searches scheduler jobs. | jobs?
jobName=<string>&groupName=<string>& description=<string>&jobType=<string>&enabled=<string>& batchName=<string>&department=<string>& authorizedUserId=<string>&authorizedGroupId=<string>& jobScheduledDate=<string> |
|
| GET | Gets a scheduler job. | jobs/jobName/{jobName}/groupName/{groupName} | |
| PUT | Updates a scheduler job. | jobs/jobName/{jobName}/groupName/{groupName} | |
| DELETE | Deletes a scheduler job. | jobs/jobName/{jobName}/groupName/{groupName} | |
| PUT | Executes a scheduler job. | jobs/jobName/{jobName}/groupName/{groupName}/execute | |
| GET | Retrieves a scheduler active jobs. | jobs/activejobs?hostName={HostName} | |
| services | PUT | Retrieves the status, stops, or starts the service (collector or status server). | services |
| PUT | Retrieves the status, starts or stops a service (Platform Server, JMS, scheduler) on a host. When the service is the scheduler, then you can also put the service on hold | services/{hostname} | |
| server status | GET | Gets the server status. | serverstatus |
| GET | Gets the server status details. | serverstatus/{servername} | |
| statistics | GET | Searches statistics by date range. | statistics?
startDate={startDate}&endDate={endDate} |