v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1475719557.8 KB

Deletes an agent.

delete/agents/{agentId}/

Path parameters

agentIdstring required

The unique identifier of the agent to delete.

Query parameters

skipResourceInUseCheckboolean

By default, this value is <code>false</code> and deletion is stopped if the resource is in use. If you set it to <code>true</code>, the resource will be deleted even if the resource is in use.

Response

Success

agentIdstring required

The unique identifier of the agent that was deleted.

agentStatus'CREATING' | 'PREPARING' | 'PREPARED' | 'NOT_PREPARED' | 'DELETING' | 'FAILED' | 'VERSIONING' | 'UPDATING' required

The status of the agent.