Admin Settings Update
Update non-env configuration settings for installation.
Update non-env configuration settings for installation.
/adminIn: cookie
Request Body
application/json
The body text of a post within a thread. The type is either a string or an object, depending on what was used during creation. Strings can be used for basic plain text or markdown content and objects are used for more complex types such as Slate.js editor documents.
"handle" | "email" | "phone"The mode of registration for the instance, which determines how new accounts can be created. This is a global setting that affects the whole instance and is used to control whether new users can register on their own, need an invitation, or if registration is completely disabled.
When set to "public", anyone can register for a new account without any special prerequisites. When set to "invitation", new accounts can only be created if they have a valid invitation code, which can be generated by existing users with the required permission. When set to "disabled", new account registration is completely disabled and accounts can only be provisioned using the API.
"public" | "invitation" | "disabled"The settings metadata may be used by frontends to store arbitrary vendor-specific configuration data specific to the frontend itself.
Response Body
application/json
application/json
curl -X PATCH "https://loading/api/admin" \ -H "Content-Type: application/json" \ -d '{}'{
"title": "string",
"description": "string",
"content": "string",
"accent_colour": "string",
"authentication_mode": "handle",
"registration_mode": "public",
"capabilities": [
"plugins"
],
"services": {
"client_ip": {
"client_ip_mode": "remote_addr",
"client_ip_header": "string",
"trusted_proxy_cidrs": [
"string"
]
},
"rate_limiting": {
"rate_limit": 0,
"rate_limit_period": 0,
"rate_limit_bucket": 0,
"rate_limit_guest_cost": 0,
"cost_overrides": {
"property1": 0,
"property2": 0
}
},
"moderation": {
"thread_body_length_max": 0,
"reply_body_length_max": 0,
"signature_length_max": 0,
"word_block_list": [
"string"
],
"word_report_list": [
"string"
]
}
},
"metadata": {},
"motd": {
"content": "string",
"start_at": "2019-08-24T14:15:22Z",
"end_at": "2019-08-24T14:15:22Z",
"metadata": {}
},
"headers": {
"raw_client_address": "string",
"headers": {
"property1": "string",
"property2": "string"
},
"headers_ssr": {
"property1": "string",
"property2": "string"
}
}
}{
"error": "string",
"message": "string",
"suggested": "string",
"metadata": {}
}