| 両方とも前のリビジョン 前のリビジョン 次のリビジョン | 前のリビジョン |
| ja:documentation:pandorafms:technical_reference:02_annex_externalapi [2025/09/12 23:08] – junichi | ja:documentation:pandorafms:technical_reference:02_annex_externalapi [2025/11/29 05:47] (現在) – [アクセス元による] junichi |
|---|
| * <wrap :en>**Users**</wrap>: For [[en:documentation:pandorafms:management_and_operation:11_managing_and_administration#ks1_1|manage PFMS users]]. | * <wrap :en>**Users**</wrap>: For [[en:documentation:pandorafms:management_and_operation:11_managing_and_administration#ks1_1|manage PFMS users]]. |
| * <wrap :en>**PandoraITSM**</wrap>: To manage the [[en:documentation:pandorafms:management_and_operation:04_inventory|inventory]] provided by [[en:documentation:10_pandora_itsm:20_pandora_itsm_pandorafms|Pandora ITSM]] to PFMS. | * <wrap :en>**PandoraITSM**</wrap>: To manage the [[en:documentation:pandorafms:management_and_operation:04_inventory|inventory]] provided by [[en:documentation:10_pandora_itsm:20_pandora_itsm_pandorafms|Pandora ITSM]] to PFMS. |
| | * <wrap :en>**API Endpoints of SIEM (Security Information and Event Management)**</wrap>: To execute [[:en:documentation:pandorafms:cybersecurity:21_siem|actions and configurations in SIEM]]. |
| | * <wrap :en>**MONITORING API Endpoints for add data modules**</wrap>: Starting with version 785, new endpoint for [[#ks1_8|adding module data to Pandora FMS]]. |
| |
| * <wrap :ja>**認証(Authentication)**</wrap>: API アクセス トークンを管理します (最初のトークンは常に [[#ks1_3|Web コンソール経由で]] 生成します)。 | * <wrap :ja>**認証(Authentication)**</wrap>: API アクセス トークンを管理します (最初のトークンは常に [[#ks1_3|Web コンソール経由で]] 生成します)。 |
| * <wrap :ja>**ユーザ(Users)**</wrap>: [[ja:documentation:pandorafms:management_and_operation:11_managing_and_administration#ks1_1|PFMS ユーザを管理します]]。 | * <wrap :ja>**ユーザ(Users)**</wrap>: [[ja:documentation:pandorafms:management_and_operation:11_managing_and_administration#ks1_1|PFMS ユーザを管理します]]。 |
| * <wrap :en>**PandoraITSM**</wrap>: [[en:documentation:10_pandora_itsm:20_pandora_itsm_pandorafms|Pandora ITSM]] によって PFMS に提供される [[ja:documentation:pandorafms:management_and_operation:04_inventory|インベントリ]] を管理します。 | * <wrap :en>**PandoraITSM**</wrap>: [[en:documentation:10_pandora_itsm:20_pandora_itsm_pandorafms|Pandora ITSM]] によって PFMS に提供される [[ja:documentation:pandorafms:management_and_operation:04_inventory|インベントリ]] を管理します。 |
| | * <wrap :ja>**SIEM (セキュリティ情報イベント管理) の API エンドポイント**</wrap>: [[:ja:documentation:pandorafms:cybersecurity:21_siem|SIEM のアクションと設定]] を実行します。 |
| | * <wrap :ja>**データモジュール追加用の監視 API エンドポイント**</wrap>: バージョン 785 以降、[[#ks1_8|Pandora FMS にモジュールデータを追加]] するための新しいエンドポイントが追加されました。 |
| |
| <wrap #ks1_5 /> | <wrap #ks1_5 /> |
| |
| {{ wiki:pfms-api_2-ping.png }} | {{ wiki:pfms-api_2-ping.png }} |
| | |
| | <wrap #ks1_8 /> |
| | |
| | ==== モジュールデータを追加するための API エンドポイント ==== |
| | |
| | Starting with version 785, and as an alternative to [[:en:documentation:pandorafms:technical_reference:09_tentacle|the Tentacle protocol]], there is an option to send checks through PFMS API 2.0. |
| | |
| | バージョン 785 以降では、[[:ja:documentation:pandorafms:technical_reference:09_tentacle|Tentacle プロトコル]] の代替として、PFMS API 2.0 を介して監視データを送信するオプションがあります。 |
| | |
| | All documentation may be checked using the [[#ks1_6|Documentation outline]], which describes the general and most important features here: |
| | |
| | すべてのドキュメントは、[[#ks1_6|ドキュメントの概要]] を使用して確認できます。ここでは、一般的な機能と最も重要な機能について説明します。 |
| | |
| | * The body consists of an array of agents with their corresponding modules. |
| | * If the agent does not exist, a new one will be created; if it already exists, it will be updated. |
| | * Each position in the array contains the same modules processed by the [[:en:documentation:pandorafms:introduction:02_architecture#data_server|Data Server]], respecting exactly the same fields. **Therefore, any field used in the Data Server may be used here.** |
| | * Data that may be sent in the API: |
| | |
| | * 本体は、エージェントとそれに対応するモジュールの配列で構成されます。 |
| | * エージェントが存在しない場合は新規に作成され、既に存在する場合は更新されます。 |
| | * 配列内の各位置には、[[:ja:documentation:pandorafms:introduction:02_architecture#data_server|データサーバ]] で処理されるモジュールと同じモジュールが含まれ、同じフィールドが保持されます。**したがって、データサーバで使用されるフィールドはすべてここで使用できます。** |
| | * API で送信できるデータ: |
| | |
| | ^ Command ^ Description ^ |
| | | ''agent_data'' |Agent data, such as name, operating system ID, operating system version, update interval, address, and description. | |
| | | ''module_data'' |Array of modules with their name, type, and data. You may also specify a dataList to add multiple data values at once. | |
| | | ''inventory_data'' |Agent inventory data. | |
| | | ''log_data'' |Agent log data. | |
| | | ''trap_data'' |SNMP trap data from the agent. | |
| | | ''events'' |Event in base64. | |
| | | ''discovery_data'' |Agent discovery data in base64. | |
| | | ''cmd_data'' |Agent command data. | |
| | |
| | ^ コマンド ^ 説明 ^ |
| | | ''agent_data'' |名前、オペレーティングシステム ID、オペレーティングシステムのバージョン、更新間隔、アドレス、説明などのエージェントデータ。 | |
| | | ''module_data'' |モジュールの名前、タイプ、データを含む配列。dataList を指定して複数のデータ値を一度に追加することもできます。 | |
| | | ''inventory_data'' |エージェントインベントリデータ。 | |
| | | ''log_data'' |エージェントログデータ。 | |
| | | ''trap_data'' |エージェントからの SNMP トラップデータ。 | |
| | | ''events'' |base64 でのイベント。 | |
| | | ''discovery_data'' |base64 でのエージェント自動検出データ。 | |
| | | ''cmd_data'' |エージェントコマンドデータ。 | |
| |
| <wrap #ks2 /> | <wrap #ks2 /> |
| === アクセス元による === | === アクセス元による === |
| |
| At the moment, security is based on an IP addresses list that will have [[:es:documentation:04_using:12_console_setup#general_setup|access to the tool]]. | At the moment, security is based on an IP addresses list that will have [[:en:documentation:pandorafms:management_and_operation:12_console_setup#ks1_1|access to the tool]]. |
| |
| 現時点では、セキュリティは[[:ja:documentation:04_using:12_console_setup#一般設定|アクセスする IP アドレスリスト]]に基づいています。 | 現時点では、セキュリティは[[:ja:documentation:pandorafms:management_and_operation:12_console_setup#ks1_1|アクセスする IP アドレスリスト]]に基づいています。 |
| |
| {{ :wiki:screnshot_of_api_acl_list_setup.png }} | {{ :wiki:screnshot_of_api_acl_list_setup.png }} |