REST API

OpManagerは、データの追加または取得を行うためのREST APIを提供しています。
これらを利用することで、サードパーティのIT管理ソフトウェアやサービスとの連携が実現できます。

目次

APIキーの管理・生成

UI右上の歯車アイコン歯車アイコン→［REST APIキー］より、 現在使用しているREST APIキーを確認、コピーできます。
［キー再作成］をクリックすると、APIキーの再生成が可能です。

再発行した場合、既存のキーは無効になります。
REST APIキー

使用可能なAPI

使用可能なAPIの一覧および説明は、以下のドキュメントをご参照ください。
OpManager REST API

英語ドキュメントの解説画像

遷移先ページの説明は以下の通りです。

日本の最新ビルドでは未リリースの情報を含む可能性があります。
項目名 説明
①機能の種類 機能の種類でページが分かれています。
画面左側のペインから使用する機能の種類を選択します。
②API名 APIの名称です。
③メソッド APIが使用するリクエストメソッドです。
④説明 APIの説明です。取得できるデータの概要を確認します。
⑤URLのサンプル URLのサンプルです。サンプル内の各パラメータおよびFQDNをご利用の情報に置換し利用します。
⑥応答結果のサンプル 応答結果のサンプルです。
⑦パラメータの詳細 使用するパラメータの名称と説明です。

使用手順の例

以下の情報を用いて、実際に使用する際の手順の例を紹介します。

項目名 値の例
使用するAPI getPingResponse
実行対象の装置に対してPingを実行するAPIです。
APIの説明画像
OpManagerのホスト名とポート番号 ホスト名：OpManagerServer
ポート番号：8060
実行対象装置のMO名 TargetDevice
APIキー 123456789

実行手順

  1. OpManagerに管理者権限アカウントでログインします。
  2. APIキーを確認、コピーします。
  3. 使用するAPIを確認します。
  4. 項番2、3で確認した内容を元にURLを作成します。
    https://OpManagerServer:8060/api/json/device/getPingResponse?apiKey=123456789&deviceName=TargetDevice
  5. 実行します。