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:
|
Yes |
Request Headers
|
Name |
Description |
|---|---|
|
Host |
The host name of the Web Server or Web Console 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:
|
response |
Examples
Example Request
DELETE <webservice>/Agent/17/109/Retire
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 3c633bc300b7cbdcf31f918d4ce4934722d620774b81e87e543c517177302b23a0742c0b7e74bd7dc43731ca2b83fe44a43b5fcb24633fab54842eaeb8ddaa6d85674a17692ea6cd559b1d70a4f589552e59c10fc79701debf79d85cda
Example Response
<App_RetireAgentResponse jobId="18047">
<response errorString="" errorCode="0"/>
</App_RetireAgentResponse>