Update the configuration

Updates the service configuration in memory. The config_json_string field contains, serialized as a JSON string, the parameters to modify; those not included keep their value.

Not all the parameters returned by GET /api/v1/iad/config can be modified with this endpoint. The following table shows the access of each one:

Parameter	Access
metrics_saturation_queue_p95_ms	Read-write
metrics_saturation_min_inflight_ratio	Read-write
metrics_error_rate_warning	Read-write
metrics_idle_rps_threshold	Read-write
metrics_quality_alert_window_seconds	Read-write
port	Read-only
number_of_threads	Read-only
connection_timeout	Read-only
keep_alive_request_number	Read-only
client_max_body_size	Read-only
logger_path	Read-only
logger_file_prefix	Read-only
logger_level	Read-only
logger_rotation	Read-only
logger_max_files	Read-only
metrics_enabled	Read-only
engine_url	Read-only
engine_connection_timeout	Read-only
engine_request_timeout	Read-only
engine_max_retries	Read-only
engine_retry_delay	Read-only
engine_verify_ssl	Read-only
engine_verbose	Read-only
engine_pool_size	Read-only

• Read-write parameters are applied without restarting the service. If the equivalent environment variable is defined (for example, FACEPHI_IAD_REST_METRICS_ERROR_RATE_WARNING), its value takes precedence over the one sent.

• The metrics_* parameters are the thresholds GET /api/v1/iad/metrics uses to classify the service state.

• Read-only parameters are only configured at startup, through config.json or the FACEPHI_IAD_REST_* and FACEPHI_IAD_ENGINE_* environment variables. If they are sent to this endpoint, the request responds 200 and GET returns the value sent, but the service keeps using the value it started with.

• GET returns the values defined in config.json and those sent to this endpoint; it does not reflect values set through environment variables.

• Changes are not saved to config.json and are lost when the service restarts.

• JWT authentication settings (auth_*) are startup-only: GET does not return them and this endpoint rejects with 400 the requests that include them.

post

Body

config_json_stringstringRequired

JSON string with the configuration parameters to modify. Only the read-write parameters listed in POST /api/v1/iad/config are applied. JWT authentication keys (auth_*) are rejected and must be configured at startup only.

Example: {"metrics_error_rate_warning":0.1,"metrics_quality_alert_window_seconds":600}

Responses

200

Configuration updated successfully

application/json

messagestringOptional

Service response message.

Example: 2.2.0 Copyright © 2026 FacePhi Biometria. All rights reserved.

400

Incorrect parameters were received in the request.

application/json

500

An error occurred in the backend.

application/json

post/api/v1/iad/config

POST /api/v1/iad/config HTTP/1.1
Host: 127.0.0.1:6982/
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "config_json_string": "{\"metrics_error_rate_warning\":0.1,\"metrics_quality_alert_window_seconds\":600}"
}

{
  "message": "2.2.0 Copyright © 2026 FacePhi Biometria. All rights reserved."
}