LogicMonitorのRESTAPIを使用する
最終更新日: 02 年 2023 月 XNUMX 日すべての更新と拡張は、LogicMonitor REST API v3 のみに対して行われます。 一歩先を行くために、最新の v3 に切り替えることを強くお勧めします。
LogicMonitor REST APIを使用すると、ダッシュボード、デバイス、レポート、サービス、アラート、コレクター、データソース、SDTなどのLogicMonitorリソースをプログラムでクエリおよび管理できます。
ベースURL
RESTAPIリクエストを行うためのベースURLは次のとおりです。
https://ACCOUNTNAME.logicmonitor.com/santaba/restここで、交換する必要があります ACCOUNTNAME を LogicMonitor アカウント名に置き換えます。
サポートされている API バージョン
LogicMonitor REST API は、v3、v2、および v1 の XNUMX つのバージョンで利用できます。 使用するバージョンを決定するには、次のガイドラインを考慮する必要があります。
- 私たちはフォローする セマンティックバージョニング、ただし、リクエストではメジャー バージョンのみが許可されます (最新のマイナー バージョンまたはパッチ バージョンが常に返されます)
- すべての更新と機能強化はバージョン 3 に対して行われます たったの.
- バージョンは、X-Version ヘッダーで指定するか、クエリ パラメーターとして URL で指定できます。 「?v=3」クエリ パラメータまたは「X-Version:3」ヘッダーを含めることによって、v3 リクエストを行うことができます。
最新の v3 API にアクセスするには、次を参照してください。 v3 Swagger ドキュメント.
認証
LogicMonitorサーバーに送信される各要求は、 HTTPS、また認証される必要があります。 すべてのデータは JSON として受信されます。 LogicMonitor REST API は現在、次の XNUMX つの認証方法をサポートしています。
- API トークンベースの認証
- 基本認証
注： 基本認証は API の v1 でのみサポートされており、API の将来のバージョンでは使用できない可能性があります。 したがって、API トークン認証を使用して REST API 要求を行うことを強くお勧めします。
詳細については、を参照してください。 RESTAPI認証.
帯域制限
LogicMonitor REST API へのリクエストには、レート制限が適用されます。 制限は、エンドポイントとメソッドの組み合わせによって異なります。 デフォルトのレート制限のリスト、レスポンス ヘッダーからレート制限情報を取得する方法の詳細、およびレート制限に対応するようにスクリプトを調整する方法の複数言語の例については、次を参照してください。 帯域制限.
ステータス コードとエラー コード
ロールアウトした API バージョンごとに、ステータス コードとエラー コードを進化させ、改善してきました。 リストにアクセスするには、を参照してください。 ステータスコード や エラーコード.
変更ログ
LogicMonitor REST API は常に進化しています。 API に対して行われたすべての更新を追跡するには、次を参照してください。 変更ログ.
サポートされている HTTP メソッド
LogicMonitor REST API は、グローバルに使用される HTTP 動詞またはメソッドを使用します。 それらは、POST、GET、PUT、PATCH、および DELETE です。 これらのメソッドは、それぞれ Create、Read/Retrieve、Update、および Delete (別名 CRUD) 操作に対応しています。
- POST– 通常、POST API は、新しい従属リソースを作成するために使用されます。 LogicMonitor REST API は POST メソッドを使用して、API トークン、ダッシュボード グループなどを追加します。 たとえば、POST/dashboard/groups と POST/setting/alert/chains です。
- GET– GET リクエストを使用して、リソース情報を読み取り/取得します。 GET メソッドを使用して、リソースのコンテンツとデータの表現を取得できます。 たとえば、GET/alert/alerts/{id} および GET/dashboard/groups/{id} です。
- PUT– PUT メソッドを使用して、コンテンツを完全に置き換えてリソースを更新します。 REST 標準に準拠して、PUT 要求で指定されていないプロパティはすべてデフォルト値に戻ります。 PUT リクエストの例は、PUT/setting/alert/chains/{id} および PUT/setting/recipientgroups/{id} です。
- PATCH– PATCH メソッドを使用して、リソース コンテンツを更新/変更します。 PATCH リクエストでは、リソースに加えたい更新を指定する必要があります。 たとえば、PATCH/report/reports/{id} および PATCH/setting/roles/{id} です。
- DELETE– DELETE メソッドを使用して、URI で識別されるリソースを削除します。 リソースは完全に削除されます。 たとえば、DELETE/sdt/sdts/{id} および DELETE/setting/recipientgroups/{id} です。
ロジックモニターSDK
REST API に加えて、LogicMonitor は SDK もサポートしています。 ダウンロード可能な v3 Python SDK ファイルを取得するには、次を参照してください。 LogicMonitor v3 SDK.