Memos
Instance Service

Get Instance Setting

Gets an instance setting.

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

Path Parameters

instance*string

The instance id.

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/instance/string/*"
{
  "name": "string",
  "generalSetting": {
    "disallowUserRegistration": true,
    "disallowPasswordAuth": true,
    "additionalScript": "string",
    "additionalStyle": "string",
    "customProfile": {
      "title": "string",
      "description": "string",
      "logoUrl": "string"
    },
    "weekStartDayOffset": 0,
    "disallowChangeUsername": true,
    "disallowChangeNickname": true
  },
  "storageSetting": {
    "storageType": "STORAGE_TYPE_UNSPECIFIED",
    "filepathTemplate": "string",
    "uploadSizeLimitMb": "string",
    "s3Config": {
      "accessKeyId": "string",
      "accessKeySecret": "string",
      "endpoint": "string",
      "region": "string",
      "bucket": "string",
      "usePathStyle": true
    }
  },
  "memoRelatedSetting": {
    "contentLengthLimit": 0,
    "enableDoubleClickEdit": true,
    "reactions": [
      "string"
    ]
  },
  "tagsSetting": {
    "tags": {
      "property1": {
        "backgroundColor": {
          "red": 0.1,
          "green": 0.1,
          "blue": 0.1,
          "alpha": 0.1
        },
        "blurContent": true
      },
      "property2": {
        "backgroundColor": {
          "red": 0.1,
          "green": 0.1,
          "blue": 0.1,
          "alpha": 0.1
        },
        "blurContent": true
      }
    }
  },
  "notificationSetting": {
    "email": {
      "enabled": true,
      "smtpHost": "string",
      "smtpPort": 0,
      "smtpUsername": "string",
      "smtpPassword": "string",
      "fromEmail": "string",
      "fromName": "string",
      "replyTo": "string",
      "useTls": true,
      "useSsl": true
    }
  },
  "aiSetting": {
    "providers": [
      {
        "id": "string",
        "title": "string",
        "type": "AI_PROVIDER_TYPE_UNSPECIFIED",
        "endpoint": "string",
        "apiKey": "string",
        "apiKeySet": true,
        "apiKeyHint": "string"
      }
    ],
    "transcription": {
      "providerId": "string",
      "model": "string",
      "language": "string",
      "prompt": "string"
    }
  }
}
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

On this page

No Headings