/api/v1/selphid/config

This endpoint does not modify the configuration of selphId-sdk or of the service: currently none of the parameters returned by GET /api/v1/selphid/config can be updated at runtime, and the request responds 200 even though it applies no change.

Parameter	Access
FACEPHI_SELPHID_DEBUGPATH_KEY	Read-only
FACEPHI_SELPHID_FACIALAUTHENTICATION_THRESHOLD	Read-only
FACEPHI_SELPHID_FACIALEXTRACTOR_NUM_THREADS	Read-only
FACEPHI_SELPHID_FACIALLIVENESS_DEPTH	Read-only
FACEPHI_SELPHID_FACIALLIVENESS_IAD	Read-only
FACEPHI_SELPHID_FACIALLIVENESS_NUM_THREADS	Read-only
FACEPHI_SELPHID_FACIALLIVENESS_PATH_KEY	Read-only
FACEPHI_SELPHID_FACIALLIVENESS_THRESHOLD	Read-only
FACEPHI_SELPHID_FACIAL_LICPATH_KEY	Read-only
FACEPHI_SELPHID_FUTURE_TIME_ALLOWED	Read-only
FACEPHI_SELPHID_GALLERY_REMOVE_METHOD	Read-only
FACEPHI_SELPHID_USAGEPATH_KEY	Read-only
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_level	Read-only
logger_rotation	Read-only
logger_max_files	Read-only

• The FACEPHI_SELPHID_* parameters are configured at startup through environment variables, and the service parameters through config.json or the FACEPHI_SELPHID_REST_* environment variables. Changing them requires restarting the service.

• Some FACEPHI_SELPHID_* parameters only appear in the GET response if they were defined at startup.

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

post

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Corpo

The configuration parameters of the SDK and the service. The JWT authentication configuration is intentionally omitted.

FACEPHI_SELPHID_DEBUGPATH_KEYstringOpcional

Path and file where the SelphID logs are written.

Example: ./SelphIDDebug.log

FACEPHI_SELPHID_FACIALAUTHENTICATION_THRESHOLDstringOpcional

Threshold for facial authentication.

Example: 65

FACEPHI_SELPHID_FACIALEXTRACTOR_NUM_THREADSstringOpcional

Number of cores assigned to extraction/authentication operations.

Example: 4

FACEPHI_SELPHID_FACIALLIVENESS_DEPTHstringOpcional

Liveness engine pipeline mode.

Example: partial

FACEPHI_SELPHID_FACIALLIVENESS_IADstringOpcional

Status of the liveness injection attack detection (IAD) filters.

Example: enable

FACEPHI_SELPHID_FACIALLIVENESS_PATH_KEYstringOpcional

Path where the models and other pipeline data are installed.

Example: /home/install/selpid-sdk/data

FACEPHI_SELPHID_FACIALLIVENESS_THRESHOLDstringOpcional

Threshold for liveness operations.

Example: 50

FACEPHI_SELPHID_FACIAL_LICPATH_KEYstringOpcional

License path.

Example: /license.lic

FACEPHI_SELPHID_FUTURE_TIME_ALLOWEDstringOpcional

Global value to accept templateRaws with future dates.

Example: 0

FACEPHI_SELPHID_GALLERY_REMOVE_METHODstringOpcional

Removal method for 1:N galleries.

Example: erase

FACEPHI_SELPHID_USAGEPATH_KEYstringOpcional

Path of the usage database.

Example: ./SelphIDUsage.db

client_max_body_sizeintegerOpcional

Maximum size of the request data (Mb).

Example: 100

connection_timeoutintegerOpcional

Maximum timeout for connections (0=infinite).

Example: 0

keep_alive_request_numberintegerOpcional

How a connection can be used in terms of timeout and maximum number of requests.

Example: 0

logger_levelstringOpcional

Logging level (logger).

Example: off

logger_max_filesintegerOpcional

Maximum number of files used in log rotation.

Example: 7

logger_pathstringOpcional

Path where the service logs are stored.

Example: ./logs

logger_rotationstringOpcional

Log rotation strategy (logger).

Example: daily

number_of_threadsintegerOpcional

Number of cores assigned to concurrent requests.

Example: 1

portintegerOpcional

Service listening port.

Example: 6982

Respostas

200

A message with the description.

application/json

messagestringOpcionalExample: The configuration has been set.

400

Incorrect parameters in the request.

application/json

500

An error occurred in the call to the SelphID-SDK backend.

application/json

post/api/v1/selphid/config

POST /api/v1/selphid/config HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 774

{
  "FACEPHI_SELPHID_DEBUGPATH_KEY": "./SelphIDDebug.log",
  "FACEPHI_SELPHID_FACIALAUTHENTICATION_THRESHOLD": "65",
  "FACEPHI_SELPHID_FACIALEXTRACTOR_NUM_THREADS": "4",
  "FACEPHI_SELPHID_FACIALLIVENESS_DEPTH": "partial",
  "FACEPHI_SELPHID_FACIALLIVENESS_IAD": "enable",
  "FACEPHI_SELPHID_FACIALLIVENESS_PATH_KEY": "/home/install/selpid-sdk/data",
  "FACEPHI_SELPHID_FACIALLIVENESS_THRESHOLD": "50",
  "FACEPHI_SELPHID_FACIAL_LICPATH_KEY": "/license.lic",
  "FACEPHI_SELPHID_FUTURE_TIME_ALLOWED": "0",
  "FACEPHI_SELPHID_GALLERY_REMOVE_METHOD": "erase",
  "FACEPHI_SELPHID_USAGEPATH_KEY": "./SelphIDUsage.db",
  "client_max_body_size": 100,
  "connection_timeout": 0,
  "keep_alive_request_number": 0,
  "logger_level": "off",
  "logger_max_files": 7,
  "logger_path": "./logs",
  "logger_rotation": "daily",
  "number_of_threads": 1,
  "port": 6982
}

{
  "message": "The configuration has been set."
}