Search
Varnish Controller

Deprecation

This page announces which endpoints and features will be breaking in the upcoming major release. Users of the Varnish Controller are advised to implement the alternatives. Are you only using the UI? Then no action is needed, these changes are mostly regarding configuration, API endpoints and CLI commands.

Upcoming deprecations

API-GW - All varnishstat endpoints will be renamed to stats as they no longer hold just Varnish Statistics. As of version 5 there is support for both endpoints, the following API endpoints need to be changed: - /api/v1/agents/varnishstats to /api/v1/agents/stats - /api/v1/agents/{id}/varnishstats to /api/v1/agents/{id}/stats - /api/v1/domains/varnishstats to /api/v1/domains/stats - /api/v1/domains/{id}/varnishstats to /api/v1/domains/{id}/stats - /api/v1/routers/varnishstats to /api/v1/routers/stats - /api/v1/routers/{id}/varnishstats to /api/v1/routers/{id}/stats - /api/v1/tags/varnishstats to /api/v1/tags/stats - /api/v1/tags/{id}/varnishstats to /api/v1/tags/{id}/stats - /api/v1/vclgroups/varnishstats to /api/v1/vclgroups/stats - /api/v1/vclgroups/{id}/varnishstats to /api/v1/vclgroups/{id}/stats

Deprecations as of Version 5.0.0

CLI

  • All vcli vcl * commands has been removed, use the vcli files * commands instead.

API-GW

  • All /api/v1/vcls/* endpoints has been removed, use the /api/v1/files/* endpoints instead.
  • The /api/v1/agents/1/vclgroups endpoint has been removed, use /api/v1/vclgroups?agents.id=1&vg_states.deployed=true instead.
  • The /api/v1/tags/1/agents endpoint has been removed, use /api/v1/agents?tags.id=1 instead.
  • The /api/v1/vclgroups/1/agents endpoint has been removed, use /api/v1/agents?vcl_groups.id=1&vg_states.deployed=true instead.
  • The operator=and has been removed from the filters, instead of ?tags.id=1,2&operator=and use ?tags.id[all]=1,2.

You can replace the above commands and API endpoints as of version 4.1.0.