PUT AppSetting Name Set

The PUT /AppSetting/{name}/Set method is used to update the value of an application setting specified by the reference name. This method returns HTTP 200 OK on a success with information about the updated application settings.

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:

/application_settings/read/
/application_settings/modify/

Table 262: PUT AppSetting {name} Set Input Parameters

Name

In

 Description
name Path

Required. A string indicating the Keyfactor Command internal reference name (ShortName) for the application setting.

Use the GET /AppSetting method (see GET AppSetting) to retrieve a list of all the application settings to determine the application setting reference name (ShortName).
Value Body

Required. A field indicating the value for the application setting. May be a Boolean, integer, or string.

For more information about the application settings and supported values, see Application Settings.

Table 263: PUT AppSetting {name} Set Response Data

Name Description
Id

Integer indicating the Keyfactor Command reference ID of the application setting.
DisplayName A string indicating the name for the application setting in the Keyfactor Command Management Portal.
ShortName A string indicating the Keyfactor Command internal reference name for the application setting.
Description

A string indicating the description for the application setting. This description appears in the Keyfactor Command Management Portal when you hover over the DisplayName for the application setting.
Value

A field indicating the value for the application setting. May be a Boolean, integer, or string.

For more information about the application settings and supported values, see Application Settings.
ValueType

An integer indicating the type for the Value. ClosedShow value types.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which 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. endpoints can be called and results returned. It is intended to be used primarily for validation, testing 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. development. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon () at the top of the Management Portal page next to the Log Out button.