API一覧

サポートAPIの一覧です。APIはURLのアルファベット順に記載しています。

URL	メソッド	参照先	ロール^※1
/api/v1/activation-key	GET	「アクティベーションキー取得」	ADMIN
/api/v1/activation-key	PUT	「アクティベーションホワイトリスト機能ON/OFF」	ADMIN
/api/v1/activation-whitelist	GET	「ホワイトリスト一覧取得」	ADMIN
/api/v1/activation-whitelist	POST	「ホワイトリスト登録」	ADMIN
/api/v1/activation-whitelist/activationWhiteListId	DELETE	「ホワイトリスト削除」	ADMIN
/api/v1/agents	GET	「エージェント一覧取得」
/api/v1/agents/agentId	GET	「エージェント詳細取得」
	PUT	「エージェントステータス変更」 ^※2
	PUT	「エージェント動作設定変更」 ^※2
	PUT	「ユニット変更」 ^※2
	PUT	「プロファイル変更」 ^※2
	PUT	「モジュールバージョン変更」 ^※2
	DELETE	「エージェント削除」
/api/v1/agents/agentId/queues/receiving	GET	「受信タスク一覧取得」
/api/v1/agents/agentId/queues/receiving/receivingTaskId	DELETE	「受信タスク削除」
/api/v1/device-access-logs	GET	「アクセスログ一覧取得」
/api/v1/distributionModules	POST	「ファイル配付」
/api/v1/genkey	POST	「APIキー再取得」
/api/v1/license	GET	「プロダクト情報取得」	ADMIN
/api/v1/license	PUT	「プロダクトキー更新」	ADMIN
/api/v1/license-option	GET	「ライセンスオプション情報取得」
/api/v1/login	POST	「APIキー取得」
/api/v1/modules	GET	「アップデートモジュール一覧取得」
/api/v1/modules	POST	「アップデートモジュール登録」
/api/v1/modules/moduleId	DELETE	「アップデートモジュール削除」
/api/v1/profiles	GET	「プロファイル一覧取得」
/api/v1/profiles/profileId	GET	「プロファイル詳細取得」
	PUT	「プロファイル情報更新」
	DELETE	「プロファイル削除」
/api/v1/profiles/profileId/receiving-profiles	GET	「受信設定一覧取得」
/api/v1/profiles/profileId/receiving-profiles	POST	「受信設定作成」
/api/v1/profiles/profileId/sending-profiles	GET	「転送設定一覧取得」
/api/v1/profiles/profileId/sending-profiles	POST	「転送設定作成」
/api/v1/receiving-logs	GET	「受信履歴一覧取得」
/api/v1/receiving-logs/receivingLogId	GET	「受信履歴詳細取得」
/api/v1/receiving-profiles/receivingProfileId	GET	「受信設定詳細取得」
	PUT	「受信設定情報更新」
	DELETE	「受信設定削除」
/api/v1/sending-profiles/sendingProfileId	GET	「転送設定詳細取得」
	PUT	「転送設定情報更新」
	DELETE	「転送設定削除」
/api/v1/system-settings	GET	「システム設定（ログ）取得」	ADMIN
/api/v1/system-settings	PUT	「システム設定（ログ）変更」	ADMIN
/api/v1/system-settings/notifications	GET	「システム設定（通知）取得」	ADMIN
/api/v1/system-settings/notifications	PUT	「システム設定（通知）変更」	ADMIN
/api/v1/system-settings/notifications/test-email	POST	「テストメール送信」	ADMIN
/api/v1/trace-logs	GET	「トレースログ一覧取得」
/api/v1/trace-logs/traceLogUniqueId	GET	「トレースログ詳細取得」
/api/v1/transfer-logs	GET	「転送履歴一覧取得」
/api/v1/transfer-logs/transferLogId	GET	「転送履歴詳細取得」
/api/v1/transfer-states	GET	「転送状況一覧取得」
/api/v1/units	GET	「ユニット一覧取得」
/api/v1/units	POST	「ユニット作成」
/api/v1/units/unitId	GET	「ユニット詳細取得」
	PUT	「ユニット情報更新」
	DELETE	「ユニット削除」
/api/v1/units/unitId/profiles	POST	「プロファイル作成」
/api/v1/user	GET	「ユーザー一覧取得」	ADMIN
/api/v1/user	POST	「ユーザー作成」	ADMIN
/api/v1/user/userId	GET	「ユーザー詳細取得」
	PUT	「ユーザー情報更新」 ^※3	ADMIN
	PUT	「ユーザーパスワード変更」 ^※3	^※4 ADMIN
	DELETE	「ユーザー削除」	ADMIN
/api/v1/user/userId/unit	GET	「管理対象ユニット一覧取得」	ADMIN
/api/v1/user/userId/unit	POST	「管理対象ユニットアタッチ」	ADMIN
/api/v1/user/userId/unit/unitId	DELETE	「管理対象ユニットデタッチ」	ADMIN
/api/v1/user-role	GET	「ユーザーロール一覧取得」	ADMIN
/api/v1/version	GET	「バージョン情報取得」

※1

「ロール」が空欄のAPIは、管理者ユーザーでも一般ユーザーでも実行できます。

「ロール」に「ADMIN」と記載されているAPIは、管理者ユーザーだけが実行できます。

※2

これらのAPIは同一です (/api/v1/agents/agentId)。

エージェントステータス変更
エージェント動作設定変更
ユニット変更
プロファイル変更
モジュールバージョン変更

このマニュアルでは、目的に応じたリクエストパラメータに変更して、個別に記載しています。

※3

これらのAPIは同一です (/api/v1/user/userId)。

ユーザー情報更新
ユーザーパスワード変更

このマニュアルでは、目的に応じたリクエストパラメータに変更して、個別に記載しています。

※4

ロールがADMINの場合（管理者ユーザー）は、自分以外のパスワードを更新できます。

ロールがUSERの場合（一般ユーザー）は、自分のパスワードのみ更新できます。