Storyden
Admin

Admin Settings Get

Retrieve all configuration settings for installation. This includes the publicly accessible information for the instance as well as admin-only access to sensitive configuration (environment variables) and settings.

GET
/admin

Retrieve all configuration settings for installation. This includes the publicly accessible information for the instance as well as admin-only access to sensitive configuration (environment variables) and settings.

Authorization

cookiestoryden-session<token>

Response Body

OK

application/json
  1. response

Storyden installation and administration settings.

title*string
description*string
content*PostContent

Rich HTML content.

Storyden owns the HTML id attribute in this content. Client-supplied id attributes are ignored and removed during sanitisation.

For block-aware resources such as threads, replies, library nodes, and node versions, successful create and update operations assign stable server-owned block IDs to addressable block elements using the sdb_ prefix, for example <p id="sdb_d46b4s1fs0s8b8j6k2g0">. On updates, Storyden preserves existing sdb_ block IDs where the corresponding block can be matched across edits, so links and references to specific blocks can remain stable as content moves.

Read operations do not assign missing block IDs. Content created before block IDs were assigned, or content where a particular block has no server-owned ID yet, may be returned without block IDs until that resource is next written.

accent_colour*string
banner_asset?

The assigned banner image, including its original parent when cropped.

authentication_mode*AuthMode
Value in"handle""email""phone"
registration_mode*RegistrationMode

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.

Value in"public""invitation""disabled"
web_address*string

The public web frontend address for this Storyden instance.

Formaturi
api_address*string

The public API address for this Storyden instance.

Formaturi
capabilities?array<>
services?
metadata?

Arbitrary metadata for the resource.

motd?
headers?

A sample of network headers received by the backend from the client or proxy. This is used for configuring the client IP mode.

Example Request
curl -X GET 'https://example.com/api/admin'
Example Response
{  "title": "string",  "description": "string",  "content": "string",  "accent_colour": "string",  "banner_asset": {    "id": "string",    "filename": "string",    "path": "string",    "mime_type": "string",    "width": 0,    "height": 0,    "parent": {}  },  "authentication_mode": "handle",  "registration_mode": "public",  "web_address": "http://example.com",  "api_address": "http://example.com",  "capabilities": [    "plugins"  ],  "services": {    "media": {      "image_max_size": 1,      "image_max_pixels": 1,      "image_memory_budget": 0,      "image_estimated_memory": 0    },    "oauth": {      "dynamic_registration_enabled": true,      "autonomous_registration_mode": "disabled",      "autonomous_registration_role_id": null,      "registration_approval_ttl": 1,      "registration_approval_url": "string"    },    "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      }    },    "discovery": {      "search_indexing": true,      "training_crawling": true,      "llms_txt": true,      "auth_md": true,      "ai_catalog": true,      "api_catalog": true,      "mcp_server_card": true,      "robots_txt": "string"    },    "moderation": {      "thread_body_length_max": 0,      "reply_body_length_max": 0,      "signature_length_max": 0,      "word_block_list": [        "string"      ],      "word_report_list": [        "string"      ]    },    "robots": {      "default_model": "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"    }  }}