Difference between revisions of "I2Rest API"
(Created page with "{{DISPLAYTITLE:i2Rest API}} = i2Rest API = i2Rest Server provides a set of web services API to call IBM i programs and commands, as well as API to manage i2Rest Server instan...") |
|||
| Line 2: | Line 2: | ||
= i2Rest API = | = i2Rest API = | ||
| − | i2Rest Server provides a set of web services | + | i2Rest Server provides a set of web services APIs to call IBM i programs and commands, as well as APIs to manage i2Rest Server instance. |
| − | It is required to | + | It is required to obtain OAuth2 token with run_program and/or run_command scopes to call IBM i programs and commands. APIs run_program and run_command are available on [[i2Rest Gates#main_gate|Main Gate endpoint]] |
| + | |||
| + | Management APIs includes functions that can be used to do some management stuff - change runtime parameters, query current status of server instance, etc. Management APIs are available at [[i2Rest Gates#management_gate|Management Gate endpoint]], for clients who have OAuth2 tokens with management_functions scope. | ||
| + | |||
| + | <div>__TOC__</div> | ||
| + | |||
| + | == run_program API == | ||
| + | |||
| + | == run_command API == | ||
| + | |||
| + | == Management APIs == | ||
Revision as of 17:13, 3 April 2020
i2Rest API
i2Rest Server provides a set of web services APIs to call IBM i programs and commands, as well as APIs to manage i2Rest Server instance.
It is required to obtain OAuth2 token with run_program and/or run_command scopes to call IBM i programs and commands. APIs run_program and run_command are available on Main Gate endpoint
Management APIs includes functions that can be used to do some management stuff - change runtime parameters, query current status of server instance, etc. Management APIs are available at Management Gate endpoint, for clients who have OAuth2 tokens with management_functions scope.
