| 両方とも前のリビジョン 前のリビジョン 次のリビジョン | 前のリビジョン |
| ja:documentation:pandorafms:technical_reference:02_annex_externalapi [2025/07/21 07:39] – [set create_plugin_module] junichi | ja:documentation:pandorafms:technical_reference:02_annex_externalapi [2025/09/12 23:08] (現在) – junichi |
|---|
| <WRAP center round info 90%> | <WRAP center round info 90%> |
| |
| Through the [[#ks1_4|web interface]] you can generate and copy the necessary codes, with their parameters and mandatory fields, of all the commands of this PFMS API 2.0. See [[#ks1_6|schemas]] for more details. | Through the [[#ks1_4|web interface]] you can generate and copy the necessary codes, with their parameters and required fields, of all the commands of this PFMS API 2.0. See [[#ks1_6|schemas]] for more details. |
| |
| </WRAP> | </WRAP> |
| <WRAP center round tip 90%> | <WRAP center round tip 90%> |
| |
| In this schema, the mandatory parameters have the property set to ''nullable: false''. | In this schema, the required parameters have the property set to ''nullable: false''. |
| |
| </WRAP> | </WRAP> |
| |
| * [[:en:documentation:08_technical_reference:02_annex_externalapi#by_origin|Filtering by IP address]]: Only the listed IP addresses will be able to access the API. | * [[:en:documentation:08_technical_reference:02_annex_externalapi#by_origin|Filtering by IP address]]: Only the listed IP addresses will be able to access the API. |
| * [[:en:documentation:08_technical_reference:02_annex_externalapi#by_api_password|Global password for the API]]: If defined, it is mandatory to use it in all calls. | * [[:en:documentation:08_technical_reference:02_annex_externalapi#by_api_password|Global password for the API]]: If defined, it is required to use it in all calls. |
| * [[:en:documentation:08_technical_reference:02_annex_externalapi#by_user_credentials|User and password]]: User of type [[:en:documentation:01_understanding:03_glossary#superadmin|superadmin]] and valid in the Web Console. Your permissions will be used for each requested operation. **From version NG 768 onwards** it is also possible to access by [[:en:documentation:08_technical_reference:02_annex_externalapi#authentication_by_bearer_token|bearer token]]. | * [[:en:documentation:08_technical_reference:02_annex_externalapi#by_user_credentials|User and password]]: User of type [[:en:documentation:01_understanding:03_glossary#superadmin|superadmin]] and valid in the Web Console. Your permissions will be used for each requested operation. **From version NG 768 onwards** it is also possible to access by [[:en:documentation:08_technical_reference:02_annex_externalapi#authentication_by_bearer_token|bearer token]]. |
| |
| - < min > | - < min > |
| - < max > | - < max > |
| - < post_process > ( {{:wiki:icono-modulo-enterprise.png?23x23|Enterprise version}}only for [[:en:documentation:pandorafms:installation:05_configuration_agents#module_postprocess|Software Agents]] with remote configuration enabled). | - < post_process > ( Only for [[:en:documentation:pandorafms:installation:05_configuration_agents#module_postprocess|EndPoints]] with remote configuration enabled). |
| - < [[:en:documentation:pandorafms:installation:05_configuration_agents#module_interval|module_interval]] > | - < [[:en:documentation:pandorafms:installation:05_configuration_agents#module_interval|module_interval]] > |
| - < min_warning > | - < min_warning > |
| - < 最小 > | - < 最小 > |
| - < 最大 > | - < 最大 > |
| - < 保存倍率 > ( {{:wiki:icono-modulo-enterprise.png?23x23|Enterprise 版}}([[:ja:documentation:pandorafms:installation:05_configuration_agents#module_postprocess|ソフトウエアエージェント]] でリモート設定が有効な場合のみ) | - < 保存倍率 > ([[:ja:documentation:pandorafms:installation:05_configuration_agents#module_postprocess|エンドポイント]] でリモート設定が有効な場合のみ) |
| - < [[:ja:documentation:pandorafms:installation:05_configuration_agents#module_interval|モジュールの間隔]] > | - < [[:ja:documentation:pandorafms:installation:05_configuration_agents#module_interval|モジュールの間隔]] > |
| - < 警告の最小値 > | - < 警告の最小値 > |
| |
| * op=set (required) | * op=set (required) |
| * op2=add_agent_policy_by_id (mandatory) | * op2=add_agent_policy_by_id (required) |
| * id=<id_policy> (required). It must be a policy Id. | * id=<id_policy> (required). It must be a policy Id. |
| * other=<serialized parameters> (required). These are agent configuration and data, serialized in the following order: | * other=<serialized parameters> (required). These are agent configuration and data, serialized in the following order: |
| |
| { | { |
| name: <value>, // mandatory | name: <value>, // required |
| id_module: <value>, // mandatory | id_module: <value>, // required |
| id_tipo_modulo: <value>, // mandatory | id_tipo_modulo: <value>, // required |
| configuration_data: <value>, | configuration_data: <value>, |
| description: <value>, | description: <value>, |
| |
| { | { |
| name: <value>, // mandatory | name: <value>, // required |
| id_module: <value>, // mandatory | id_module: <value>, // required |
| id_tipo_modulo: <value>, // mandatory | id_tipo_modulo: <value>, // required |
| configuration_data: <value>, | configuration_data: <value>, |
| description: <value>, | description: <value>, |