runs

Purge queued runs

Cancels every run in the environment that is in queued status, or only those of agent_name.

Purged runs get the error Purged from queue by user. Scheduled and running runs are not affected.

Required permission: runs.queue.manage.

post/v1/projects/{project_id}/environments/{environment_id}/purge-queue

Request

  • Base URL: https://api.connic.co
  • URL: https://api.connic.co/v1/projects/{project_id}/environments/{environment_id}/purge-queue
  • Auth: HTTP bearer

Path parameters

project_idstring uuid required

ID of the project the API key belongs to.

environment_idstring uuid required

Environment ID from GET /environments.

Request body

agent_namestring nullable

Only cancel queued runs of this agent; omit to cancel every queued run in the environment.

Response

Successful Response

okboolean required

Whether the operation succeeded.

purged_countinteger required

Number of queued runs that were cancelled.

Changes

No recorded changes to this operation across all 2 revisions of this API.