Class SettingsService

See

https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings

Hierarchy

  • CommonHttpService
    • SettingsService

Constructors

constructor

Methods

getLookAndFeelSettings getSystemInfo resetLookAndFeelSettings updateLookAndFeel updateLookAndFeelSettings initialize

Constructors

constructor

  • new SettingsService(getClientInstance): SettingsService
  • Internal

    Create a new instance of the service.

    Parameters

    • getClientInstance: (() => CommonHttpClient)
        • (): CommonHttpClient

        • Returns CommonHttpClient

    Returns SettingsService

Methods

getLookAndFeelSettings

  • getLookAndFeelSettings(params?): Promise<LookAndFeelSettings>

  • Returns the look and feel settings for the site or a single space. This includes attributes such as the color scheme, padding, and border radius.

    The look and feel settings for a space can be inherited from the global look and feel settings or provided by a theme.

    Permissions required: None

    Parameters

    • params: {
          spaceKey?: string;
      } = {}
      • OptionalspaceKey?: string

        The key of the space for which the look and feel settings will be returned. If this is not set, only the global look and feel settings are returned.

    Returns Promise<LookAndFeelSettings>

    Returned if the requested look and feel settings are returned.

    Path

    GET /wiki/rest/api/settings/lookandfeel @scopes-current manage:confluence-configuration @scopes-beta read:configuration:confluence, read:space.setting:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings#api-wiki-rest-api-settings-lookandfeel-get

getSystemInfo

resetLookAndFeelSettings

  • resetLookAndFeelSettings(params?): Promise<void>

  • Resets the custom look and feel settings for the site or a single space. This changes the values of the custom settings to be the same as the default settings. It does not change which settings (default or custom) are selected. Note, the default space settings are inherited from the current global settings.

    Permissions required: 'Admin' permission for the space.

    Parameters

    • params: {
          spaceKey?: string;
      } = {}
      • OptionalspaceKey?: string

        The key of the space for which the look and feel settings will be reset. If this is not set, the global look and feel settings will be reset.

    Returns Promise<void>

    Path

    DELETE /wiki/rest/api/settings/lookandfeel/custom @scopes-current manage:confluence-configuration @scopes-beta write:configuration:confluence, write:space.setting:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings#api-wiki-rest-api-settings-lookandfeel-custom-delete

updateLookAndFeel

updateLookAndFeelSettings

  • updateLookAndFeelSettings(params): Promise<LookAndFeelWithLinks>

  • Updates the look and feel settings for the site or for a single space. If custom settings exist, they are updated. If no custom settings exist, then a set of custom settings is created.

    Note, if a theme is selected for a space, the space look and feel settings are provided by the theme and cannot be overridden.

    Permissions required: 'Admin' permission for the space.

    Parameters

    • params: {
          lookAndFeel: LookAndFeel;
          spaceKey?: string;
      }
      • lookAndFeel: LookAndFeel

        The updated settings. All values for the settings must be included, regardless of whether they are being changed.

        One way to create the request body is to copy the settings from the response body of Get look and feel settings and modify it as needed.

      • OptionalspaceKey?: string

        The key of the space for which the look and feel settings will be updated. If this is not set, the global look and feel settings will be updated.

    Returns Promise<LookAndFeelWithLinks>

    Returned if the look and feel settings are updated.

    Path

    POST /wiki/rest/api/settings/lookandfeel/custom @scopes-current manage:confluence-configuration @scopes-beta read:configuration:confluence, read:space.setting:confluence, write:configuration:confluence, write:space.setting:confluence

    See

    https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings#api-wiki-rest-api-settings-lookandfeel-custom-post

Protected Staticinitialize

  • initialize(): void

  • Method to initialize the class. Normally used to set up validation rules.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods