Extensions Scripts
The Extensions Scripts component of the Keyfactor API
includes methods necessary to create, update, retrieve and delete scripts configured for certificate requests, SSH alerts, and workflows. The Extensions Scripts endpoints are new as of Keyfactor Command version 11 and replace previous functionality which stored scripts for alert event handlers and workflow PowerShell steps in files in the directory structure on the server. The new method of storing the scripts in the database ensures they are stored safely and accessed only with appropriate permissions. Also see PowerShell Scripts for important information about working with scripts in Keyfactor Command.
Important: When upgrading from a version of Keyfactor Command prior to version 11, the upgrade process will search the file location defined in the Application settings > Console Tab > Extension Handler Path setting and add all the files found in that directory to the database with the naming convention of foldername (_subfolder name, if applicable)_filename so it is clear which scripts were imported from which location (e.g., net6.0_Workflow_CustomPowershellExample). The upgrade process will also identify which, if any, of the categories the script is configured for and add that information to the database with the script.
Table 424: Extensions Scripts Endpoints
| Endpoint | Method | Description | Link |
|---|---|---|---|
| /{id} | DELETE | Deletes a script. | DELETE Extensions Scripts ID |
| /{id} | GET | Returns a single script that matches the provided ID. | GET Extensions Scripts ID |
| / | GET | Returns all scripts according to the provided filter and output parameters. | GET Extensions Scripts |
| / | POST | Adds a new script. | POST Extensions Scripts |
| / | PUT | Updates a script. | PUT Extensions Scripts |