Delete endpoint agent
DELETE {{baseUrl}}/endpoint/agents/:agentId?aid=1234&expand=clients,vpnProfiles,networkInterfaceProfiles
Deletes the agent with the specified agent_id
.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
aid | number | A unique identifier associated with your account group. You can retrieve your AccountGroupId from the /account-groups endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. | |
expand | string | This optional parameter allows you to control the expansion of test resources associated with the agent. By default, no expansion occurs when this query parameter is omitted. | |
To expand the "clients" resource, include the query parameter ?expand=clients . |
For multiple expansions, you have two options:
- Separate the values with commas. For example,
?expandAgent=clients,tasks
. - Specify the parameter multiple times. For example,
?expandAgent=clients&expandAgent=tasks
.
This parameter offers flexibility for users to customize the expansion of specific resources related to the agent. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |