v1
latestOpenAPI 3.1.02026-07-24239123562.1 KBCommands
Purge queue
Use this method to purge all existing commands from the target queue. This command can be useful when testing new pipelines and command creation and the queue is blocked by a large number of unexecuted commands. When you fire this endpoint, all commands are deleted from the queue, and the command status is changed to PURGED. Also, during the purge, the queue for the given target is blocked and does not receive new commands.
delete/v1/commands
Query parameters
targetIdstring required
Agent or connector ID for which queue should be purged
Response
200
Example response
{
"purged": [
{
"commandId": "cd0ce1e2-c0f1-47c1-9da9-feaa10cfe7eb"
}
]
}