API docs by Redocly

amnimo G/R/C/X series WebAPI Reference (3.5.0)

Download OpenAPI specification:

amnimo user support: support@amnimo.com URL: http://amnimo.com/ License: Copyright (c) 2020 amnimo inc. All Rights Reserved.

amnimo G/R/C/X seriesで使用されるWebAPIのドキュメントです。
認証にCookieを使用しますのでCookieを有効にしてください。

get

HTTPメソッドの基本ポリシー

メソッド 説明
GET リソースの取得
POST リソースの新規登録
PUT 既存リソースの更新
項目値の変更は可能だが項目の削除はできないので注意する。
DELETE リソースの削除
PATCH リソースの一部更新

PUT/DELETE/PATCHメソッドが使用できない場合

下記の様にX-HTTP-Method-Overrideリクエストヘッダを使用します。

POST /v1/sample/123456 HTTP/1.1
X-HTTP-Method-Override: DELETE

もしくは"_method"パラメータを使用します。

POST /v1/sample/123456 HTTP/1.1
Host: api.example.com

_method=DELETE

HTTPステータスコード

1xx Informational 情報

リクエストは正常に受け取られ処理は継続されます。

コード 文字列 説明
102 Processing 処理中
処理が計測されて行われています。

2xx Success 成功

リクエストは正常に受け取られ処理が受理されました。

コード 文字列 説明
200 OK 成功
リクエストは成功しました。
要求に応じた応答データが返されます。
201 Created 作成
リクエストは完了し、新たに作成されたリースのURLが返されます。
204 No Content 内容なし
リクエストは受信したが返すべきレスポンスが存在しない場合に返されます。

3xx Redirection リダイレクション

リクエストを完了するためには追加処理が必要です。

コード 文字列 説明
301 Moved Permanently 恒久的に移動しました
リクエストしたエンドポイントが恒久的に移動されたときに返されます。
HTTPからHTTPSへのリダイレクション等にも使用されます。

4xx Client Error クライアントエラー

クライアントからのリクエストに誤りがあります。

コード 文字列 説明
400 Bad Request リクエストが不正です
リクエスト内容がおかしい場合に返されます。
401 Unauthorized 認証が必要です
認証使用が必要な時に返されます。
403 Forbidden 禁止されています
リソースにアクセスする事が拒否されました。
アクセス権がない場合に返されます。
404 Not Found 未検出
リソースが見つからなかった場合に返されます。
405 Method Not Allowd 許可されていないメソッド
許可されていないメソッドを使用した場合に返されます。
406 Not Acceptable 受理不可
Accept関連のヘッダに受理できない内容が含まれていた場合に返されます。
例：リクエストのAcceptヘッダにapplication/json以外が設定されていた。
例：リクエストのAccept-CharsetヘッダにUTF-8以外が設定されていた。
409 Conflict 競合
要求型のリソースと競合するので完了できない場合に返されます。

5xx Server Error サーバエラー

サーバがリクエストの処理に失敗しました。

コード 文字列 説明
500 Internal Server Error サーバ内部エラー
サーバ内部にてエラーが発生した場合に返されます。
501 Not Implemented 未実装
実装されていないメソッドを使用した場合に返されます。

クエリパラメータ

パラメータ 変数
取得数 limit
取得位置（相対位置） offset
取得位置（絶対位置） since_id
since_ideには「このIDより前のもの」や「このIDより古いもの」と言った指定をします。

絞り込みパラメータ

下記の様にエンドポイントに対してsearchパラメータを使用します。
http://api.example.com/v1/sample?search=hoge

レスポンスBODYのstatusオブジェクト・コード一覧

E2xx WebAPI 情報

コード 説明
E102 処理中

E2xx WebAPI 正常終了

コード 説明
E200 正常終了
E201 作成
E204 内容なし
E210 管理者パスワードが未登録状態
E220 GETで取得する処理の状態が処理中
E230 直前の処理が失敗
E231 処理が成功しましたが、rebootが必要
E232 サービス起動失敗

E4xx WebAPI Client Error

コード 説明
E400 HTTPメソッドエラー
E401 HTTPヘッダエラー
E402 認証エラー
E403 権限エラー
E404 パラメータエラー
E405 クエリエラー
E406 サーチエラー
E409 競合（既に存在）
E410 競合（処理中）

E5xx WebAPI Server Error

コード 説明
E500 不明なエラー
E501 システムエラー
E520 JSONライブラリエラー
E521 JSONフォーマットエラー

E53x YAML Library Error

コード 説明
E530 YAMLライブラリエラー
E531 YAMLフォーマットエラー
E532 YAML読込みエラー
E533 YAML書込みエラー
E534 必須項目確認エラー

E54x,E56x Configuration Error

コード 説明
E540 管理者パスワードが既に登録済状態
E541 パスワード強度が弱い
E542 デバイス使用中
E543 破損ファイル
E544 不正なURL
E545 容量不足
E546 外部コマンド実行時パラメーター不正
E547 外部コマンド実行時必須項目足りない
E548 モバイル通信でGWにアクセス中
E549 未フォーマット
E560 Nxwitness DBなし
E561 Nxwitness パスワード違い
E562 ネットワークアドレス重複
E563 ブリッジインタフェース使用中
E564 無線LANモード違い
E565 アクセスポイント無効
E566 すでにパーティションが存在する
E567 パーティションサイズ不足

E55x Network Service Error

コード 説明
E550 外部サービスが見つからない
E551 DNSサーバーが見つからない

Responses

Response samples

Content type
application/json
Example
{
  • "result": {
    }
}

ユーザ認証要求

ユーザ認証を行いAPIアクセストークンを発行します。

レスポンスにアクセストークンが設定されますので、取得したトークンをヘッダに設定して以降のリクエストを送信してください。

Request Body schema: application/json
required
username
required
string

ユーザID

password
required
string <password>

パスワード

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

認証情報削除

認証情報（APIアクセストークン）を削除し無効化します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

管理者パスワード登録状態取得

管理者パスワード登録状態を取得します。
レスポンス内容のメッセージコードにより状態が識別できます。

E200 未登録状態
E402 登録済状態

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

管理者パスワード初回登録

管理者パスワード未登録時に管理者パスワードを登録します。

Request Body schema: application/json
password
required
string <password>

パスワード

Responses

Request samples

Content type
application/json
{
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

ISP一覧

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

簡易設定取得

簡易設定を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

簡易設定

簡易設定を行います。

Request Body schema: application/json
required
object (mobilesPeer)
Array of objects (interface)
Array of objects (aptAuth)
object
object (dms)

DMS設定

object (nxwitness)

NxWitness設定

Responses

Request samples

Content type
application/json
{
  • "mobile": {
    },
  • "interfaces": [
    ],
  • "aptAuths": [
    ],
  • "dhcpv4": {
    },
  • "dms": {
    },
  • "nxwitness": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

ダッシュボードの表示情報取得

ダッシュボードの表示情報を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

インタフェースのステータス一覧取得

インタフェースのステータス一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

IPSECのステータス取得

IPSECステータスを取得します

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

xfrmステートの取得

xfrmステートを取得します

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

xfrmポリシーの取得

xfrmポリシーを取得します

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

IPSECの接続状態の取得

IPSECの接続状態を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

IPSECの接続制御

指定したIPSECのSAを接続します。

path Parameters
sa
required
string

SA名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

IPSECの切断制御

指定したIPSECのSAを切断します。

path Parameters
sa
required
string

SA名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

モバイル回線の通信ステータス一覧取得

モバイル回線の通信ステータス一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

メニュー一覧取得

認証グループに応じたメニュー情報を返します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

ホスト名取得

現在のホスト名を返します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

amlogログ取得して既読ポイント移動

amlogログを取得し、既読ポイントを移動させます。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

全てのamlogログ取得

指定された行数の最新amlogログを取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

最新amlogログ取得

指定された行数の最新amlogログを取得します。

Request Body schema: application/json
required
level
string
Default: "informational"
Enum: "emergencies" "alerts" "critical" "errors" "warnings" "notifications" "informational" "debugging"

ログレベル

lines
required
integer

取得するログの行数

Responses

Request samples

Content type
application/json
{
  • "level": "emergencies",
  • "lines": 0
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

ログダウンロード

ログをダウンロードします。

Responses

Response samples

Content type
application/json
Example
{
  • "result": {
    }
}

ファームウェアバージョン取得

起動エリアのファームウェアバージョンを取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

ファームウェア全体更新状況取得

ファームウェア全体更新状況を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

ファームウェア全体更新状況削除

ファームウェア全体更新状況を削除します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

ファイルからファームウェア全体更新実行

アップロードされたファームウェアから全体更新します。

Request Body schema: multipart/form-data
name
required
string

ファームウェアファイル名

both
required
string
Default: "disable"
Enum: "enable" "disable"

ファームウェア更新エリア
enable 両面
disable 片面
factory-reset
string
Default: "disable"
Enum: "enable" "disable"

工場初期化
enable 有効
disable 無効
file
required
string <binary>

ファームウェアデータ

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

URLからファームウェア全体更新実行

指定されたURLからファームウェアを全体更新します。

Request Body schema: application/json
required
object
url
required
string

ファームウェアデータURL

Responses

Request samples

Content type
application/json
{
  • "options": {
    },
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

ファームウェアエリア同期状況取得

ファームウェアエリア同期状況を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

ファームウェアエリア同期

ファームウェアエリアを同期します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

ファームウェア差分更新状況取得

ファームウェア差分更新状況を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

ファームウェア差分更新実行

ファームウェアを差分更新します。

Request Body schema: application/json
update
boolean

パッケージ情報更新

upgrade
boolean

パッケージデータ更新

Responses

Request samples

Content type
application/json
{
  • "update": true,
  • "upgrade": true
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

ファームウェア差分更新状況削除

ファームウェア差分更新状況を削除します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

機器再起動状況取得

機器の再起動状況を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

機器再起動実行

機器を再起動します。

Request Body schema: application/json
mode
string
Default: "warm"
Enum: "warm" "cold"

再起動モード

Responses

Request samples

Content type
application/json
{
  • "mode": "warm"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

機器再起動状況削除

機器の再起動状況を削除します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

シャットダウン実行

機器をシャットダウンします。

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

時刻表示取得

日付と時刻を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

手動設定

RFC3339フォーマットで日付時刻を設定します。

Request Body schema: application/json
required
datetime
string

日付時刻

Responses

Request samples

Content type
application/json
{
  • "datetime": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

ntpdate設定

NTPプロトコルを使って時刻を同期します。

Request Body schema: application/json
required
server
required
string

サーバ

Responses

Request samples

Content type
application/json
{
  • "server": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

ping実行

pingを実行します。

Request Body schema: application/json
required
dst
required
string

宛先IPアドレスまたはFQDN

src
string

送信元アドレスまたはインターフェース名

repeat
integer
Default: 5

送信回数

interval
integer
Default: 1

送信間隔(秒)

size
integer
Default: 56

送信データサイズ(バイト)

ipver
string
Default: "v4"
Enum: "v4" "v6"

IPバージョン

tos
string
Default: "0x00"

TOS値

pmtud
string
Default: "want"
Enum: "do" "dont" "want"

Path MTU Discovery実行設定

pattern
string

パケットのデータパターン

ttl
integer

TTL値

Responses

Request samples

Content type
application/json
{
  • "dst": "string",
  • "src": "string",
  • "repeat": 5,
  • "interval": 1,
  • "size": 56,
  • "ipver": "v4",
  • "tos": "0x00",
  • "pmtud": "do",
  • "pattern": "string",
  • "ttl": 0
}

Response samples

Content type
application/json
Example
{
  • "result": {
    }
}

ping実行結果取得

pingの実行結果を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

ping実行キャンセル

pingの実行をキャンセルします。

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

DEVICE-POE設定一覧取得

DEVICE-POE設定一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

PoEポートのリセット

PoEポートをリセットします。

path Parameters
ifname
required
string

インタフェース名

Request Body schema: application/json
required
resetondelay
integer
Default: 60

リセットオンディレイ(s)

Responses

Request samples

Content type
application/json
{
  • "resetondelay": 60
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

パーティション一覧取得

パーティション一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

パーティション作成

パーティションを作成します。

Request Body schema: application/json
required
device
required
string

デバイス名

number
required
integer

パーティション番号

type
string
Default: "linux"

パーティションタイプ

size
integer

パーティションサイズ（KB）

Responses

Request samples

Content type
application/json
{
  • "device": "string",
  • "number": 0,
  • "type": "linux",
  • "size": 0
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

指定されたデバイスのパーティション一覧取得

指定されたデバイスのパーティション一覧を取得します。

path Parameters
device
required
string

デバイス名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

パーティション取得

パーティションを取得します。

path Parameters
device
required
string

デバイス名

partition
required
string

パーティション名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

作成処理キャンセルとパーティション削除

パーティションの作成処理をキャンセルし、パーティションを削除します。

path Parameters
device
required
string

デバイス名

partition
required
string

パーティション名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

パーティションマウント一覧取得

パーティションマウント一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

パーティションマウント

パーティションをマウントします。

Request Body schema: application/json
required
name
required
string

パーティション名

crypt-enable
boolean
Default: false

パーティション暗号化有効無効

crypt-key
string

パーティション暗号化キー

fstype
string
Default: "ext4"
Enum: "vfat" "ext4" "xfs"

ファイルシステムタイプ

option
string
Default: "defaults"

マウントオープション

point
required
string

マウントポイン

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "crypt-enable": false,
  • "crypt-key": "string",
  • "fstype": "vfat",
  • "option": "defaults",
  • "point": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

パーティションマウント取得

パーティションマウントを取得します。

path Parameters
name
required
string

パーティション名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

パーティションアンマウント

パーティションをアンマウントします。

path Parameters
name
required
string

パーティション名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

パーティションフォーマット取得

パーティションフォーマットを取得します。

path Parameters
name
required
string

パーティション名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

パーティションフォーマット

パーティションをフォーマットします。

path Parameters
name
required
string

パーティション名

Request Body schema: application/json
required
name
required
string

パーティション名

crypt-enable
required
boolean

パーティション暗号化有効無効

crypt-key
string

パーティション暗号化キー

crypt-aes
integer
Enum: 256 512

マスターキーサイズ

fstype
string
Default: "ext4"
Enum: "vfat" "ext4" "xfs"

ファイルシステムタイプ

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "crypt-enable": true,
  • "crypt-key": "string",
  • "crypt-aes": 256,
  • "fstype": "vfat"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

フォーマット実行キャンセル

フォーマットの実行をキャンセルします。

path Parameters
name
required
string

パーティション名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

USBデバイス情報取得

USBデバイス情報を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

USBリセット

USBをリセットします。

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

システムメトリックス情報取得

システムメトリックス情報を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

ネットワークトラフィック情報取得

ネットワークトラフィック情報を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

DNS情報（正引き・逆引き）

nslookupを実行し、結果を取得します。

Request Body schema: application/json
required
address
required
string

FQDN/IPアドレス

query-type
string
Enum: "a" "aaaa" "any" "mx" "ns" "soa" "txt"

タイプ

server
string

問い合わせ先アドレス

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "query-type": "a",
  • "server": "string"
}

Response samples

Content type
text/plain
 ; <<>> DiG 9.11.3-1ubuntu1.13-Ubuntu <<>> -x 8.8.8.8 -t a
 ;; global options: +cmd
 ;; Got answer:
 ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 46508
 ;; flags: qr rd ra; QUERY: 1, ANSWER: 0, AUTHORITY: 1, ADDITIONAL: 1
 
 ;; OPT PSEUDOSECTION:
 ; EDNS: version: 0, flags:; udp: 4096
 ;; QUESTION SECTION:
 ;8.8.8.8.in-addr.arpa.          IN      A
 
 ;; AUTHORITY SECTION:
 8.8.8.in-addr.arpa.     900     IN      SOA     ns1.google.com. dns-admin.google.com. 346284789 900 900 1800 60
 
 ;; Query time: 135 msec
 ;; SERVER: 127.0.0.1#53(127.0.0.1)
 ;; WHEN: Thu Dec 10 05:40:10 UTC 2020
 ;; MSG SIZE  rcvd: 109

機器情報取得

機器の製造データを取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

通信モジュール情報一覧取得

通信モジュール情報一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

通信モジュール情報更新

通信モジュール情報を更新します。

Request Body schema: application/json
required
option
string
Enum: "force" "reboot"

オプション

Responses

Request samples

Content type
application/json
{
  • "option": "force"
}

Response samples

Content type
application/json
Example
{
  • "result": {
    }
}

通信モジュール情報取得

通信モジュール情報を取得します。

path Parameters
module
required
integer

モジュール番号

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

SIM情報更新

SIM情報を更新します。

Request Body schema: application/json
required
module-number
integer

モバイルモジュール番号

sim-number
integer

SIM番号

option
string
Enum: "force" "reboot"

オプション

Responses

Request samples

Content type
application/json
{
  • "module-number": 0,
  • "sim-number": 0,
  • "option": "force"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

DOUTの状態取得

DOUTの状態を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

DOUTの状態制御

DOUTの状態を制御する。

Request Body schema: application/json
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "dout": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "result": {
    }
}

DINの状態取得

DINの状態を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

ログダウンロード

ログをダウンロードします。

Responses

Response samples

Content type
application/json
Example
{
  • "result": {
    }
}

最新ログ取得

指定された行数の最新ログを取得します。

Request Body schema: application/json
required
lines
required
integer

取得するログの行数

Responses

Request samples

Content type
application/json
{
  • "lines": 0
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

アムニモ診断情報状態取得・ダウンロード

アムニモ診断情報をダウンロードします。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

アムニモ診断情報生成

アムニモ診断情報を生成します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

アムニモ診断情報ダウンロード停止

アムニモ診断情報ダウンロードを停止します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

スケジュール動作状況取得

スケジュール動作状況を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

ルーティングテーブル取得

ルーティングテーブルを取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

DHCPリース一覧取得

DHCPリース一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

タイムゾーン取得

タイムゾーンを取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

DILogger設定取得

DILogger設定を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

DILogger設定更新

DILogger設定を更新します。

Request Body schema: application/json
required
enabled
required
boolean
Default: true

有効無効設定

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

接点変更履歴ダウンロード

接点変更履歴をダウンロードします。

query Parameters
start
string

開始日時(YYYY-MM-DDTHH:mm)

end
string

終了日時(YYYY-MM-DDTHH:mm)

Responses

Response samples

Content type
application/json
Example
{
  • "result": {
    }
}

最新接点変更履歴取得

指定された件数の接点変更履歴を取得します。

Request Body schema: application/json
required
number
required
integer

取得するログの件数

Responses

Request samples

Content type
application/json
{
  • "number": 0
}

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

ログインユーザー情報取得

ログインしているユーザーの情報を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

ログインユーザーのパスワード更新

ログインしているユーザのパスワードを更新します。 設定保存権限がないユーザーの場合設定の保存を行います。

Request Body schema: application/json
required
object

パスワード

Responses

Request samples

Content type
application/json
{
  • "password": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Wifi アクセスポイント 状態取得

Wifi アクセスポイント 状態取得

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

Wifi アクセスポイント 状態取得

Wifi アクセスポイント 状態取得

path Parameters
ifname
required
string

インタフェース名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

接続中ステーション一覧取得

接続中ステーション一覧取得

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

接続中ステーション情報取得

IFごとの接続中ステーション情報取得

path Parameters
ifname
required
string

インタフェース名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

接続ステーション切断

接続中ステーションを切断します。

path Parameters
mac-address
required
string

MACアドレス

Request Body schema: application/json
required
ifname
required
string

インタフェース名

Responses

Request samples

Content type
application/json
{
  • "ifname": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Wifi ステーション 状態取得

Wifi ステーション 状態取得

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

Wifi ステーション アクセスポイント取得

Wifi ステーション アクセスポイント取得

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

ネットワーク接続切替

接続中ネットワークを切り替えます。

path Parameters
network-id
required
string

ネットワークID

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

WPS PIN 生成(ステーション)

ステーションのPIN を生成します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

WPS PBC処理状態取得

WPS（プッシュボタン方式）の処理状態を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

WPS PBC実行

WPS（プッシュボタン方式）を実行します。

Request Body schema: application/json
required
wait
integer

PBC待機時間

Responses

Request samples

Content type
application/json
{
  • "wait": 0
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

WPS PBC処理中止

WPS PBC処理をキャンセルします。

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

WPS PBC処理状態取得

WPS（プッシュボタン方式）の処理状態を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

WPS PIN 実行

WPS（PINコード方式）を実行します。

Request Body schema: application/json
required
number
string

PINコード

wait
integer

PIN待機時間

Responses

Request samples

Content type
application/json
{
  • "number": "string",
  • "wait": 0
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

WPS PIN処理中止

WPS PIN処理をキャンセルします。

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

アクセスポイント一覧取得

アクセスポイント一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": [
    ]
}

ユーザ設定一覧取得

登録されているユーザ一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

ユーザ設定新規登録

ユーザ設定を新規に登録します。

Request Body schema: application/json
required
username
required
string

ユーザ名

required
object

パスワード

group
required
string
Default: "user"
Enum: "admin" "user"

グループ

auto-logout
integer
Default: 0

自動ログアウト時間（秒）

password-expires
integer
Default: 10000

パスワード有効期間（日）

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": {
    },
  • "group": "admin",
  • "auto-logout": 0,
  • "password-expires": 10000
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

ユーザ設定取得

登録されているユーザ設定を取得します。

path Parameters
name
required
string

アカウント名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

ユーザ設定一部更新

登録されているユーザ設定を一部更新します。

path Parameters
name
required
string

アカウント名

Request Body schema: application/json
required
username
required
string

ユーザ名

required
object

パスワード

group
required
string
Default: "user"
Enum: "admin" "user"

グループ

auto-logout
integer
Default: 0

自動ログアウト時間（秒）

password-expires
integer
Default: 10000

パスワード有効期間（日）

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": {
    },
  • "group": "admin",
  • "auto-logout": 0,
  • "password-expires": 10000
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

ユーザ設定削除

登録されているユーザ設定を削除します。

path Parameters
name
required
string

アカウント名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

操作権限一覧取得

画面ごとの操作権限情報を返します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

グループ設定一覧取得

登録されているグループ一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": [
    ]
}

グループ設定新規登録

グループ設定を新規に登録します。

Request Body schema: application/json
required
name
string

グループ名

object

権限設定

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "authorization": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

グループ設定取得

登録されているグループ設定を取得します。

path Parameters
name
required
string

グループ名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": [
    ]
}

グループ設定一部更新

登録されているグループ設定を一部更新します。

path Parameters
name
required
string

グループ名

Request Body schema: application/json
required
name
string

グループ名

object

権限設定

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "authorization": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

グループ設定削除

登録されているユーザ設定を削除します。

path Parameters
name
required
string

グループ名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

パッケージリポジトリ認証情報一覧取得

登録されているパッケージリポジトリ認証情報を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

パッケージリポジトリ認証情報新規登録

パッケージリポジトリ認証情報を新規に登録します。

Request Body schema: application/json
required
hostname
required
string

ホスト名

username
required
string

ユーザ名

password
required
string

パスワード

Responses

Request samples

Content type
application/json
{
  • "hostname": "string",
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

パッケージリポジトリ認証情報取得

登録されているパッケージリポジトリ認証情報を取得します。

path Parameters
hostname
required
string

ホスト名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

パッケージリポジトリ認証情報一部更新

登録されているパッケージリポジトリ認証情報を一部更新します。

path Parameters
hostname
required
string

ホスト名

Request Body schema: application/json
required
hostname
required
string

ホスト名

username
required
string

ユーザ名

password
required
string

パスワード

Responses

Request samples

Content type
application/json
{
  • "hostname": "string",
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

パッケージリポジトリ認証情報削除

登録されているパッケージリポジトリ認証情報を削除します。

path Parameters
hostname
required
string

ホスト名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

DHCPv4設定一覧取得

登録されているDHCPv4設定一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

DHCPv4設定新規登録

DHCPv4設定を新規に登録します。

Request Body schema: application/json
required
ifname
string

インタフェース名

enabled
boolean
Default: false

有効/無効

object
default-leasetime
number
Default: 43200

デフォルトリース時間

netmask
string
Default: "255.255.255.0"

ネットマスク

required
object
router
string

ルータアドレス

dns
Array of strings
ntp
Array of strings
domain
string

ドメイン名

Responses

Request samples

Content type
application/json
{
  • "ifname": "string",
  • "enabled": false,
  • "leasetime": {
    },
  • "default-leasetime": 43200,
  • "netmask": "255.255.255.0",
  • "dynamic": {
    },
  • "router": "string",
  • "dns": [
    ],
  • "ntp": [
    ],
  • "domain": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

DHCPv4設定取得

登録されているDHCPv4設定を取得します。

path Parameters
ifname
required
string

インターフェイス名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

Dhcpv4設定一部更新

登録されているDHCPv4設定を一部更新します。

path Parameters
ifname
required
string

インターフェイス名

Request Body schema: application/json
required
ifname
string

インタフェース名

enabled
boolean
Default: false

有効/無効

object
default-leasetime
number
Default: 43200

デフォルトリース時間

netmask
string
Default: "255.255.255.0"

ネットマスク

required
object
router
string

ルータアドレス

dns
Array of strings
ntp
Array of strings
domain
string

ドメイン名

Responses

Request samples

Content type
application/json
{
  • "ifname": "string",
  • "enabled": false,
  • "leasetime": {
    },
  • "default-leasetime": 43200,
  • "netmask": "255.255.255.0",
  • "dynamic": {
    },
  • "router": "string",
  • "dns": [
    ],
  • "ntp": [
    ],
  • "domain": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

DHCPv4設定削除

登録されているDHCPv4設定を削除します。

path Parameters
ifname
required
string

インターフェイス名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

DHCPリレー設定一覧取得

登録されているDHCPリレー設定一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

DHCPリレー設定新規登録

DHCPリレー設定を新規に登録します。

Request Body schema: application/json
required
group
required
string

グループ名

enabled
boolean
Default: false

有効/無効

listen
Array of strings

受信インターフェイス

server
required
Array of strings

DHCPサーバーアドレス

Responses

Request samples

Content type
application/json
{
  • "group": "string",
  • "enabled": false,
  • "listen": [
    ],
  • "server": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

DHCPリレー設定取得

登録されているDHCPリレー設定を取得します。

path Parameters
group
required
string

グループ名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

Dhcpリレー設定一部更新

登録されているDHCPリレー設定を一部更新します。

path Parameters
group
required
string

グループ名

Request Body schema: application/json
required
group
required
string

グループ名

enabled
boolean
Default: false

有効/無効

listen
Array of strings

受信インターフェイス

server
required
Array of strings

DHCPサーバーアドレス

Responses

Request samples

Content type
application/json
{
  • "group": "string",
  • "enabled": false,
  • "listen": [
    ],
  • "server": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

DHCPリレー設定削除

登録されているDHCPリレー設定を削除します。

path Parameters
group
required
string

グループ名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

DMS設定取得

DMS設定を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

DMS設定更新

DMS設定を更新します。

Request Body schema: application/json
required
enabled
boolean
Default: true

有効無効設定

object

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "failsafe": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

ホスト名設定取得

ホスト名設定を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

ホスト名設定更新

ホスト名設定を更新します。

Request Body schema: application/json
required
hostname
string

ホスト名設定

Responses

Request samples

Content type
application/json
{
  • "hostname": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

タイムゾーン設定取得

タイムゾーン設定を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

タイムゾーン設定更新

タイムゾーン設定を更新します。

Request Body schema: application/json
required
object (timezone)

タイムゾーン

Responses

Request samples

Content type
application/json
{
  • "timezone": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

タイムゾーン一覧取得

タイムゾーン一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

インタフェース設定一覧取得

登録されているインタフェース設定一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

インタフェース設定新規登録

インタフェース設定を新規に登録します。

Request Body schema: application/json
required
name
required
string

インタフェース名

enabled
required
boolean
Default: false

有効無効設定

bridge
Array of strings
macaddress
string
Default: "lan0"
Enum: "auto" "lan0" "lan1" "lan2" "lan3" "XX:XX:XX:XX:XX:XX"

MACアドレス動作

object
object
object
object
object
address
Array of strings
object
object
object
mtu
integer
Default: 1500

MTU値

mru
integer
Default: 1454

MRU値

mode
string
Default: "100baseT-Auto"
Enum: "10baseT-Half" "10baseT-Full" "100baseT-Auto" "100baseT-Half" "100baseT-Full" "1000baseT-Auto" "1000baseT-Full"

インタフェースリンクモード設定

proxy-arp
boolean
Default: true

PROXY ARP有効無効設定

optional
boolean
Default: false

起動オプション

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "enabled": false,
  • "bridge": [
    ],
  • "macaddress": "auto",
  • "pmtu": {
    },
  • "mobile": {
    },
  • "acces-point": {
    },
  • "station": {
    },
  • "pppoe4": {
    },
  • "address": [
    ],
  • "dhcp4": {
    },
  • "gateway4": {
    },
  • "masquerade4": {
    },
  • "mtu": 1500,
  • "mru": 1454,
  • "mode": "10baseT-Half",
  • "proxy-arp": true,
  • "optional": false
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

インタフェース設定取得

登録されているインタフェース設定を取得します。

path Parameters
name
required
string

インタフェース名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

インタフェース設定一部更新

登録されているインタフェース設定を一部更新します。

path Parameters
name
required
string

インタフェース名

Request Body schema: application/json
required
name
required
string

インタフェース名

enabled
required
boolean
Default: false

有効無効設定

bridge
Array of strings
macaddress
string
Default: "lan0"
Enum: "auto" "lan0" "lan1" "lan2" "lan3" "XX:XX:XX:XX:XX:XX"

MACアドレス動作

object
object
object
object
object
address
Array of strings
object
object
object
mtu
integer
Default: 1500

MTU値

mru
integer
Default: 1454

MRU値

mode
string
Default: "100baseT-Auto"
Enum: "10baseT-Half" "10baseT-Full" "100baseT-Auto" "100baseT-Half" "100baseT-Full" "1000baseT-Auto" "1000baseT-Full"

インタフェースリンクモード設定

proxy-arp
boolean
Default: true

PROXY ARP有効無効設定

optional
boolean
Default: false

起動オプション

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "enabled": false,
  • "bridge": [
    ],
  • "macaddress": "auto",
  • "pmtu": {
    },
  • "mobile": {
    },
  • "acces-point": {
    },
  • "station": {
    },
  • "pppoe4": {
    },
  • "address": [
    ],
  • "dhcp4": {
    },
  • "gateway4": {
    },
  • "masquerade4": {
    },
  • "mtu": 1500,
  • "mru": 1454,
  • "mode": "10baseT-Half",
  • "proxy-arp": true,
  • "optional": false
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

インタフェース設定削除

登録されているインタフェース設定を削除します。

path Parameters
name
required
string

インタフェース名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

IPsec IKEの新規登録

IPsec IKEを新規に登録します

Request Body schema: application/json
name
required
string

NAME

version
integer
Enum: 1 2

バージョン

mobike
boolean
Default: false

MOBIKE

mode
string
Default: "main"
Enum: "main" "aggressive"

モード

flagmentation
boolean
Default: true

フラグメンテーション動作の指定

retry
string
Default: "3"

リトライ

transform-restriction
boolean
Default: false

動作指定をtransformだけに限定

Array of objects

Transformの設定

lifetime
string
Default: "3h"

LIFE TIME

object

DEAD PEER DETECTION

object

ローカル

object

リモート

object

認証設定

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "version": 1,
  • "mobike": false,
  • "mode": "main",
  • "flagmentation": true,
  • "retry": "3",
  • "transform-restriction": false,
  • "transform": [
    ],
  • "lifetime": "3h",
  • "dpd": {
    },
  • "local": {
    },
  • "remote": {
    },
  • "authentication": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

IPsec IKE一覧取得

登録されているIPsec IKE一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

IPsec IKE設定取得

登録されているIPsecのIKE設定を取得します

path Parameters
name
required
string

IKE名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

IPsecのIKE設定一部更新

登録されているIPsecのIKE設定を一部更新します。

path Parameters
name
required
string

IKE名

Request Body schema: application/json
required
name
required
string

NAME

version
integer
Enum: 1 2

バージョン

mobike
boolean
Default: false

MOBIKE

mode
string
Default: "main"
Enum: "main" "aggressive"

モード

flagmentation
boolean
Default: true

フラグメンテーション動作の指定

retry
string
Default: "3"

リトライ

transform-restriction
boolean
Default: false

動作指定をtransformだけに限定

Array of objects

Transformの設定

lifetime
string
Default: "3h"

LIFE TIME

object

DEAD PEER DETECTION

object

ローカル

object

リモート

object

認証設定

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "version": 1,
  • "mobike": false,
  • "mode": "main",
  • "flagmentation": true,
  • "retry": "3",
  • "transform-restriction": false,
  • "transform": [
    ],
  • "lifetime": "3h",
  • "dpd": {
    },
  • "local": {
    },
  • "remote": {
    },
  • "authentication": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

IPsec IKE削除

登録されているIPsec IKE設定を削除します。

path Parameters
name
required
string

IKE名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

IPsec SAの新規登録

IPsec SAを新規に登録します

Request Body schema: application/json
required
name
required
string

NAME

enabled
boolean

有効無効

key-exchange
string

鍵交換の指定

service-mode
string
Default: "initiate"
Enum: "initiate" "ondemand" "hold" "disable"

サービス動作の指定

close-mode
string
Default: "none"
Enum: "initiate" "ondemand" "none"

サービス動作の指定

rekey
boolean
Default: true

REKEY処理動作

protocol-type
string
Default: "esp"
Enum: "esp" "ah"

プロトコルの指定

mode
string
Default: "tunnel"
Enum: "tunnel" "transport" "passthrough"

通信モード

ipcomp
boolean
Default: false

IPComの設定

anti-replay
boolean
Default: true

リプライ制御

priority
string
Default: "auto"
Value: "auto"

ポリシーのプライオリティ(1～4294967295)

transform-restriction
boolean
Default: false

動作を指定transformのみに限定する

Array of objects

transformの設定

lifetime
string
Default: "1h"

lifetime

object

サブネット

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "enabled": true,
  • "key-exchange": "string",
  • "service-mode": "initiate",
  • "close-mode": "initiate",
  • "rekey": true,
  • "protocol-type": "esp",
  • "mode": "tunnel",
  • "ipcomp": false,
  • "anti-replay": true,
  • "priority": "auto",
  • "transform-restriction": false,
  • "transform": [
    ],
  • "lifetime": "1h",
  • "subnets": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

IPsec SA一覧取得

登録されているIPsec SA一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

IPsec SA設定取得

登録されているIPsecのSA設定を取得します

path Parameters
name
required
string

SA名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

IPsecのSA設定一部更新

登録されているIPsecのSA設定を一部更新します。

path Parameters
name
required
string

SA名

Request Body schema: application/json
required
name
required
string

NAME

enabled
boolean

有効無効

key-exchange
string

鍵交換の指定

service-mode
string
Default: "initiate"
Enum: "initiate" "ondemand" "hold" "disable"

サービス動作の指定

close-mode
string
Default: "none"
Enum: "initiate" "ondemand" "none"

サービス動作の指定

rekey
boolean
Default: true

REKEY処理動作

protocol-type
string
Default: "esp"
Enum: "esp" "ah"

プロトコルの指定

mode
string
Default: "tunnel"
Enum: "tunnel" "transport" "passthrough"

通信モード

ipcomp
boolean
Default: false

IPComの設定

anti-replay
boolean
Default: true

リプライ制御

priority
string
Default: "auto"
Value: "auto"

ポリシーのプライオリティ(1～4294967295)

transform-restriction
boolean
Default: false

動作を指定transformのみに限定する

Array of objects

transformの設定

lifetime
string
Default: "1h"

lifetime

object

サブネット

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "enabled": true,
  • "key-exchange": "string",
  • "service-mode": "initiate",
  • "close-mode": "initiate",
  • "rekey": true,
  • "protocol-type": "esp",
  • "mode": "tunnel",
  • "ipcomp": false,
  • "anti-replay": true,
  • "priority": "auto",
  • "transform-restriction": false,
  • "transform": [
    ],
  • "lifetime": "1h",
  • "subnets": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

IPsec SA削除

登録されているIPsec SA設定を削除します。

path Parameters
name
required
string

SA名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

通信モジュール設定一覧取得

登録されている通信モジュール設定一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

通信モジュール設定取得

登録されている通信モジュール設定を取得します。

path Parameters
name
required
string

通信モジュール登録名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

モバイルピア設定一覧取得

登録されているモバイルピア設定一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

モバイルピア設定新規登録

モバイルピア設定を新規に登録します。

Request Body schema: application/json
required
peer
required
string

モバイルピア名

verbose
string
Default: "informational"
Enum: "emergencies" "alerts" "critical" "errors" "warnings" "notifications" "informational" "debugging"

SYSLOG出力レベル

module
string
Enum: "ME3630-J2A" "ME3630-J2AM" "ME3630-E1C" "GM500_U1A"

通信モジュール登録名

object
required
Array of objects (mobilesPeerSession)

Responses

Request samples

Content type
application/json
{
  • "peer": "string",
  • "verbose": "emergencies",
  • "module": "ME3630-J2A",
  • "failsafe": {
    },
  • "sessions": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

モバイルピア設定取得

登録されているモバイルピア設定を取得します。

path Parameters
peer
required
string

モバイルピア名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

モバイルピア設定一部更新

登録されているモバイルピア設定を一部更新します。

path Parameters
peer
required
string

モバイルピア名

Request Body schema: application/json
required
peer
required
string

モバイルピア名

verbose
string
Default: "informational"
Enum: "emergencies" "alerts" "critical" "errors" "warnings" "notifications" "informational" "debugging"

SYSLOG出力レベル

module
string
Enum: "ME3630-J2A" "ME3630-J2AM" "ME3630-E1C" "GM500_U1A"

通信モジュール登録名

object
required
Array of objects (mobilesPeerSession)

Responses

Request samples

Content type
application/json
{
  • "peer": "string",
  • "verbose": "emergencies",
  • "module": "ME3630-J2A",
  • "failsafe": {
    },
  • "sessions": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

モバイルピア設定削除

登録されているモバイルピア設定を削除します。

path Parameters
peer
required
string

モバイルピア名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

モバイルピアセッション設定新規登録

モバイルピアセッション設定を新規に登録します。

path Parameters
peer
required
string

モバイルピア名

Request Body schema: application/json
required
session
required
string

セッション名

enabled
required
boolean
Default: false

セッション設定有効無効設定

priority
integer
Default: 0

優先度

sim
integer
Default: 0

SIMスロット番号

apn
string

APN

username
string

ユーザ名

object

パスワード

connect
string
Default: "always"
Enum: "none" "always"

接続モード

authentication
string
Default: "both"
Enum: "none" "pap" "chap" "both"

認証モード

attach-timeout
integer
Default: 30

最大接続待ち時間（秒）

call-timeout
integer
Default: 15

最大発呼待ち時間（秒）

idle-timeout
integer
Default: 0

無通信検知時間（秒）

connection-timeout
integer
Default: 0

最大接続時間（秒）

reconnect-timeout
integer
Default: 30

再接続待ち時間（秒）

object
retry
integer
Default: 0

接続リトライ回数

object

Responses

Request samples

Content type
application/json
{
  • "session": "string",
  • "enabled": false,
  • "priority": 0,
  • "sim": 0,
  • "apn": "string",
  • "username": "string",
  • "password": {
    },
  • "connect": "none",
  • "authentication": "none",
  • "attach-timeout": 30,
  • "call-timeout": 15,
  • "idle-timeout": 0,
  • "connection-timeout": 0,
  • "reconnect-timeout": 30,
  • "disconnect-detection": {
    },
  • "retry": 0,
  • "rat": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

モバイルピアセッション設定取得

登録されているモバイルピアセッション設定を取得します。

path Parameters
peer
required
string

モバイルピア名

session
required
string

モバイルピアセッション名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

モバイルピアセッション設定一部更新

登録されているモバイルピアセッション設定を一部更新します。

path Parameters
peer
required
string

モバイルピア名

session
required
string

モバイルピアセッション名

Request Body schema: application/json
required
session
required
string

セッション名

enabled
required
boolean
Default: false

セッション設定有効無効設定

priority
integer
Default: 0

優先度

sim
integer
Default: 0

SIMスロット番号

apn
string

APN

username
string

ユーザ名

object

パスワード

connect
string
Default: "always"
Enum: "none" "always"

接続モード

authentication
string
Default: "both"
Enum: "none" "pap" "chap" "both"

認証モード

attach-timeout
integer
Default: 30

最大接続待ち時間（秒）

call-timeout
integer
Default: 15

最大発呼待ち時間（秒）

idle-timeout
integer
Default: 0

無通信検知時間（秒）

connection-timeout
integer
Default: 0

最大接続時間（秒）

reconnect-timeout
integer
Default: 30

再接続待ち時間（秒）

object
retry
integer
Default: 0

接続リトライ回数

object

Responses

Request samples

Content type
application/json
{
  • "session": "string",
  • "enabled": false,
  • "priority": 0,
  • "sim": 0,
  • "apn": "string",
  • "username": "string",
  • "password": {
    },
  • "connect": "none",
  • "authentication": "none",
  • "attach-timeout": 30,
  • "call-timeout": 15,
  • "idle-timeout": 0,
  • "connection-timeout": 0,
  • "reconnect-timeout": 30,
  • "disconnect-detection": {
    },
  • "retry": 0,
  • "rat": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

モバイルピアセッション設定削除

登録されているモバイルピアセッション設定を削除します。

path Parameters
peer
required
string

モバイルピア名

session
required
string

モバイルピアセッション名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

NATの動的SNAT設定一覧取得

NATの動的SNAT設定一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

NATの動的SNAT設定報新規登録

NATの動的SNAT設定を新規に登録します。

Request Body schema: application/json
required
index
required
integer

ルールインデックス

enabled
boolean
Default: false

有効無効設定

required
object

出力インタフェース設定

to-port
string

送信元ポート番号設定

object (natLog)

ログ出力設定

object (match)

パケットの合致条件設定

Responses

Request samples

Content type
application/json
{
  • "index": 0,
  • "enabled": false,
  • "out-interface": {
    },
  • "to-port": "string",
  • "log": {
    },
  • "match": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

NATの動的SNAT設定取得

登録されているNATの動的SNAT設定を取得します。

path Parameters
index
required
integer

ルールインデックス

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

NATの動的SNAT設定一部更新

登録されているNATの動的SNAT設定を一部更新します。

path Parameters
index
required
integer

ルールインデックス

Request Body schema: application/json
required
index
required
integer

ルールインデックス

enabled
boolean
Default: false

有効無効設定

required
object

出力インタフェース設定

to-port
string

送信元ポート番号設定

object (natLog)

ログ出力設定

object (match)

パケットの合致条件設定

Responses

Request samples

Content type
application/json
{
  • "index": 0,
  • "enabled": false,
  • "out-interface": {
    },
  • "to-port": "string",
  • "log": {
    },
  • "match": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

NATの動的SNAT設定削除

登録されているNATの動的SNAT設定を削除します。

path Parameters
index
required
integer

ルールインデックス

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

NATの静的SNAT設定一覧取得

NATの静的SNAT設定一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

NATの静的SNAT設定報新規登録

NATの静的SNAT設定を新規に登録します。

Request Body schema: application/json
required
index
required
integer

ルールインデックス

enabled
boolean
Default: false

有効無効設定

required
object

出力インタフェース設定

to-ip
required
string

送信元IPアドレス設定

object (natLog)

ログ出力設定

object (match)

パケットの合致条件設定

Responses

Request samples

Content type
application/json
{
  • "index": 0,
  • "enabled": false,
  • "out-interface": {
    },
  • "to-ip": "string",
  • "log": {
    },
  • "match": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

NATの静的SNAT設定取得

登録されているNATの静的SNAT設定を取得します。

path Parameters
index
required
integer

ルールインデックス

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

NATの静的SNAT設定一部更新

登録されているNATの静的SNAT設定を一部更新します。

path Parameters
index
required
integer

ルールインデックス

Request Body schema: application/json
required
index
required
integer

ルールインデックス

enabled
boolean
Default: false

有効無効設定

required
object

出力インタフェース設定

to-ip
required
string

送信元IPアドレス設定

object (natLog)

ログ出力設定

object (match)

パケットの合致条件設定

Responses

Request samples

Content type
application/json
{
  • "index": 0,
  • "enabled": false,
  • "out-interface": {
    },
  • "to-ip": "string",
  • "log": {
    },
  • "match": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

NATの静的SNAT設定削除

登録されているNATの静的SNAT設定を削除します。

path Parameters
index
required
integer

ルールインデックス

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

NATのDNAT設定一覧取得

NATのDNAT設定一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

NATのDNAT設定報新規登録

NATのDNAT設定を新規に登録します。

Request Body schema: application/json
required
index
required
integer

ルールインデックス

enabled
boolean
Default: false

有効無効設定

object

入力インタフェース設定

to-ip
required
string

送信元IPアドレス設定

object (natLog)

ログ出力設定

object (match)

パケットの合致条件設定

Responses

Request samples

Content type
application/json
{
  • "index": 0,
  • "enabled": false,
  • "in-interface": {
    },
  • "to-ip": "string",
  • "log": {
    },
  • "match": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

NATのDNAT設定取得

登録されているNATのDNAT設定を取得します。

path Parameters
index
required
integer

ルールインデックス

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

NATのDNAT設定一部更新

登録されているNATのDNAT設定を一部更新します。

path Parameters
index
required
integer

ルールインデックス

Request Body schema: application/json
required
index
required
integer

ルールインデックス

enabled
boolean
Default: false

有効無効設定

object

入力インタフェース設定

to-ip
required
string

送信元IPアドレス設定

object (natLog)

ログ出力設定

object (match)

パケットの合致条件設定

Responses

Request samples

Content type
application/json
{
  • "index": 0,
  • "enabled": false,
  • "in-interface": {
    },
  • "to-ip": "string",
  • "log": {
    },
  • "match": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

NATのDNAT設定削除

登録されているNATのDNAT設定を削除します。

path Parameters
index
required
integer

ルールインデックス

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

VMS設定取得

VMS設定を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

VMS設定更新

VMS設定を更新します。

Request Body schema: application/json
required
enabled
boolean
Default: true

有効無効設定

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

NxWitness設定取得

NxWitness設定を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

NxWitness設定更新

NxWitness設定を更新します。

Request Body schema: application/json
required
enabled
boolean
Default: true

有効無効設定

port
integer
Default: 7001

ポート番号設定

required
object

パスワード設定

database
string

データベースパス

datetime
string

前回更新の日付時刻

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "port": 7001,
  • "password": {
    },
  • "database": "string",
  • "datetime": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

remote.it設定取得

登録されているremote.it設定を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

remote.it設定更新

remote.it設定を更新します。

Request Body schema: application/json
required
enabled
required
boolean
Default: false

remote.itサービス有効化

registration
string

レジストレーションコード

Responses

Request samples

Content type
application/json
{
  • "enabled": false,
  • "registration": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

GUI設定取得

登録されているGUI設定を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

GUI設定更新

GUI設定を更新します。

Request Body schema: application/json
required
enabled
required
boolean
Default: true

GUIサービス有効化

protocol
required
string
Default: "http"
Enum: "http" "https"

GUIプロトコル

port
required
integer
Default: 80

GUIポート番号

update-interval
integer
Default: 10

ダッシュボード更新間隔

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "protocol": "http",
  • "port": 80,
  • "update-interval": 10
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

PPPピア設定一覧取得

登録されているPPPピア設定一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

PPPピア設定新規登録

PPPピア設定を新規に登録します。

Request Body schema: application/json
required
peer
required
string

PPPピア名

verbose
string
Default: "informational"
Enum: "emergencies" "alerts" "critical" "errors" "warnings" "notifications" "informational" "debugging"

SYSLOG出力レベル

username
string

ユーザ名

object

パスワード

connect
string
Default: "always"
Enum: "none" "always"

接続モード

authentication
string
Default: "both"
Enum: "pap" "chap" "both"

認証モード

passive
boolean
Default: false

パッシブモード

idle-timeout
integer
Default: 0

無通信検知時間（秒）

connection-timeout
integer
Default: 0

最大接続時間（秒）

object
object
ccp
boolean
Default: true

圧縮制御プロトコル

pcomp
boolean
Default: true

プロトコルフィールド圧縮ネゴシエーション

vj
boolean
Default: true

Van Jacobson形式のTCP/IPヘッダ圧縮

vjccomp
boolean
Default: true

Van Jacobson形式のTCP/IPヘッダ圧縮のconnection-ID圧縮

vj-max-slots
integer
Default: 15

Van Jacobson形式のTCP/IPヘッダ圧縮に使用する接続スロット数

predictor1
boolean
Default: true

Predictor-1圧縮

ifname
string
Default: "eth0"

インタフェース名

Responses

Request samples

Content type
application/json
{
  • "peer": "string",
  • "verbose": "emergencies",
  • "username": "string",
  • "password": {
    },
  • "connect": "none",
  • "authentication": "pap",
  • "passive": false,
  • "idle-timeout": 0,
  • "connection-timeout": 0,
  • "bsdcomp": {
    },
  • "deflate": {
    },
  • "ccp": true,
  • "pcomp": true,
  • "vj": true,
  • "vjccomp": true,
  • "vj-max-slots": 15,
  • "predictor1": true,
  • "ifname": "eth0"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

PPPピア設定取得

指定された名称のPPPピア設定を取得します。

path Parameters
peer
required
string

PPPピア名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

PPPピア設定一部更新

指定された名称のPPPピア設定を一部更新します。

path Parameters
peer
required
string

PPPピア名

Request Body schema: application/json
required
peer
required
string

PPPピア名

verbose
string
Default: "informational"
Enum: "emergencies" "alerts" "critical" "errors" "warnings" "notifications" "informational" "debugging"

SYSLOG出力レベル

username
string

ユーザ名

object

パスワード

connect
string
Default: "always"
Enum: "none" "always"

接続モード

authentication
string
Default: "both"
Enum: "pap" "chap" "both"

認証モード

passive
boolean
Default: false

パッシブモード

idle-timeout
integer
Default: 0

無通信検知時間（秒）

connection-timeout
integer
Default: 0

最大接続時間（秒）

object
object
ccp
boolean
Default: true

圧縮制御プロトコル

pcomp
boolean
Default: true

プロトコルフィールド圧縮ネゴシエーション

vj
boolean
Default: true

Van Jacobson形式のTCP/IPヘッダ圧縮

vjccomp
boolean
Default: true

Van Jacobson形式のTCP/IPヘッダ圧縮のconnection-ID圧縮

vj-max-slots
integer
Default: 15

Van Jacobson形式のTCP/IPヘッダ圧縮に使用する接続スロット数

predictor1
boolean
Default: true

Predictor-1圧縮

ifname
string
Default: "eth0"

インタフェース名

Responses

Request samples

Content type
application/json
{
  • "peer": "string",
  • "verbose": "emergencies",
  • "username": "string",
  • "password": {
    },
  • "connect": "none",
  • "authentication": "pap",
  • "passive": false,
  • "idle-timeout": 0,
  • "connection-timeout": 0,
  • "bsdcomp": {
    },
  • "deflate": {
    },
  • "ccp": true,
  • "pcomp": true,
  • "vj": true,
  • "vjccomp": true,
  • "vj-max-slots": 15,
  • "predictor1": true,
  • "ifname": "eth0"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

PPPピア設定削除

指定された名称のPPPピア設定を削除します。

path Parameters
peer
required
string

PPPピア名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

スタティックルート設定一覧取得

登録されているスタティックルート設定一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

スタティックルート設定新規登録

スタティックルート設定を新規に登録します。

Request Body schema: application/json
required
route
required
string

スタティックルート名

to
required
string

送信先ネットワーク

via
required
string

ゲートウェイアドレス

interface
string

インタフェース名

metric
integer
Default: 0

メトリック値

Responses

Request samples

Content type
application/json
{
  • "route": "string",
  • "to": "string",
  • "via": "string",
  • "interface": "string",
  • "metric": 0
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

スタティックルート設定取得

登録されているスタティックルート設定を取得します。

path Parameters
route
required
string

スタティックルート名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

スタティックルート設定一部更新

登録されているスタティックルート設定を一部更新します。

path Parameters
route
required
string

スタティックルート名

Request Body schema: application/json
required
route
required
string

スタティックルート名

to
required
string

送信先ネットワーク

via
required
string

ゲートウェイアドレス

interface
string

インタフェース名

metric
integer
Default: 0

メトリック値

Responses

Request samples

Content type
application/json
{
  • "route": "string",
  • "to": "string",
  • "via": "string",
  • "interface": "string",
  • "metric": 0
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

スタティックルート設定削除

登録されているスタティックルート設定を削除します。

path Parameters
route
required
string

スタティックルート名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

フィルターの入力設定一覧取得

フィルターの入力設定一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

フィルターの入力設定報新規登録

フィルターの入力設定を新規に登録します。

Request Body schema: application/json
required
index
required
integer

ルールインデックス

enabled
boolean
Default: false

有効無効設定

policy
required
string
Enum: "accept" "drop" "reject"

ポリシー設定

reject-code
string
Enum: "icmp-net-unreachable" "icmp-port-unreachable" "icmp-host-unreachable" "icmp-proto-unreachable" "icmp-net-prohibited" "icmp-host-prohibited" "icmp-admin-prohibited"

拒否時のコード設定

object

ログ出力設定

object (match)

パケットの合致条件設定

Responses

Request samples

Content type
application/json
{
  • "index": 0,
  • "enabled": false,
  • "policy": "accept",
  • "reject-code": "icmp-net-unreachable",
  • "log": {
    },
  • "match": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

フィルターの入力設定取得

登録されているフィルターの入力設定を取得します。

path Parameters
index
required
integer

ルールインデックス

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

フィルターの入力設定一部更新

登録されているフィルターの入力設定を一部更新します。

path Parameters
index
required
integer

ルールインデックス

Request Body schema: application/json
required
index
required
integer

ルールインデックス

enabled
boolean
Default: false

有効無効設定

policy
required
string
Enum: "accept" "drop" "reject"

ポリシー設定

reject-code
string
Enum: "icmp-net-unreachable" "icmp-port-unreachable" "icmp-host-unreachable" "icmp-proto-unreachable" "icmp-net-prohibited" "icmp-host-prohibited" "icmp-admin-prohibited"

拒否時のコード設定

object

ログ出力設定

object (match)

パケットの合致条件設定

Responses

Request samples

Content type
application/json
{
  • "index": 0,
  • "enabled": false,
  • "policy": "accept",
  • "reject-code": "icmp-net-unreachable",
  • "log": {
    },
  • "match": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

フィルターの入力設定削除

登録されているフィルターの入力設定を削除します。

path Parameters
index
required
integer

ルールインデックス

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

フィルターの転送設定一覧取得

フィルターの転送設定一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

フィルターの転送設定報新規登録

フィルターの転送設定を新規に登録します。

Request Body schema: application/json
required
index
required
integer

ルールインデックス

enabled
boolean
Default: false

有効無効設定

policy
required
string
Enum: "accept" "drop" "reject"

ポリシー設定

reject-code
string
Enum: "icmp-net-unreachable" "icmp-port-unreachable" "icmp-host-unreachable" "icmp-proto-unreachable" "icmp-net-prohibited" "icmp-host-prohibited" "icmp-admin-prohibited"

拒否時のコード設定

object

ログ出力設定

object (match)

パケットの合致条件設定

Responses

Request samples

Content type
application/json
{
  • "index": 0,
  • "enabled": false,
  • "policy": "accept",
  • "reject-code": "icmp-net-unreachable",
  • "log": {
    },
  • "match": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

フィルターの転送設定取得

登録されているフィルターの転送設定を取得します。

path Parameters
index
required
integer

ルールインデックス

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

フィルターの転送設定一部更新

登録されているフィルターの転送設定を一部更新します。

path Parameters
index
required
integer

ルールインデックス

Request Body schema: application/json
required
index
required
integer

ルールインデックス

enabled
boolean
Default: false

有効無効設定

policy
required
string
Enum: "accept" "drop" "reject"

ポリシー設定

reject-code
string
Enum: "icmp-net-unreachable" "icmp-port-unreachable" "icmp-host-unreachable" "icmp-proto-unreachable" "icmp-net-prohibited" "icmp-host-prohibited" "icmp-admin-prohibited"

拒否時のコード設定

object

ログ出力設定

object (match)

パケットの合致条件設定

Responses

Request samples

Content type
application/json
{
  • "index": 0,
  • "enabled": false,
  • "policy": "accept",
  • "reject-code": "icmp-net-unreachable",
  • "log": {
    },
  • "match": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

フィルターの転送設定削除

登録されているフィルターの転送設定を削除します。

path Parameters
index
required
integer

ルールインデックス

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

フィルターの出力設定一覧取得

フィルターの出力設定一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

フィルターの出力設定報新規登録

フィルターの出力設定を新規に登録します。

Request Body schema: application/json
required
index
required
integer

ルールインデックス

enabled
boolean
Default: false

有効無効設定

policy
required
string
Enum: "accept" "drop" "reject"

ポリシー設定

reject-code
string
Enum: "icmp-net-unreachable" "icmp-port-unreachable" "icmp-host-unreachable" "icmp-proto-unreachable" "icmp-net-prohibited" "icmp-host-prohibited" "icmp-admin-prohibited"

拒否時のコード設定

object

ログ出力設定

object (match)

パケットの合致条件設定

Responses

Request samples

Content type
application/json
{
  • "index": 0,
  • "enabled": false,
  • "policy": "accept",
  • "reject-code": "icmp-net-unreachable",
  • "log": {
    },
  • "match": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

フィルターの出力設定取得

登録されているフィルターの出力設定を取得します。

path Parameters
index
required
integer

ルールインデックス

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

フィルターの出力設定一部更新

登録されているフィルターの出力設定を一部更新します。

path Parameters
index
required
integer

ルールインデックス

Request Body schema: application/json
required
index
required
integer

ルールインデックス

enabled
boolean
Default: false

有効無効設定

policy
required
string
Enum: "accept" "drop" "reject"

ポリシー設定

reject-code
string
Enum: "icmp-net-unreachable" "icmp-port-unreachable" "icmp-host-unreachable" "icmp-proto-unreachable" "icmp-net-prohibited" "icmp-host-prohibited" "icmp-admin-prohibited"

拒否時のコード設定

object

ログ出力設定

object (match)

パケットの合致条件設定

Responses

Request samples

Content type
application/json
{
  • "index": 0,
  • "enabled": false,
  • "policy": "accept",
  • "reject-code": "icmp-net-unreachable",
  • "log": {
    },
  • "match": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

フィルターの出力設定削除

登録されているフィルターの出力設定を削除します。

path Parameters
index
required
integer

ルールインデックス

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

フィルターのデフォルトポリシー設定

フィルターのデフォルトポリシーを設定します。

path Parameters
direction
required
string
Enum: "input" "output" "forward"

パケットの方向

action
required
string
Enum: "accept" "drop"

ポリシー設定

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

QoS設定一覧取得

QoS設定一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

QoS設定新規登録

QoS設定を新規に登録します。

Request Body schema: application/json
required
name
required
string

QoS設定名

type
required
string
Value: "htb"

QoSタイプ

enabled
boolean
Default: false

有効無効設定

interface
required
string

インタフェース名

Array of objects (qosClass)

クラス設定

Array of objects (qosRule)

ルール設定

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "htb",
  • "enabled": false,
  • "interface": "string",
  • "class": [
    ],
  • "rules": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

QoS設定取得

登録されているQoS設定を取得します。

path Parameters
name
required
string

QoS設定名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

QoS設定一部更新

登録されているQoS設定を一部更新します。

path Parameters
name
required
string

QoS設定名

Request Body schema: application/json
required
name
required
string

QoS設定名

type
required
string
Value: "htb"

QoSタイプ

enabled
boolean
Default: false

有効無効設定

interface
required
string

インタフェース名

Array of objects (qosClass)

クラス設定

Array of objects (qosRule)

ルール設定

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "htb",
  • "enabled": false,
  • "interface": "string",
  • "class": [
    ],
  • "rules": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

QoS設定削除

登録されているQoS設定を削除します。

path Parameters
name
required
string

QoS設定名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

QoSクラス一覧取得

QoSクラス一覧を取得します。

path Parameters
name
required
string

QoS設定名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

QoSクラス新規登録

QoSクラスを新規に登録します。

path Parameters
name
required
string

QoS設定名

Request Body schema: application/json
required
classid
required
integer [ 0 .. 9999 ]

クラスID

default
integer [ 0 .. 9999 ]

デフォルトクラスID

parent
required
integer [ 0 .. 9998 ]

親クラスID

minrate
required
string

最小レート

maxrate
string

最大レート

burst
string

バースト

maxburst
string

最大バースト

priority
integer [ 0 .. 7 ]

優先度

Responses

Request samples

Content type
application/json
{
  • "classid": 9999,
  • "default": 9999,
  • "parent": 9998,
  • "minrate": "string",
  • "maxrate": "string",
  • "burst": "string",
  • "maxburst": "string",
  • "priority": 7
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

QoSクラス取得

登録されているQoSクラスを取得します。

path Parameters
name
required
string

QoS設定名

classid
required
integer

クラスID

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

QoSクラス一部更新

登録されているQoSクラスを一部更新します。

path Parameters
name
required
string

QoS設定名

classid
required
integer

クラスID

Request Body schema: application/json
required
classid
required
integer [ 0 .. 9999 ]

クラスID

default
integer [ 0 .. 9999 ]

デフォルトクラスID

parent
required
integer [ 0 .. 9998 ]

親クラスID

minrate
required
string

最小レート

maxrate
string

最大レート

burst
string

バースト

maxburst
string

最大バースト

priority
integer [ 0 .. 7 ]

優先度

Responses

Request samples

Content type
application/json
{
  • "classid": 9999,
  • "default": 9999,
  • "parent": 9998,
  • "minrate": "string",
  • "maxrate": "string",
  • "burst": "string",
  • "maxburst": "string",
  • "priority": 7
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

QoSクラス削除

登録されているQoSクラスを削除します。

path Parameters
name
required
string

QoS設定名

classid
required
integer

クラスID

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

QoSルール一覧取得

QoSルール一覧を取得します。

path Parameters
name
required
string

QoS設定名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

QoSルール新規登録

QoSルールを新規に登録します。

path Parameters
name
required
string

QoS設定名

Request Body schema: application/json
required
index
required
integer [ 1 .. 1000 ]

ルールインデックス

enabled
boolean
Default: false

有効無効設定

classid
required
integer [ 0 .. 9999 ]

クラスID

object (qosMatch)

QoSパケットの合致条件設定

Responses

Request samples

Content type
application/json
{
  • "index": 1,
  • "enabled": false,
  • "classid": 9999,
  • "match": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

QoSルール取得

登録されているQoSルールを取得します。

path Parameters
name
required
string

QoS設定名

index
required
integer

ルールインデックス

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

QoSルール一部更新

登録されているQoSルールを一部更新します。

path Parameters
name
required
string

QoS設定名

index
required
integer

ルールインデックス

Request Body schema: application/json
required
index
required
integer [ 1 .. 1000 ]

ルールインデックス

enabled
boolean
Default: false

有効無効設定

classid
required
integer [ 0 .. 9999 ]

クラスID

object (qosMatch)

QoSパケットの合致条件設定

Responses

Request samples

Content type
application/json
{
  • "index": 1,
  • "enabled": false,
  • "classid": 9999,
  • "match": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

QoSルール削除

登録されているQoSルールを削除します。

path Parameters
name
required
string

QoS設定名

index
required
integer

ルールインデックス

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

NTP設定取得

登録されているNTP設定を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

NTP設定新規登録

NTP設定を新規に登録します。

Request Body schema: application/json
required
enabled
boolean
Default: false

NTPサーバ有効

object

共通のNTPサーバ設定

Array of objects
Array of objects
object

Responses

Request samples

Content type
application/json
{
  • "enabled": false,
  • "common": {
    },
  • "pool": [
    ],
  • "server": [
    ],
  • "gps": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

DNS設定取得

DNS設定を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

DNS設定更新

DNS設定を更新します。

Request Body schema: application/json
required
enabled
boolean
Default: false

有効無効設定

port
integer
Default: 53

ポート番号設定

object

クエリーのポート範囲設定

object

DNSSECの設定

object

キャッシュ時のTTL設定

log-level
integer
Default: 1

ログレベル設定

root-server
boolean
Default: true

ルートサーバへの問い合わせ設定

Array of objects (dnsServerAddress)
Array of objects (dnsForward)
Array of objects (dnsLocalZone)
Array of objects (dnsLocalAddress)
Array of objects (dnsLocalCname)

Responses

Request samples

Content type
application/json
{
  • "enabled": false,
  • "port": 53,
  • "query-port-range": {
    },
  • "dnssec": {
    },
  • "cache-ttl": {
    },
  • "log-level": 1,
  • "root-server": true,
  • "server-address": [
    ],
  • "forward": [
    ],
  • "local-zone": [
    ],
  • "local-address": [
    ],
  • "local-cname": [
    ]
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

DNS問い合わせ先サーバー設定新規登録

DNS問い合わせ先サーバ設定を新規登録します。

Request Body schema: application/json
required
address
required
string

アドレス設定

priority
integer
Default: 0

プライオリティ設定

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "priority": 0
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

DNS問い合わせ先サーバー設定取得

登録されているDNS問い合わせ先サーバー設定を取得します。

path Parameters
address
required
string

アドレス

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

DNS問い合わせ先サーバー設定一部更新

登録されているDNS問い合わせ先サーバー設定を一部更新します。

path Parameters
address
required
string

アドレス

Request Body schema: application/json
required
address
required
string

アドレス設定

priority
integer
Default: 0

プライオリティ設定

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "priority": 0
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

DNS問い合わせ先サーバー設定削除

登録されているDNS問い合わせ先サーバー設定を削除します。

path Parameters
address
required
string

アドレス

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

DNSローカルアドレス設定新規登録

DNSローカルアドレス設定を新規登録します。

Request Body schema: application/json
required
address
required
string

アドレス設定

name
required
string

ホスト名設定

ttl
integer
Default: 3600

TTL設定

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "name": "string",
  • "ttl": 3600
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

DNSローカルアドレス設定取得

登録されているDNSローカルアドレス設定を取得します。

path Parameters
address
required
string

アドレス

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

DNSローカルアドレス設定一部更新

登録されているDNSローカルアドレス設定を一部更新します。

path Parameters
address
required
string

アドレス

Request Body schema: application/json
required
address
required
string

アドレス設定

name
required
string

ホスト名設定

ttl
integer
Default: 3600

TTL設定

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "name": "string",
  • "ttl": 3600
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

DNSローカルアドレス設定削除

登録されているDNSローカルアドレス設定を削除します。

path Parameters
address
required
string

アドレス

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

DNSローカルゾーン設定新規登録

DNSローカルゾーン設定を新規登録します。

Request Body schema: application/json
required
zone
required
string

ローカルゾーン設定

type
string
Default: "static"
Enum: "deny" "refuse" "static" "transparent" "typetransparent" "redirect" "nodefault"

ローカルゾーンタイプ設定

Responses

Request samples

Content type
application/json
{
  • "zone": "string",
  • "type": "deny"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

DNSローカルゾーン設定取得

登録されているDNSローカルゾーン設定を取得します。

path Parameters
zone
required
string

ゾーン

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

DNSローカルゾーン設定一部更新

登録されているDNSローカルゾーン設定を一部更新します。

path Parameters
zone
required
string

ゾーン

Request Body schema: application/json
required
zone
required
string

ローカルゾーン設定

type
string
Default: "static"
Enum: "deny" "refuse" "static" "transparent" "typetransparent" "redirect" "nodefault"

ローカルゾーンタイプ設定

Responses

Request samples

Content type
application/json
{
  • "zone": "string",
  • "type": "deny"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

DNSローカルゾーン設定削除

登録されているDNSローカルゾーン設定を削除します。

path Parameters
zone
required
string

ゾーン

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

DNSローカルCNAME設定新規登録

DNSローカルCNAME設定を新規登録します。

Request Body schema: application/json
required
cname
string

CNAME設定

name
string

ホスト名設定

ttl
integer
Default: 3600

TTL設定

Responses

Request samples

Content type
application/json
{
  • "cname": "string",
  • "name": "string",
  • "ttl": 3600
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

DNSローカルCNAME設定取得

登録されているDNSローカルCNAME設定を取得します。

path Parameters
index
required
integer

INDEX番号

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

DNSローカルCNAME設定一部更新

登録されているDNSローカルCNAME設定を一部更新します。

path Parameters
index
required
integer

INDEX番号

Request Body schema: application/json
required
index
integer
cname
required
string

CNAME設定

name
required
string

ホスト名設定

ttl
integer
Default: 3600

TTL設定

Responses

Request samples

Content type
application/json
{
  • "index": 0,
  • "cname": "string",
  • "name": "string",
  • "ttl": 3600
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

DNSローカルCname設定削除

登録されているDNSローカルCname設定を削除します。

path Parameters
index
required
integer

INDEX番号

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

SSH設定取得

SSH設定を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

SSH設定更新

SSH設定を更新します。

Request Body schema: application/json
required
enabled
boolean
Default: false

有効無効設定

port
integer
Default: 22

ポート番号設定

keepalive
boolean
Default: true

キープアライブ設定

object

受け入れ暗号化方式設定

Responses

Request samples

Content type
application/json
{
  • "enabled": false,
  • "port": 22,
  • "keepalive": true,
  • "ciphers": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

ストレージ設定一覧取得

登録されているストレージ設定一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

ストレージ設定新規登録

ストレージ設定を新規に登録します。

Request Body schema: application/json
required
name
required
string

パーティション名

fstype
string
Default: "ext4"
Enum: "vfat" "ext4" "xfs"

ファイルシステムタイプ

object
required
object
object
object
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "fstype": "vfat",
  • "crypt": {
    },
  • "mount": {
    },
  • "fsck": {
    },
  • "monitor": {
    },
  • "failsafe": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

ストレージ設定取得

登録されているストレージ設定を取得します。

path Parameters
name
required
string

パーティション名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

ストレージ設定一部更新

登録されているストレージ設定を一部更新します。

path Parameters
name
required
string

パーティション名

Request Body schema: application/json
required
name
required
string

パーティション名

fstype
string
Default: "ext4"
Enum: "vfat" "ext4" "xfs"

ファイルシステムタイプ

object
required
object
object
object
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "fstype": "vfat",
  • "crypt": {
    },
  • "mount": {
    },
  • "fsck": {
    },
  • "monitor": {
    },
  • "failsafe": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

ストレージ設定削除

登録されているストレージ設定を削除します。

path Parameters
name
required
string

パーティション名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

syslogローカル設定取得

登録されているsyslogローカル設定を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

syslogローカル設定一部更新

登録されているsyslogローカル設定を一部更新します。

Request Body schema: application/json
required
enabled
boolean
Default: true

ローカルログ出力有効無効設定

rotate-size
integer
Default: 10240

ローテーションの閾値サイズ（KB単位）

rotate-count
integer
Default: 8

ローテーションの世代数

level
string
Default: "informational"
Enum: "emergencies" "alerts" "critical" "errors" "warnings" "notifications" "informational" "debugging"

ログ出力レベル

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "rotate-size": 10240,
  • "rotate-count": 8,
  • "level": "emergencies"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

スケジュールキープアライブ設定一覧取得

登録されているスケジュールキープアライブ設定一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

スケジュールキープアライブ設定新規登録

スケジュールキープアライブ設定を新規に登録します。

Request Body schema: application/json
required
name
required
string

タスク名

enabled
boolean
Default: false

タスク有効無効設定

datetime
required
string

タスクの実施日付

action
required
string
Enum: "warm-reboot" "cold-reboot" "poe-reset-supply" "connect-ppp" "connect-ecm" "disconnect-ppp" "disconnect-ecm" "disconnect-ipsec" "reset-wifi" "reconnect-ipsec" "route-switch"

アクション

object

アクションのパラメータ

required
object
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "enabled": false,
  • "datetime": "string",
  • "action": "warm-reboot",
  • "parameters": {
    },
  • "ping": {
    },
  • "failsafe": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

スケジュールキープアライブ設定取得

登録されているスケジュールキープアライブ設定を取得します。

path Parameters
name
required
string

パーティション名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

スケジュールキープアライブ設定一部更新

登録されているスケジュールキープアライブ設定を一部更新します。

path Parameters
name
required
string

パーティション名

Request Body schema: application/json
required
name
required
string

タスク名

enabled
boolean
Default: false

タスク有効無効設定

datetime
required
string

タスクの実施日付

action
required
string
Enum: "warm-reboot" "cold-reboot" "poe-reset-supply" "connect-ppp" "connect-ecm" "disconnect-ppp" "disconnect-ecm" "disconnect-ipsec" "reset-wifi" "reconnect-ipsec" "route-switch"

アクション

object

アクションのパラメータ

required
object
object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "enabled": false,
  • "datetime": "string",
  • "action": "warm-reboot",
  • "parameters": {
    },
  • "ping": {
    },
  • "failsafe": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

スケジュールキープアライブ設定削除

登録されているスケジュールキープアライブ設定を削除します。

path Parameters
name
required
string

タスク名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

スケジュール一般制御設定一覧取得

登録されているスケジュール一般制御設定一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

スケジュール一般制御設定新規登録

スケジュール一般制御設定を新規に登録します。

Request Body schema: application/json
required
name
required
string

タスク名

enabled
boolean
Default: false

タスク有効無効設定

datetime
required
string

タスクの実施日付

action
required
string
Enum: "warm-reboot" "cold-reboot" "poe-reset-supply" "disconnect-ppp" "disconnect-ecm" "connect-ppp" "connect-ecm" "reset-wifi"

アクション

object

アクションのパラメータ

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "enabled": false,
  • "datetime": "string",
  • "action": "warm-reboot",
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

スケジュール一般制御設定取得

登録されているスケジュール一般制御設定を取得します。

path Parameters
name
required
string

パーティション名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

スケジュール一般制御設定一部更新

登録されているスケジュール一般制御設定を一部更新します。

path Parameters
name
required
string

パーティション名

Request Body schema: application/json
required
name
required
string

タスク名

enabled
boolean
Default: false

タスク有効無効設定

datetime
required
string

タスクの実施日付

action
required
string
Enum: "warm-reboot" "cold-reboot" "poe-reset-supply" "disconnect-ppp" "disconnect-ecm" "connect-ppp" "connect-ecm" "reset-wifi"

アクション

object

アクションのパラメータ

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "enabled": false,
  • "datetime": "string",
  • "action": "warm-reboot",
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

スケジュール一般制御設定削除

登録されているスケジュール一般制御設定を削除します。

path Parameters
name
required
string

タスク名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

スケジュールユーザー定義設定一覧取得

登録されているスケジュールユーザー定義設定一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

スケジュールユーザー定義新規登録

スケジュールユーザー定義を新規に登録します。

Request Body schema: application/json
required
name
required
string

タスク名

enabled
boolean
Default: false

タスク有効無効設定

datetime
required
string

タスクの実施日付

command
required
string

実行コマンド

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "enabled": false,
  • "datetime": "string",
  • "command": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

スケジュールユーザー定義設定取得

登録されているスケジュールユーザー定義設定を取得します。

path Parameters
name
required
string

パーティション名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

スケジュールユーザー定義設定一部更新

登録されているスケジュールユーザー定義設定を一部更新します。

path Parameters
name
required
string

パーティション名

Request Body schema: application/json
required
name
required
string

タスク名

enabled
boolean
Default: false

タスク有効無効設定

datetime
required
string

タスクの実施日付

command
required
string

実行コマンド

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "enabled": false,
  • "datetime": "string",
  • "command": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

スケジュールユーザー定義設定削除

登録されているスケジュールユーザー定義設定を削除します。

path Parameters
name
required
string

タスク名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

CPU動作周波数の取得

cpu動作周波数を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

CPU動作周波数の設定

CPU動作周波数を設定します

Request Body schema: application/json
required
cpufreq
string
Default: "ondemand"
Enum: "200MHZ" "250MHZ" "500MHZ" "1000MHZ" "ondemand"

CPU周波数

Responses

Request samples

Content type
application/json
{
  • "cpufreq": "200MHZ"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

POE設定一覧取得

POE設定一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

PoE設定状態の取得

PoE設定状態を取得します。

path Parameters
ifname
required
string

インタフェース名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

PoE設定更新

登録されているPoE設定を更新します。

path Parameters
ifname
required
string

インタフェース名

Request Body schema: application/json
required
name
string

インタフェース名

enabled
boolean
Default: true

PoEサービス有効化

ondelay
integer

オンディレイ

limit-current
string
Default: "auto"
Enum: "110" "204" "374" "592" "645" "754" "920" "auto"

リミットカレント

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "enabled": true,
  • "ondelay": 0,
  • "limit-current": "110"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

PoE設定削除

登録されているPoE設定を初期値に戻します。

path Parameters
ifname
required
string

インタフェース名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

プロキシサーバー設定取得

登録されているプロキシサーバー設定を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

プロキシサーバー設定一部更新

登録されているプロキシサーバー設定を一部更新します。

Request Body schema: application/json
required
enabled
boolean
Default: false

有効/無効

proxy-port
integer
Default: 8080

待ち受けポート番号

object

送信元ネットワーク設定

safe-port
Array of strings
ssl-port
Array of strings
http-access
string
Default: "deny"
Enum: "allow" "deny"
object

FQDNホワイトリスト設定

object

FQDNブラックリスト設定

object

URLホワイトリスト設定

object

URLブラックリスト設定

object

ユーザー認証設定

object

SYSLOG出力設定

Responses

Request samples

Content type
application/json
{
  • "enabled": false,
  • "proxy-port": 8080,
  • "proxy-source-address": {
    },
  • "safe-port": [
    ],
  • "ssl-port": [
    ],
  • "http-access": "allow",
  • "whitelist": {
    },
  • "blacklist": {
    },
  • "whitelist-url": {
    },
  • "blacklist-url": {
    },
  • "authentication": {
    },
  • "access-log": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

プロキシサーバー設定取得

登録されているプロキシサーバー設定を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

プロキシサーバー設定一部更新

登録されているプロキシサーバー設定を一部更新します。

Request Body schema: application/json
required
proxy-port
integer
Default: 8080

待ち受けポート番号

Responses

Request samples

Content type
application/json
{
  • "proxy-port": 8080
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Wi-FiWPS設定取得

登録されているWi-FiWPS設定を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

アクセスポイントPIN生成

Wi-FiWPS　アクセスポイントモードで使用するPINの設定・保存を行います。

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Wi-FiWPS設定更新

Wi-FiWPS設定を更新します。

Request Body schema: application/json
required
enabled
boolean
Default: false

有効無効設定

push-switch
boolean
Default: false

PUSHスイッチ監視有効無効設定

external-registar
boolean

外部レジストラ有効無効設定

pin
string

PINコード設定

Responses

Request samples

Content type
application/json
{
  • "enabled": false,
  • "push-switch": false,
  • "external-registar": true,
  • "pin": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Wi-Fiアクセスポイント設定取得

登録されているWi-Fiアクセスポイント設定を取得します。 keyには暗号化していないデータを設定します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

Wi-Fiアクセスポイント新規登録

Wi-Fiアクセスポイントを新規に登録します

Request Body schema: application/json
required
ap-name
string

アクセスポイント名

enabled
boolean
Default: false

有効無効設定

band
string

周波数

ssid
string

SSID

object

チャンネル設定

transmit-power
integer

送信出力

max-station
integer

ステーション最大接続数

stealth
boolean
Default: "disable"

SSIDステルス

privacy-separator
boolean
Default: "disable"

隔離機能

dtim-period
integer

DTIM期間設定

beacon-interval
integer

ビーコン間隔

rts-threshold
integer

RTS閾値

object

セキュリティ設定

object

MACアドレスフィルター

Responses

Request samples

Content type
application/json
{
  • "ap-name": "string",
  • "enabled": false,
  • "band": "string",
  • "ssid": "string",
  • "channel": {
    },
  • "transmit-power": 0,
  • "max-station": 0,
  • "stealth": "disable",
  • "privacy-separator": "disable",
  • "dtim-period": 0,
  • "beacon-interval": 0,
  • "rts-threshold": 0,
  • "security": {
    },
  • "mac-address-filtering": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Wi-Fiアクセスポイント設定取得

登録されているWi-Fiアクセスポイント設定を取得します。 pinの設定有無に関わらず、pinの変更は行いません。

path Parameters
name
required
string

アクセスポイント名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

Wi-Fiアクセスポイント設定更新

Wi-Fiアクセスポイントの設定を更新

path Parameters
name
required
string

アクセスポイント名

Request Body schema: application/json
required
ap-name
string

アクセスポイント名

enabled
boolean
Default: false

有効無効設定

band
string

周波数

ssid
string

SSID

object

チャンネル設定

transmit-power
integer

送信出力

max-station
integer

ステーション最大接続数

stealth
boolean
Default: "disable"

SSIDステルス

privacy-separator
boolean
Default: "disable"

隔離機能

dtim-period
integer

DTIM期間設定

beacon-interval
integer

ビーコン間隔

rts-threshold
integer

RTS閾値

object

セキュリティ設定

object

MACアドレスフィルター

Responses

Request samples

Content type
application/json
{
  • "ap-name": "string",
  • "enabled": false,
  • "band": "string",
  • "ssid": "string",
  • "channel": {
    },
  • "transmit-power": 0,
  • "max-station": 0,
  • "stealth": "disable",
  • "privacy-separator": "disable",
  • "dtim-period": 0,
  • "beacon-interval": 0,
  • "rts-threshold": 0,
  • "security": {
    },
  • "mac-address-filtering": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Wi-Fiアクセスポイント削除

登録されているWi-Fiアクセスポイント設定を削除します。

path Parameters
name
required
string

アクセスポイント名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Wi-Fiステーション設定取得

登録されているWi-Fiステーション設定を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

Wi-Fiステーション新規登録

Wi-Fiステーションを新規に登録します

Request Body schema: application/json
required
sta-name
string

ステーション名

enabled
boolean
Default: false

有効無効設定

band
string

周波数

ssid
string

SSID

bssid
string

BSSID

priority
integer

優先度グループ

max-inactivity-limit
integer

非アクティブ制限設定

dtim-period
integer

ビーコン間隔のDTIM期間

beacon-interval
integer

ビーコン間隔

object

セキュリティ設定

object

接続チャンネル設定

Responses

Request samples

Content type
application/json
{
  • "sta-name": "string",
  • "enabled": false,
  • "band": "string",
  • "ssid": "string",
  • "bssid": "string",
  • "priority": 0,
  • "max-inactivity-limit": 0,
  • "dtim-period": 0,
  • "beacon-interval": 0,
  • "security": {
    },
  • "scan-channel:": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Wi-Fiステーション設定取得

登録されているWi-Fiステーション設定を取得します。

path Parameters
name
required
string

IKE名

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

Wi-Fiステーション設定更新

Wi-Fiステーションの設定を更新

path Parameters
name
required
string

ステーション名

Request Body schema: application/json
required
sta-name
string

ステーション名

enabled
boolean
Default: false

有効無効設定

band
string

周波数

ssid
string

SSID

bssid
string

BSSID

priority
integer

優先度グループ

max-inactivity-limit
integer

非アクティブ制限設定

dtim-period
integer

ビーコン間隔のDTIM期間

beacon-interval
integer

ビーコン間隔

object

セキュリティ設定

object

接続チャンネル設定

Responses

Request samples

Content type
application/json
{
  • "sta-name": "string",
  • "enabled": false,
  • "band": "string",
  • "ssid": "string",
  • "bssid": "string",
  • "priority": 0,
  • "max-inactivity-limit": 0,
  • "dtim-period": 0,
  • "beacon-interval": 0,
  • "security": {
    },
  • "scan-channel:": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

Wi-Fiステーション削除

登録されているWi-Fiアクセスポイント設定を削除します。

path Parameters
name
required
string

ステーション名

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

CVR設定取得

CVR設定を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

CVR設定更新

CVR設定を更新します。

Request Body schema: application/json
required
enabled
boolean
Default: true

有効無効設定

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

永続化設定一覧取得

永続化設定一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

永続化設定ファイルダウンロード

永続化設定ファイルをダウンロードします。

{file}(設定ファイル名)が「status」の場合ファイルのダウンロードは行いません 。

path Parameters
file
required
string

設定ファイル名

Responses

Response samples

Content type
application/json
Example
{
  • "result": {
    }
}

永続化設定ファイルアップロード

永続化設定ファイルをアップロードします。

path Parameters
file
required
string

設定ファイル名

Request Body schema: multipart/form-data
file
required
string <binary>

設定ファイルデータ

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

設定ファイルダウンロード

現在運用している設定ファイルをダウンロードします。

Responses

Response samples

Content type
application/json
Example
{
  • "result": {
    }
}

永続化設定保存

永続化設定を保存します。

Request Body schema: application/json
required
name
required
string

設定ファイル名

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

永続化設定読込

永続化設定を読み込みます。

Request Body schema: application/json
required
name
required
string

設定ファイル名

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

永続化設定初期化

永続化設定を初期化します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

永続化設定コピー

永続化設定をコピーします。

Request Body schema: application/json
required
src-name
required
string

コピー元設定ファイル名

dst-name
required
string

コピー先設定ファイル名

Responses

Request samples

Content type
application/json
{
  • "src-name": "string",
  • "dst-name": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

永続化設定名変更

永続化設定名を変更します。

Request Body schema: application/json
required
src-name
required
string

変更前の設定ファイル名

dst-name
required
string

変更後の設定ファイル名

Responses

Request samples

Content type
application/json
{
  • "src-name": "string",
  • "dst-name": "string"
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

永続化設定状態取得

永続化設定状態を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

NxWitness設定書込み

NxWitness設定を保存します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

NxWitness設定読込み

NxWitness設定をシステムに反映させます。

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

CVR(vms-agent)用設定取得

CVR(vms-agent)用設定取得

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

CVR(vms-agent)用設定ファイルアップロード

CVR(vms-agent)用設定ファイルをアップロードします。

Request Body schema: multipart/form-data
file
required
string <binary>

設定ファイルデータ

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

CVR(vms-agent)用設定ファイル削除

CVR(vms-agent)用設定ファイルを削除します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

CVRカメラ設定一覧取得

登録されているカメラ設定一覧を取得します。

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

CVRカメラ設定登録

カメラ設定を新規に登録します。

Request Body schema: application/json
required
id
string

カメラID

name
string

カメラ表示名

user
string

ユーザー名

password
string

パスワード

rtsp-url
string

RTSP-URL

port
string

接続ポート

ipAaddress
string

IPアドレス

connectionStatus
string

接続状態

object

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "user": "string",
  • "password": "string",
  • "rtsp-url": "string",
  • "port": "string",
  • "ipAaddress": "string",
  • "connectionStatus": "string",
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

CVRカメラ設定取得

登録されているカメラ設定を取得します。

path Parameters
id
required
string

カメラID

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}

CVRカメラ設定更新

登録されているカメラ設定を更新します。

path Parameters
id
required
string

カメラID

Request Body schema: application/json
required
id
string

カメラID

name
string

カメラ表示名

user
string

ユーザー名

password
string

パスワード

rtsp-url
string

RTSP-URL

port
string

接続ポート

ipAaddress
string

IPアドレス

connectionStatus
string

接続状態

object

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "user": "string",
  • "password": "string",
  • "rtsp-url": "string",
  • "port": "string",
  • "ipAaddress": "string",
  • "connectionStatus": "string",
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

CVRカメラ設定削除

登録されているカメラ設定を削除します。

path Parameters
id
required
string

カメラID

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

カメラメーカー設定一覧

Responses

Response samples

Content type
application/json
{
  • "result": {
    },
  • "content": {
    }
}