REST API - DELETE Retire Agent

This operation retires an application, solution, or MediaAgent.

Request

Syntax

DELETE  webservice/Agent/clientId/agentId/Retire
Host: host name
Accept: application/xml
Authtoken: authentication token

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name

Description

Required

clientId

The client ID for the client. If the client ID is not known, use the GET Client API to retrieve it.

Yes

agentId

The agent ID of the application, solution, or MediaAgent.

Valid values are:

41, Active Directory
21, AIX File System
64, Big Data Apps
134, Cloud Apps
37, DB2
103, DB2 MultiNode
62, DB2 on Unix
128, Documentum
90, Domino Mailbox Archiver
91, DPM
67, Exchange Compliance Archiver
53, Exchange Database
45, Exchange Mailbox
54, Exchange Mailbox (Classic)
56, Exchange Mailbox Archiver
82, Exchange PF Archiver
35, Exchange Public Folder
73, File Share Archiver

33, File System
74, FreeBSD
71, GroupWise DB
17, HP-UX Files System
65, Image Level
75, Image Level On Unix
76, Image Level ProxyHost
87, Image Level ProxyHost on Unix
3, Informix Database
29, Linux File System
89, MS SharePoint Archiver
104, MySQL
13, NAS
83, Netware File Archiver
12, Netware File System
10, Novell Directory Services
124, Object Link
131, Object Store

86, OES File System on Linux
22, Oracle
80, Oracle RAC
130, Other External Agent
125, PostgreSQL
38, Proxy Client File System
87, ProxyHost on Unix
61, SAP for Oracle
135, SAP HANA
78, SharePoint Server
20, Solaris 64bit File System
19, Solaris File System
81, SQL Server
5, Sybase Database
66, Unix File Archiver
36, Unix Tru64 64-bit File System
106, Virtual Server
58, Windows File Archiver

Yes

Request Headers

Name	Description
Host	The host name of the Web Server or the Command Center used in the API request.
Accept	The format of the response. Valid values are: application/xml or application/json.
Authtoken	The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter	Description	Element
jobId	The ID of the job, which will retire the client.	App_RetireAgentResponse
errorString	The message for each error code. Every error code has a different error message.	response
errorCode	The possible error codes. Valid values are: 0, client will be retired by a job. 1, a failure. a specific error code.	response

Parameter

Description

Element

jobId

The ID of the job, which will retire the client.

App_RetireAgentResponse

errorString

The message for each error code. Every error code has a different error message.

response

errorCode

The possible error codes.