Create a REST API Macro from History or from an Existing REST API Macro

In this procedure, you are going to create a user-defined REST API macro from a command you have already executed, another user-defined macro, or from a system-defined macro.

Procedure

Step 1

Select an FDM-managed device you want to manage using the REST API, and in Device Actions on the right, click API Tool.

Note

If you want to create a user-defined macro from REST API history, select the device on which you ran the command. REST API macros are shared across devices on the same account but not REST API history.

Step 2

Find the command you want to make an API macro from and select it. Use one of these methods:

  • Click the clock to view the commands you have run on that device. Double-click to select the one you want to turn into a macro and the command appears in the command pane.

  • Click the API macro favorites star to see what macros already exist. Select the user-defined or system-defined API macro you want to change. The command appears in the command pane.

Step 3

With the command in the command pane, click the API macro gold star . The command is now the basis for a new API macro.

Step 4

Give the macro a unique name. Provide a description and notes for the API macro if you wish.

Step 5

Review the command in the Command field and make the changes you want.

Step 6

Replace the parts of the command that you would want to modify, when you run the command, with a parameter name surrounded by curly braces.

Step 7

Click Create. The macro you create is available for use on all the devices of that type, not just the one you initially specified.

To run the command see, Run a REST API Macro.