Import and export agent packages and configure system agents¶
Export or load agent packages, and query, validate, and update system-agent configuration. This page does not cover normal-agent creation, versions, or runtime configuration.
Prerequisites¶
Prepare credentials that can access the target workspace and the target information to import, export, or configure. For service endpoints, authentication, and general request formats, see Prepare to call an API.
The package information required by export and load actions is defined by their action pages. Query the current configuration before updating a system agent.
Call sequence¶
To migrate or back up an agent, export its package. To load an existing package, use the load action and confirm its returned result.
Before configuring a system agent, get the system-agent configuration.
To select a GitHub project, list available projects based on the current configuration or the new configuration to submit.
After updating the configuration, get the system-agent configuration again to confirm the current result.
API operations¶
Import and export agent packages¶
What you need to do |
API operation |
Use it when |
|---|---|---|
Export an agent package |
Obtain an agent package. |
|
Load an agent package |
You prepared an agent package and need to load it. |
Query and update system-agent configuration¶
What you need to do |
API operation |
Use it when |
|---|---|---|
Get system-agent configuration |
Confirm the current configuration before or after an update. |
|
List system-agent GitHub projects |
Select a GitHub project based on the current configuration. |
|
List system-agent GitHub projects for new configuration |
Query projects from the content to submit before creating a new configuration. |
|
Update system-agent configuration |
You confirmed the target configuration. |
Confirm the result¶
After loading a package, confirm the result on its load action page. After updating a system-agent configuration, use Get system-agent configuration to confirm the current configuration.