Returns a new BunkerWeb API token; changes nothing in the BunkerWeb configuration.

Check that the BunkerWeb API answers (GET /ping, returns pong). Use it as the fastest liveness probe; use diagnose to also check authentication, version and instances.

Read the API's own liveness probe (GET /health); it does not contact instances. Use instances_ping_all for instances and diagnose for auth and version checks.

Read-only check of the connected BunkerWeb: reachability, authentication, version, MULTISITE, instances, and optionally who owns a service's settings.

List every registered BunkerWeb instance with its status. Results may be cached up to 60 s. Use instance_get for one host, instances_ping_all for live reachability.

Ping every registered instance live and report which answer. Use instance_ping for one host; list_instances returns registration data without pinging.

Stop every registered instance; traffic stops until they restart. Use instance_stop for one host. Acts on the instances immediately.

Fetch one registered instance by hostname. Results may be cached up to 60 s. Use list_instances to find hostnames, instance_ping to test reachability.

Ping one instance live by hostname. Use instances_ping_all for every instance; instance_get returns the stored record without pinging.

Stop one instance by hostname; it serves no traffic until restarted. Use instances_stop_all for all. Acts on the instances immediately.

Register a new instance for the scheduler to manage. Use instance_update to change one. Saved to the database; the scheduler applies it later; this tool cannot confirm it is live.

Change a registered instance; omitted fields keep their value. Use instance_create for a new host. Saved to the database; the scheduler applies it later; this tool cannot confirm it is live.

Unregister several UI/API-registered instances; the hosts keep running. Use instance_delete for one. Saved to the database; the scheduler applies it later; this tool cannot confirm it is live.

Unregister one UI/API-registered instance; the host keeps running. Use instances_delete_bulk for several. Saved to the database; the scheduler applies it later; this tool cannot confirm it is live.

Reload configuration on every instance, testing it first by default. Use reload_instance for one host. Acts on the instances immediately.

Reload configuration on one instance, testing it first by default. Use reload_instances for all. Acts on the instances immediately.

List active IP bans as reported by each instance. Results may be cached up to 30 s. It gives the exact IPs and services for unban_ip when writes are enabled.

Ban one or more IPs, globally or per service, for exp seconds (0 = permanent). Use unban_ip to lift a ban. Acts on the instances immediately.

Lift bans for one or more IPs, globally or per service. Use list_bans first to find them. Acts on the instances immediately.

List services with their configuration and dates. Results may be cached up to 5 min. Use get_service to read one service in detail.

Read one service's settings by ID; full=true adds defaults. Cached up to 5 min. Use list_services to find IDs, global_config_read for global settings.

Create a service from SERVER_NAME and optional settings. Use update_service to change one. Saved to the database; the scheduler applies it later; this tool cannot confirm it is live.

Change a service's settings; skips unknown or externally owned keys and reads back the result. Use global_config_update for global settings. Saved to the database; the scheduler applies it later; this tool cannot confirm it is live.

Delete a service and all its settings; not reversible. Use convert_service to take it offline. Saved to the database; the scheduler applies it later; this tool cannot confirm it is live.

Switch a service between online and draft without deleting it. Use delete_service to remove it. Saved to the database; the scheduler applies it later; this tool cannot confirm it is live.

Read global settings; full=true adds defaults. Results may be cached up to 10 min. Use get_service for one service's settings.

Set global settings from key-value pairs; other settings are kept. Use update_service for one service. Saved to the database; the scheduler applies it later; this tool cannot confirm it is live.

List custom config snippets (service, type, name), optionally with content. Use config_get to read one snippet in full.

Read one custom config snippet with its content by service, type and name. Use configs_list to find snippets.

Create one custom config snippet from text. Use configs_upload for several files. Saved to the database; the scheduler applies it later; this tool cannot confirm it is live.

Edit, rename or move one snippet from text; omitted fields keep their value. Use config_upload_update to send a file. Saved to the database; the scheduler applies it later; this tool cannot confirm it is live.

Delete one custom config snippet. Use configs_delete_bulk for several. Saved to the database; the scheduler applies it later; this tool cannot confirm it is live.

Delete several custom config snippets in one call. Use config_delete for one. Saved to the database; the scheduler applies it later; this tool cannot confirm it is live.

Create snippets from base64 files, one per file, named after the file. Use config_create for text. Saved to the database; the scheduler applies it later; this tool cannot confirm it is live.

Replace one snippet's content from a base64 file; without new_name the file stem renames it. Use config_update for text. Saved to the database; the scheduler applies it later; this tool cannot confirm it is live.

List installed plugins, filtered by type (all, external, ui, pro). type=ui lists the IDs accepted by plugin_delete when writes are enabled; use jobs_list for jobs.

Install UI plugins from base64 archives; an existing plugin ID is refused. Use plugin_delete first to replace a UI plugin. Saved to the database; the scheduler applies it later; this tool cannot confirm it is live.

Uninstall one UI-installed plugin by ID; other plugins are refused. Use plugins_list with type=ui to find IDs. Saved to the database; the scheduler applies it later; this tool cannot confirm it is live.

List files that scheduler jobs cached, filtered by service, plugin or job. Use cache_fetch_file to read one file.

Delete several job cache files. Use cache_delete_file for one; jobs_run regenerates them. Queued for the scheduler; this tool cannot confirm it ran.

Read one job cache file, keyed as listed by cache_list. Returns printable text, or base64 bytes with download=true. Use cache_list to find files.

Delete one job cache file. Use cache_delete_bulk for several; jobs_run regenerates it. Queued for the scheduler; this tool cannot confirm it ran.

List scheduler jobs with their run history and cache metadata. Use cache_list for the files they wrote, and jobs_run when writes are enabled to trigger them.

Trigger the jobs of one or more plugins, e.g. after cache_delete_file. Use jobs_list to check results. Queued for the scheduler; this tool cannot confirm it ran.

Search the official BunkerWeb documentation by meaning (remote semantic search). Returns titled sections with URL, category and relevance, one per document. Use it for how-to and setting questions; use the API tools to read live state.