InstanceSetting

Match the key and payload

For instance/settings/GENERAL use generalSetting; STORAGE uses storageSetting, NOTIFICATION uses notificationSetting, AI uses aiSetting, ACCESS uses accessSetting, MEMO_RELATED uses memoRelatedSetting and TAGS uses tagsSetting. The request selects one payload, not every property shown here. UpdateInstanceSetting replaces that payload and ignores updateMask. Redacted credentials are not recoverable from this response.

Where this schema is used

These links are derived from direct references in the protocol snapshot. Follow the calling operation for authentication, accepted fields and runtime behavior; a reusable resource schema is not by itself a complete write request.

• GETGet Instance Setting/api/v1/instance/settings/{key}
• PATCHUpdate Instance Setting/api/v1/instance/settings/{key}

Referenced by these component schemas:

• BatchGetInstanceSettingsResponse

Shape and fields

object

An instance setting resource.

Complete schema

Use this complete JSON definition for constraints and nested structure. A field's presence here does not mean it is writable by every caller.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the instance setting.\n Format: instance/settings/{setting}"
    },
    "generalSetting": {
      "$ref": "#/components/schemas/InstanceSetting_GeneralSetting"
    },
    "storageSetting": {
      "$ref": "#/components/schemas/InstanceSetting_StorageSetting"
    },
    "memoRelatedSetting": {
      "$ref": "#/components/schemas/InstanceSetting_MemoRelatedSetting"
    },
    "tagsSetting": {
      "$ref": "#/components/schemas/InstanceSetting_TagsSetting"
    },
    "notificationSetting": {
      "$ref": "#/components/schemas/InstanceSetting_NotificationSetting"
    },
    "aiSetting": {
      "$ref": "#/components/schemas/InstanceSetting_AISetting"
    },
    "accessSetting": {
      "$ref": "#/components/schemas/InstanceSetting_AccessSetting"
    }
  },
  "description": "An instance setting resource."
}