agentCLI resource

Edit online

/agentCLI/unavailable POST
/agentCLI/maintenanceTask GET
/agentCLI/maintenanceTasks GET
Add a tag to an agent
Add an agent to a team
Add public key pin for a server host to an agent
This command requests the agent add a public key pin for a server host, but does not wait for or report the result. The returned maintenance task can be used to query the result.
Add public key pins for server hosts to an agents in bulk
This command requests a set of agent add a public key pin for a server host, but does not wait for or report the results. The returned maintenance tasks can be used to query the result. Individual sub-requests may succeed or fail independently. A single request may contain up to 250 sub-requests.
Add public key pins for server hosts to an agents in bulk
This command requests a set of agents set or modify their keypair policy, but does not wait for or report the results. The returned maintenance tasks can be used to query the result. Individual sub-requests may succeed or fail independently. A single request may contain up to 250 sub-requests. If the maximum age of a keypair is changed to be less than its current age, keypair rotation may begin immediately, but the outcome of the returned maintenance tasks do not depend on that.
Delete a tag from an agent
Delete an agent
Agents should be shut down before deletion.
Forget Agent Certificates
Get information about all agents
Get information about an agent
This command returns a JSON representation of an agent.
Get list of managed Java installations
This command returns a list of managed Java installations for an agent.
Get list of managed Java installations in bulk
This command returns a list of managed Java installations for a set of agents. Individual sub-requests may succeed or fail independently. A single request may contain up to 250 sub-requests.
Get the value of a property on an agent
Install Java packages as a new managed Java installations in bulk
This command request a set of agents install Java, but does not wait for or report the results. The returned maintenance tasks can be used to query the result. Individual sub-requests may succeed or fail independently. A single request may contain up to 250 sub-requests.
Install a Java package as a new managed Java installation
This command requests the agent install Java, but does not wait for or report the result. The returned maintenance task can be used to query the result.
List all tags on an agent
Remove a property from an agent
Remove an agent from a team
Remove public key pin for a server host from an agent
This command requests the agent remove a public key pin for a server host, but does not wait for or report the result. The returned maintenance task can be used to query the result.
Remove public key pins for server hosts from agents in bulk
This command requests a set of agent remove a public key pin for a server host, but does not wait for or report the results. The returned maintenance tasks can be used to query the result. Individual sub-requests may succeed or fail independently. A single request may contain up to 250 sub-requests.
Rename an agent
Rename an agent. Use this command if running the agent configuration script in the agent bin directory is not convenient. Only the administrator can run this method.
Restart an agent
Return high watermarks for agent usage
Returns a JSONObject with count of agents to status. Expected format: { "ONLINE":4, "UPGRADE_RECOMMENDED":1 } Requires Manage System permission
Set a property on a agent
Set or modify an agent's keypair policy
This command requests the agent set or modify its keypair policy, but does not wait for or report the result. The returned maintenance task can be used to query the result. If the maximum age of the keypair is changed to be less than its current age, keypair rotation may begin immediately, but the outcome of the returned maintenance task does not depend on that.
Set the configured JAVA_HOME of agents in bulk
This command requests a set of agents set JAVA_HOME, but does not wait for or report the results. Each new JAVA_HOME will not take effect until the respective agent is restarted. The returned maintenance tasks can be used to query the results.Individual sub-requests may succeed or fail independently. A single request may contain up to 250 sub-requests.
Set the configured JAVA_HOME of an agent
This command requests the agent set JAVA_HOME, but does not wait for or report the result. The new JAVA_HOME will not take effect until the agent is restarted. The returned maintenance task can be used to query the result.
Set the license for an agent
Shut down an agent
Test the connection from an agent to the server
Uninstall a managed Java installation
This command requests the agent uninstall Java, but does not wait for or report the result. If an installation is the active JAVA_HOME or configured as JAVA_HOME, that installation is not removed.
Uninstall a managed Java installations in bulk
This command requests a set of agents uninstall Java, but does not wait for or report the result. If an installation is the active JAVA_HOME or configured as JAVA_HOME, that installation is not removed. The returned maintenance tasks can be used to query the result. Individual sub-requests may succeed or fail independently. A single request may contain up to 250 sub-requests.
Update agent settings
Upgrade an agent
The agent will be upgraded to the agent version corresponding with the server version.

Parent topic: REST commands for the DevOps Deploy server