# Update algorithm by name Endpoint: PUT /algorithms/{algorithmName} Version: 5.1.42 Security: api_key ## Path parameters: - `algorithmName` (string, required) The name of the algorithm to update ## Request fields (application/json): - `algorithmName` (string, required) Equivalent to the algorithm name saved by the user through the GUI. For out of the box algo, this represents algorithm code. Example: "SimpleMaskingAlgorithm" - `algorithmType` (string, required) The type of algorithm Enum: "BINARY_LOOKUP", "CLEANSING", "COMPONENT", "CUSTOM_ALGORITHM", "DATE", "LOOKUP", "MAPPING", "MINMAX", "MISC", "REDACTION", "SEGMENT", "TOKENIZATION" - `description` (string) The description of the algorithm Example: "This is a simple algorithm that serves as an example for the API. The frameworkId value may vary by engine." - `frameworkId` (integer) The algorithm framework id Example: 3 - `fields` (array) - `algorithmExtension` (object) Example: {"lookupFile":{"uri":"delphix-file://upload/f_a0c6c02dac4a4303a26ea5418fb72d5b/example.txt"}} ## Response 200 fields (application/json): - `asyncTaskId` (integer) The ID of the AsyncTask. This field will be generated by the Masking Engine. Example: 1 - `operation` (string) The type of operation that the AsyncTask is performing. Enum: "ADD_MAPPINGS", "ALGORITHM_CREATE", "ALGORITHM_MIGRATE", "ALGORITHM_UPDATE", "DATAFILE_BULK_UPDATE", "ENCRYPTION_KEY_CREATE", "EXPORT", "EXPORT_CLASSIFIER_FILES", "EXPORT_MAPPINGS", "EXPORT_PROFILE_SET", "EXPORT_SL_VALUES", "IMPORT", "RULESET_REFRESH", "TABLE_BULK_UPDATE", "MAINFRAME_DATASET_BULK_UPDATE", "SUPPORT_BUNDLE_GENERATE" - `reference` (string) The reference for the AsyncTask. An example of a reference is the ruleset ID for a RULESET_REFRESH operation. Example: 13 - `status` (string) The status of the AsyncTask in regard to its completion. Enum: "CANCELLED", "FAILED", "RUNNING", "SUCCEEDED", "WAITING" - `startTime` (string) The date and time that this AsyncTask was started. - `endTime` (string) The date and time that this AsyncTask completed. - `cancellable` (boolean) True if the AsyncTask can be cancelled, false otherwise. - `exceptionDetail` (string) The details associated with the Java exception that caused this async task to fail, if applicable. ## Response 400 fields ## Response 403 fields ## Response 404 fields