Extensions Scripts

The Extensions Scripts component of the Keyfactor APIClosed An API is a set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command. includes methods necessary to create, update, retrieve and delete scripts configured for certificate requests, SSHClosed The SSH (secure shell) protocol provides for secure connections between computers. It provides several options for authentication, including public key, and protects the communications with strong encryption. alerts, and workflows. The Extensions Scripts endpoints were introduced in Keyfactor Command version 11 and replaced previous functionality that stored scripts for alert event handlers and workflowClosed A workflow is a series of steps necessary to complete a process. In Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store. 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. See also PowerShell Scripts for important information about working with scripts in Keyfactor Command.

Note:  Customers upgrading from versions of Keyfactor Command prior to version 11.0, please refer to Preparing - Release 11.0 or Later.
Important:  PowerShell scripts are not supported for the Use Custom PowerShell workflow step and the PowerShell event handler for the legacy alerting system when using Keyfactor Command installed in containers under Kubernetes.

Table 498: 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