Reset Consumer

DELETE

///v1/admin/consumers/:consumer_type/reset

Reset a consumer by deleting it. The consumer will be automatically recreated within seconds by the running service.

Authentication

AuthorizationBearer

Bearer JWT used by CLI and machine clients on svc-* endpoints. Authentication is required by default, but deployments may disable it with [auth] required = false. Browser OIDC sessions, mTLS, SPIFFE identities, and trusted gateway identity headers may also satisfy authentication outside this generated client flow.

Path parameters

consumer_typeenumRequired

Valid consumer types for NATS consumer management.

Allowed values:

Response

Operation successful

consumer_namestring

messagestring

statusstring

streamstring

Errors

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

$	curl -X DELETE /v1/admin/consumers/nautobot/reset \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"consumer_name": "nautobot",
3	"message": "Consumer 'nautobot' has been successfully reset and will be recreated shortly.",
4	"status": "success",
5	"stream": "events_stream"
6	}