Replace the standalone configuration

PUT /apisix/admin/configs

Interactive request editor loads with JavaScript.

Authorization

X-API-KEY<token>

Admin API key configured in config.yaml under deployment.admin.admin_key. You can also pass the key as a query parameter api_key or cookie x_api_key.

In: header

Request Body

Response Body

`application/json`

curl -X PUT "http://127.0.0.1:9180/apisix/admin/configs" \  -H "Content-Type: application/json" \  -d '{}'

Configuration applied.

**Bad Request** — The request body is invalid or missing required fields.

{
  "error_msg": "invalid configuration: property \"uri\" is required"
}

{
  "error_msg": "invalid request body: unexpected character at line 1 column 2"
}

**Unauthorized** — The API key is missing, invalid, or lacks permission.

{
  "error_msg": "failed to check token",
  "description": "missing apikey"
}

{
  "error_msg": "failed to check token",
  "description": "wrong apikey"
}

{
  "error_msg": "failed to check token",
  "description": "invalid method for role viewer"
}

Complete operation details and schema variants

PUT /apisix/admin/configs

Replace the standalone configuration

Replaces the entire current configuration. Available only when deployment.role_data_plane.config_provider is yaml.

Parameters

Request body

Content type: application/json

Content type: application/yaml

Responses

200: Configuration applied.
400: Bad Request — The request body is invalid or missing required fields.
error_msg (string, required): Human-readable error message describing what went wrong.
401: Unauthorized — The API key is missing, invalid, or lacks permission.
error_msg (string, required): Authentication error message.
description (string, optional): Detailed reason for the authentication failure.

cURL

curl -X PUT 'http://127.0.0.1:9180/apisix/admin/configs'

Replace the standalone configuration

200

400application/json

401application/json

`application/json`

`application/json`