4.3 KiB
4.3 KiB
name, description
| name | description |
|---|---|
| agent-pools-routes | Handle 14 OpenAPI operation(s) under /api/v1/agentPools for the agentPools route group. |
agentPools API Routes
Handle 14 OpenAPI operation(s) under /api/v1/agentPools for the agentPools route group.
Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.
Operations
list_agent_pools
- Operation ID:
list_agent_pools - Route:
GET /api/v1/agentPools - Mode: READ
- Summary: List all agent pools
- Parameters:
limitPerPoolTypeinquerypoolTypeinqueryafterinquery
list_agent_pools_updates
- Operation ID:
list_agent_pools_updates - Route:
GET /api/v1/agentPools/{poolId}/updates - Mode: READ
- Summary: List all agent pool updates
- Parameters:
poolIdinpathrequiredscheduledinquery
create_agent_pools_update
- Operation ID:
create_agent_pools_update - Route:
POST /api/v1/agentPools/{poolId}/updates - Mode: WRITE
- Summary: Create an agent pool update
- Parameters:
poolIdinpathrequired
- Body: JSON request body accepted.
get_agent_pools_update_settings
- Operation ID:
get_agent_pools_update_settings - Route:
GET /api/v1/agentPools/{poolId}/updates/settings - Mode: READ
- Summary: Retrieve an agent pool update's settings
- Parameters:
poolIdinpathrequired
update_agent_pools_update_settings
- Operation ID:
update_agent_pools_update_settings - Route:
POST /api/v1/agentPools/{poolId}/updates/settings - Mode: WRITE
- Summary: Update an agent pool update settings
- Parameters:
poolIdinpathrequired
- Body: JSON request body accepted.
get_agent_pools_update_instance
- Operation ID:
get_agent_pools_update_instance - Route:
GET /api/v1/agentPools/{poolId}/updates/{updateId} - Mode: READ
- Summary: Retrieve an agent pool update by ID
- Parameters:
poolIdinpathrequiredupdateIdinpathrequired
update_agent_pools_update
- Operation ID:
update_agent_pools_update - Route:
POST /api/v1/agentPools/{poolId}/updates/{updateId} - Mode: WRITE
- Summary: Update an agent pool update by ID
- Parameters:
poolIdinpathrequiredupdateIdinpathrequired
- Body: JSON request body accepted.
delete_agent_pools_update
- Operation ID:
delete_agent_pools_update - Route:
DELETE /api/v1/agentPools/{poolId}/updates/{updateId} - Mode: WRITE
- Summary: Delete an agent pool update
- Parameters:
poolIdinpathrequiredupdateIdinpathrequired
activate_agent_pools_update
- Operation ID:
activate_agent_pools_update - Route:
POST /api/v1/agentPools/{poolId}/updates/{updateId}/activate - Mode: WRITE
- Summary: Activate an agent pool update
- Parameters:
poolIdinpathrequiredupdateIdinpathrequired
deactivate_agent_pools_update
- Operation ID:
deactivate_agent_pools_update - Route:
POST /api/v1/agentPools/{poolId}/updates/{updateId}/deactivate - Mode: WRITE
- Summary: Deactivate an agent pool update
- Parameters:
poolIdinpathrequiredupdateIdinpathrequired
pause_agent_pools_update
- Operation ID:
pause_agent_pools_update - Route:
POST /api/v1/agentPools/{poolId}/updates/{updateId}/pause - Mode: WRITE
- Summary: Pause an agent pool update
- Parameters:
poolIdinpathrequiredupdateIdinpathrequired
resume_agent_pools_update
- Operation ID:
resume_agent_pools_update - Route:
POST /api/v1/agentPools/{poolId}/updates/{updateId}/resume - Mode: WRITE
- Summary: Resume an agent pool update
- Parameters:
poolIdinpathrequiredupdateIdinpathrequired
retry_agent_pools_update
- Operation ID:
retry_agent_pools_update - Route:
POST /api/v1/agentPools/{poolId}/updates/{updateId}/retry - Mode: WRITE
- Summary: Retry an agent pool update
- Parameters:
poolIdinpathrequiredupdateIdinpathrequired
stop_agent_pools_update
- Operation ID:
stop_agent_pools_update - Route:
POST /api/v1/agentPools/{poolId}/updates/{updateId}/stop - Mode: WRITE
- Summary: Stop an agent pool update
- Parameters:
poolIdinpathrequiredupdateIdinpathrequired