11.1. システム設定更新

PUT /1/_sysadm/_/systemconfig

システム設定を更新する

Request Headers:
 
  • X-Developer-Token -- 管理者用セッショントークン（必須）
  • Content-Type -- application/json, application/yaml のいずれか
Request JSON Object:
 
  • systemConfig (object) -- システム設定
Status Codes:

リクエストボディ

JSON もしくは YAML 形式で記述された更新データを指定する。

YAML形式によるリクエストの例を以下に示す。

systemConfig:
  apiBaseUrl: 'https://api.example.com/api'
  apiInternalBaseUrl: 'http://10.0.0.5/api'
  consoleBaseUrl: 'http://baas.example.com/console'
  consoleHelpUrl: 'http://baas.example.com/manual/index.html'
  ssePushPublicUri: 'https://api.example.com/ssepush/events'
  systemKey: examplesystemkey
  allowSelfSignup: false
  mongoDefaultQueryTimeoutInSec: 0
  amqpAddrs: 'localhost:5672'
  amqpUsername: rabbitmq
  amqpPassword: rabbitmq
  amqpVhost: /
  smtpHost: 'http://smtp.host.example.com'
  smtpPort: '25'
  smtpUsername: ''
  smtpPassword: ''
  mailFrom: admin@example.com
  proxyHost: proxy.example.com
  proxyPort: 8080
  nonProxyHosts: localhost;127.0.0.1;*test.com
  noChargeKey: ''
  clientCertServerKey: aaaaaaaa-1234-5678-9abc-abcddefghijk
  fileMaxSize: 100
プロパティ 名称 型 レスポンス
apiBaseUrl APIサーバ ベースURI 文字列 表示
apiInternalBaseUrl APIサーバ 内部向けベースURI 文字列 表示
consoleBaseUrl コンソールサーバ ベースURI 文字列 表示
consoleHelpUrl デベロッパーコンソール ヘルプURL 文字列 表示
ssePushPublicUri SSE Push サーバ 公開URI 文字列 表示
systemKey システムキー 文字列 表示
allowSelfSignup セルフサインアップ許可 真偽値（boolean） 表示
mongoDefaultQueryTimeoutInSec MongoDB デフォルトクエリタイムアウト 数値 表示
amqpAddrs AMQPサーバアドレス 文字列 表示
amqpUsername AMQPサーバ接続認証ユーザ名 文字列 表示
amqpPassword AMQPサーバ接続認証パスワード 文字列 表示
amqpVhost AMQP Vhost 文字列 表示
smtpHost SMTPサーバホスト 文字列 表示
smtpPort SMTPサーバポート番号 数値 表示
smtpUsername SMTP認証ユーザ名 文字列 表示
smtpPassword SMTP認証パスワード 文字列 非表示
mailFrom メール送信Fromメールアドレス 文字列 表示
proxyHost プロキシサーバホスト 文字列 表示
proxyPort プロキシサーバポート番号 数値 表示
nonProxyHosts プロキシ例外リスト 文字列 表示
noChargeKey 課金迂回キー 文字列 表示
clientCertServerKey クライアント証明書認証 サーバーキー 文字列 表示
fileMaxSize ファイルストレージ ファイル最大サイズ（MB） 数値 表示

レスポンスボディ

作成したシステム設定情報を含む JSON データが返却される。

例を以下に示す。

{
  "systemConfig": {
    "apiBaseUrl": "https://example.com/api",
    "apiInternalBaseUrl": "http://localhost:8080/api",
    "ssePushPublicUri": "https://example.com/ssepush/events",
    "systemKey": "systemkey",
    /*…*/
  }
}

注意事項

  • システム管理者権限が必要。
  • リクエストボディで指定するフィールドのみを更新する。