X-MONのAPI機能のドキュメントです。
確認したいメソッドを左側のメニューから選んで確認してください。
各メソッドはAPIにリクエストを送るユーザの権限によって利用可能、制限あり、不可という区分があります。本ドキュメントでは、次のように権限を分類しています。
| 権限名 |
該当メソッドが制限なく使えるもの |
|---|---|
| 権限名 |
該当メソッドが制限付き使えるもの 制限の内容はドキュメントに記載されています。 |
| 権限名 |
該当メソッドが使用不可能なもの |
X-MON APIのSDKに関しては以下をご参照ください。
X-MONのAPIは、JSON-RPCにてやり取りを行います。
| カラム名称 | 型 | 概要 |
|---|---|---|
| jsonrpc 必須 | string |
jsonrpcのバージョンを指定します。 2.0 を指定してください。 |
| method 必須 | string |
実行するメソッドを指定します。 |
| params | array |
メソッドに渡すパラメータを指定します。 |
| id 必須 | string |
任意のIDを指定します。 レスポンスにも同じIDが返ってきます。 |
| user_id 必須 | string |
APIを実行するX-MONのユーザIDを指定します。 |
| auth_token 必須 | string |
user_idで指定したユーザのX-MON APIアクセスキーを指定します。 |
user_id/auth_tokenは、X-MONの「X-MON API 設定」で作成したものを使用してください。
| カラム名称 | 概要 |
|---|---|
| result |
リクエストが正常に成功した場合は、resultカラムが返ってきます。 記載内容はメソッドによって違います。 |
| error |
エラーが発生した場合は、errorカラムが返ってきます。 |
| id |
リクエストに付与したIDがそのまま返ってきます。 |