Delete agent

Deletes an agent. Requires admin role. Optionally purges volumes.

DELETE /agents/{id}

Error

A valid request URL is required to generate request examples

200

{
  "deleted": true
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string<uuid> · required

Query Parameters

purge · enum<string>

If "true", also remove agent volumes

Available options: true, false

Response

200

application/json

Agent deleted

deleted · boolean