---
title: "GET /api/v1/instance/{instance}/*"
method: GET
path: "/api/v1/instance/{instance}/*"
tags: ["InstanceService"]
---

# GET /api/v1/instance/{instance}/*

`GET /api/v1/instance/{instance}/*`

Gets an instance setting.

## Path parameters

- `instance` string, required

## Response `200`

OK

- InstanceSetting — An instance setting resource.
  - `name` string — The name of the instance setting. Format: instance/settings/{setting}
  - `generalSetting` InstanceSettingGeneralSetting — General instance settings configuration.
    - `disallowUserRegistration` boolean — disallow_user_registration disallows user registration.
    - `disallowPasswordAuth` boolean — disallow_password_auth disallows password authentication.
    - `additionalScript` string — additional_script is the additional script.
    - `additionalStyle` string — additional_style is the additional style.
    - `customProfile` GeneralSettingCustomProfile — Custom profile configuration for instance branding.
      - `title` string
      - `description` string
      - `logoUrl` string
    - `weekStartDayOffset` integer — week_start_day_offset is the week start day offset from Sunday. 0: Sunday, 1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday Default is Sunday.
    - `disallowChangeUsername` boolean — disallow_change_username disallows changing username.
    - `disallowChangeNickname` boolean — disallow_change_nickname disallows changing nickname.
  - `storageSetting` InstanceSettingStorageSetting — Storage configuration settings for instance attachments.
    - `storageType` 'STORAGE_TYPE_UNSPECIFIED' | 'DATABASE' | 'LOCAL' | 'S3', enum — storage_type is the storage type.
    - `filepathTemplate` string — The template of file path. e.g. assets/{timestamp}_{filename}
    - `uploadSizeLimitMb` string — The max upload size in megabytes.
    - `s3Config` StorageSettingS3Config — S3 configuration for cloud storage backend. Reference: https://developers.cloudflare.com/r2/examples/aws/aws-sdk-go/
      - `accessKeyId` string
      - `accessKeySecret` string
      - `endpoint` string
      - `region` string
      - `bucket` string
      - `usePathStyle` boolean
  - `memoRelatedSetting` InstanceSettingMemoRelatedSetting — Memo-related instance settings and policies.
    - `disallowPublicVisibility` boolean — disallow_public_visibility disallows set memo as public visibility.
    - `displayWithUpdateTime` boolean — display_with_update_time orders and displays memo with update time.
    - `contentLengthLimit` integer — content_length_limit is the limit of content length. Unit is byte.
    - `enableDoubleClickEdit` boolean — enable_double_click_edit enables editing on double click.
    - `reactions` string[] — reactions is the list of reactions.
  - `tagsSetting` InstanceSettingTagsSetting — Tag metadata configuration.
    - `tags` object
  - `notificationSetting` InstanceSettingNotificationSetting — Notification transport configuration.
    - `email` NotificationSettingEmailSetting — Email delivery configuration for notifications.
      - `enabled` boolean
      - `smtpHost` string
      - `smtpPort` integer
      - `smtpUsername` string
      - `smtpPassword` string
      - `fromEmail` string
      - `fromName` string
      - `replyTo` string
      - `useTls` boolean
      - `useSsl` boolean

## Other responses

- `default` — Default error response

## Changes

- **2026-03-19** `2a4722b25b3d` — 1 info
  - added the optional property `notificationSetting` to the response with the `200` status
- **2026-03-19** `6594b37a0c4b` — 1 info
  - added the optional property `tagsSetting` to the response with the `200` status
- **2025-12-29** `f4c538810a2d` — 2 warning
  - removed the optional property `memoRelatedSetting/enableBlurNsfwContent` from the response with the `200` status
  - removed the optional property `memoRelatedSetting/nsfwTags` from the response with the `200` status
- **2025-12-15** `d740073f088f` — 4 warning, 5 info
  - removed the optional property `aiSetting` from the response with the `200` status
  - removed the optional property `notificationSetting` from the response with the `200` status
  - removed the optional property `storageSetting/s3Config/allOf[#/components/schemas/StorageSetting_S3Config]/insecureSkipTlsVerify` from the response with the `200` status
  - removed the optional property `tagsSetting` from the response with the `200` status
  - …5 more

[Change history](https://skmtc.dev/usememos/apis/untitled-api/changes/api/v1/instance/:instance/*/get.md)

---

[API](https://skmtc.dev/usememos/apis/untitled-api.md) · [All operations](https://skmtc.dev/usememos/apis/untitled-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/usememos/untitled-api/revisions/195e3cc8223d/schema)