Apache APISIX Admin API

List All Routes — GET /apisix/admin/routes
Create a Route — POST /apisix/admin/routes
Create or Replace a Route — PUT /apisix/admin/routes/{id}
Get a Route — GET /apisix/admin/routes/{id}
Update a Route (Partial) — PATCH /apisix/admin/routes/{id}
Delete a Route — DELETE /apisix/admin/routes/{id}
List All Services — GET /apisix/admin/services
Create a Service — POST /apisix/admin/services
Get a Service — GET /apisix/admin/services/{id}
Create or Replace a Service — PUT /apisix/admin/services/{id}
Update a Service (Partial) — PATCH /apisix/admin/services/{id}
Delete a Service — DELETE /apisix/admin/services/{id}
Create or Update a Consumer — PUT /apisix/admin/consumers
List All Consumers — GET /apisix/admin/consumers
Get a Consumer — GET /apisix/admin/consumers/{username}
Delete a Consumer — DELETE /apisix/admin/consumers/{username}
List All Upstreams — GET /apisix/admin/upstreams
Create an Upstream — POST /apisix/admin/upstreams
Create or Replace an Upstream — PUT /apisix/admin/upstreams/{id}
Update an Upstream (Partial) — PATCH /apisix/admin/upstreams/{id}
Get an Upstream — GET /apisix/admin/upstreams/{id}
Delete an Upstream — DELETE /apisix/admin/upstreams/{id}
List All SSL Certificates — GET /apisix/admin/ssls
Create an SSL Certificate — POST /apisix/admin/ssls
Create or Replace an SSL Certificate — PUT /apisix/admin/ssls/{id}
Get an SSL Certificate — GET /apisix/admin/ssls/{id}
Update an SSL Certificate (Partial) — PATCH /apisix/admin/ssls/{id}
Delete an SSL Certificate — DELETE /apisix/admin/ssls/{id}
List All Global Rules — GET /apisix/admin/global_rules
Create or Replace a Global Rule — PUT /apisix/admin/global_rules/{id}
Get a Global Rule — GET /apisix/admin/global_rules/{id}
Update a Global Rule (Partial) — PATCH /apisix/admin/global_rules/{id}
Delete a Global Rule — DELETE /apisix/admin/global_rules/{id}
List All Consumer Groups — GET /apisix/admin/consumer_groups
Create or Replace a Consumer Group — PUT /apisix/admin/consumer_groups/{id}
Get a Consumer Group — GET /apisix/admin/consumer_groups/{id}
Update a Consumer Group (Partial) — PATCH /apisix/admin/consumer_groups/{id}
Delete a Consumer Group — DELETE /apisix/admin/consumer_groups/{id}
List All Plugin Configs — GET /apisix/admin/plugin_configs
Create or Replace a Plugin Config — PUT /apisix/admin/plugin_configs/{id}
Get a Plugin Config — GET /apisix/admin/plugin_configs/{id}
Update a Plugin Config (Partial) — PATCH /apisix/admin/plugin_configs/{id}
Delete a Plugin Config — DELETE /apisix/admin/plugin_configs/{id}
List All Plugin Metadata — GET /apisix/admin/plugin_metadata
Create or Replace Plugin Metadata — PUT /apisix/admin/plugin_metadata/{plugin_name}
Get Plugin Metadata — GET /apisix/admin/plugin_metadata/{plugin_name}
Delete Plugin Metadata — DELETE /apisix/admin/plugin_metadata/{plugin_name}
List Plugin Names — GET /apisix/admin/plugins/list
Get Plugin JSON Schema — GET /apisix/admin/plugins/{plugin_name}
List Plugin Attributes — GET /apisix/admin/plugins
Hot-Reload Plugins — PUT /apisix/admin/plugins/reload
List All Stream Routes — GET /apisix/admin/stream_routes
Create a Stream Route — POST /apisix/admin/stream_routes
List All Secrets — GET /apisix/admin/secrets
Create or Replace a Proto — PUT /apisix/admin/protos/{id}
Get a Proto — GET /apisix/admin/protos/{id}
Delete a Proto — DELETE /apisix/admin/protos/{id}
List All Protos — GET /apisix/admin/protos
Create a Proto — POST /apisix/admin/protos
Validate Resource Configuration — POST /apisix/admin/schema/validate/{resource}
Get Stream Route by ID — GET /apisix/admin/stream_routes/{id}
Create Stream Route by ID — PUT /apisix/admin/stream_routes/{id}
Delete Stream Route by ID — DELETE /apisix/admin/stream_routes/{id}
List Consumer Credentials — GET /apisix/admin/consumers/{username}/credentials
Get a Credential — GET /apisix/admin/consumers/{username}/credentials/{id}
Create or Replace a Credential — PUT /apisix/admin/consumers/{username}/credentials/{id}
Delete a Credential — DELETE /apisix/admin/consumers/{username}/credentials/{id}
Get a Secret — GET /apisix/admin/secrets/{secret_type}/{id}
Create or Replace a Secret — PUT /apisix/admin/secrets/{secret_type}/{id}
Update a Secret (Partial) — PATCH /apisix/admin/secrets/{secret_type}/{id}
Delete a Secret — DELETE /apisix/admin/secrets/{secret_type}/{id}
Liveness probe — HEAD /apisix/admin
Get the standalone configuration — GET /apisix/admin/configs
Replace the standalone configuration — PUT /apisix/admin/configs
Probe standalone configuration availability — HEAD /apisix/admin/configs
Validate a Configuration Without Applying It — POST /apisix/admin/configs/validate
Replace a single nested field of a route — PATCH /apisix/admin/routes/{id}/{sub_path}
Replace a single nested field of a service — PATCH /apisix/admin/services/{id}/{sub_path}
Replace a single nested field of an upstream — PATCH /apisix/admin/upstreams/{id}/{sub_path}
Replace a single nested field of an SSL certificate — PATCH /apisix/admin/ssls/{id}/{sub_path}
Replace a single nested field of a consumer group — PATCH /apisix/admin/consumer_groups/{id}/{sub_path}
Replace a single nested field of a global rule — PATCH /apisix/admin/global_rules/{id}/{sub_path}
Replace a single nested field of a plugin config — PATCH /apisix/admin/plugin_configs/{id}/{sub_path}
List secrets of a single secret-manager type — GET /apisix/admin/secrets/{secret_type}
Replace a single nested field of a secret — PATCH /apisix/admin/secrets/{secret_type}/{id}/{sub_path}
Get the JSON Schema of a built-in resource — GET /apisix/admin/schema/{resource}
Get a plugin's JSON Schema (alternative path) — GET /apisix/admin/schema/plugins/{plugin_name}