REST API
OpManagerは、データの追加または取得を行うためのREST APIを提供しています。
これらを利用することで、サードパーティのIT管理ソフトウェアやサービスとの連携が実現できます。
目次
APIキーの管理・生成
UI右上の歯車アイコン
→［REST APIキー］より、
現在使用しているREST APIキーを確認、コピーできます。
［キーの再作成］をクリックすると、APIキーの再生成が可能です。
再発行した場合、既存のキーは無効になります。
使用可能なAPI
使用可能なAPIの一覧および説明は、以下のドキュメントをご参照ください。
OpManager REST API
遷移先ページの説明は以下の通りです。
| 項目名 | 説明 |
|---|---|
| 機能の種類 |
機能の種類でページが分かれています。 画面左側のペインから使用する機能の種類を選択します。 |
| API名 | APIの名称です。 |
| メソッド | APIが使用するリクエストメソッドです。 |
| 説明 | APIの説明です。取得できるデータの概要を確認します。 |
| URLのサンプル | URLのサンプルです。サンプル内の各パラメータおよびFQDNをご利用の情報に置換し利用します。 |
| 応答結果のサンプル | 応答結果のサンプルです。 |
| パラメータの詳細 | 使用するパラメータの名称と説明です。 |
使用手順の例
以下の情報を用いて、実際に使用する際の手順の例を紹介します。
| 項目名 | 値の例 |
|---|---|
| 使用するAPI |
getPingResponse 実行対象の装置に対してPingを実行するAPIです。  |
| OpManagerのホスト名とポート番号 |
ホスト名：OpManagerServer ポート番号：8060 |
| 実行対象装置のMO名 | TargetDevice |
| APIキー | 123456789 |