Skip to content

PUT /config/{key}/file

Update Config File

PUT
/config/{key}/file

Upload or remove a file-backed configuration entry.

Stores the uploaded file at {media_root}/config/{key}/{filename} and
updates the Config document's value field with the resulting path.
If file is omitted, the existing file is deleted and value is set to
null. Replaces any previously stored file for the same key.

Emits: (direct transaction — no event class)

Required scope: admin:config:write

Authorizations

OAuth2PasswordBearer
password Flow
Token URL"/api/auth"
Scopes:
  • "admin"User can access and edit users and system settings
  • "library"User can access and edit products
  • "production"User can access and edit production plans
  • "operator"User can access the operator panel and make production declarations

Parameters

Path Parameters

key*
Type
string
Required

Request Body

multipart/form-data
object
string |null

Responses

Successful Response

application/json
JSON
{
  
"status": 200,
  
"message": "string",
  
"detail": "string"
}

Samples

Powered by VitePress OpenAPI