Sign in
settings

Patch Settings Policy

Update the settings policy's default profile or a specified field.

Parameters: body (SettingsPolicyPatchRequest): The requested profile or field update, including the expected revision.

Returns: SettingsPolicyResponse: The updated settings policy.

Raises: HTTPException: If the revision conflicts, the update is invalid, or the policy is unavailable.

patch/api/settings

Request body

revisionstring required
scopestring nullable
pathstring nullable
{"stackTrail":"components:schemas:JsonValue","oasType":"schema","type":"unknown"}
profilestring nullable

Response

Successful Response

revisionstring required
active_profilestring nullable
default_profilestring nullable
available_profilesstring[]
restart_requiredboolean

Changes

Changed in 3 of the 85 revisions of this API.113

  • 5c36e837be951See the full diff
    • ●

      added the new string_list enum value to the scopes/items/fields/items/editor response property for the response status 200

      response-property-enum-value-added

  • 584337d1a24c12See the full diff
    • ○

      added the new optional request property profile

      new-optional-request-property

    • ○

      the request property path became optional

      request-property-became-optional

    • ○

      the request property scope became optional

      request-property-became-optional

    • ○

      the request property value became optional

      request-property-became-optional

    • ○

      request property path list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property scope list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      the path request property's minLength was decreased from 1 to 0

      request-property-min-length-decreased

    • ○

      the scope request property's minLength was decreased from 1 to 0

      request-property-min-length-decreased

    • ○

      removed the pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$ from the request property scope

      request-property-pattern-removed

    • ○

      removed the pattern ^[a-z][a-z0-9_.]*$ from the request property path

      request-property-pattern-removed

    • ○

      added the optional property available_profiles to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property default_profile to the response with the 200 status

      response-optional-property-added

  • 7a85443866b71See the full diff
    • ○

      endpoint added

      endpoint-added