Configure external agent
Create, edit, and delete external agents.
Request
Security
| Any | Super User | System Admin | Security Admin | Operator |
|---|---|---|---|---|
| superUser | systemAdmin |
HTTP method
POST
/manager/api/{apiResponseType}/1.0/editSystemExternalAgentConfiguration.adm
HTTP/1.1 Host:{manager.dsnet} content-type: multipart/form-data;
boundary=---------------------------15229075091796398817602324146
-----------------------------15229075091796398817602324146
Content-Disposition: form-data; name=”action“ {create|edit|delete}
-----------------------------15229075091796398817602324146
Content-Disposition: form-data; name=”externalAgent“;
filename=”splunkforwarder2.tar.gz“ Content-Type: application/x-gzip
*FILE CONTENTS HERE*
-----------------------------15229075091796398817602324146
Content-Disposition: form-data; name=”agentName“ {agentName}
-----------------------------15229075091796398817602324146--
Curl method
curl -u {admin}:{password} -k
”https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/editSystemExternalAgentConfiguration.adm“
-F 'action={create|edit|delete}' -F 'externalAgent=@{pathToFile}' -F
'agentName={agentName}'
Parameters
| Parameter | Type | Usage | Default | Description |
|---|---|---|---|---|
| action | String | Required |
Must be create, edit, or delete. Action to take for a given external agent. |
|
| id | Long | Optional |
Id of the external agent. Required for edit and delete actions. |
|
| externalAgent | File | Optional |
The .tar.gz file to use when creating an external agent. Required for create actions. |
|
| agentName | String | Optional |
The name of the external agent. Required for create actions. |
|
| description | String | Optional |
A description of the external agent. Can be added on create or modified using the edit action. |
Response
Returns success or failure status.
JSON response example
Default JSON success or failure response that is shown in Default JSON success response and Default JSON failure response.
Parameters
None other than the default response parameters shown in Common response parameters.