Interface ConfluenceRestClientSettingsApi

@Generated("io.github.primelib.primecodegen") public interface ConfluenceRestClientSettingsApi
ConfluenceRestClientSettingsApi

  • Method Details

    • GetSettingsLookandfeelV1

      LookAndFeelSettings GetSettingsLookandfeelV1(@Nullable @Nullable String spaceKey)
      GetSettingsLookandfeelV1 Get look and feel settings 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](https://confluence.atlassian.com/x/_AozKw) required**: None
      Parameters:
      spaceKey - 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.

    • PutSettingsLookandfeelV1

      LookAndFeelSelection PutSettingsLookandfeelV1(@NotNull @NotNull LookAndFeelSelection payload)
      PutSettingsLookandfeelV1 Select look and feel settings Sets the look and feel settings to the default (global) settings, the custom settings, or the current theme's settings for a space. The custom and theme settings can only be selected if there is already a theme set for a space. Note, the default space settings are inherited from the current global settings. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
      Parameters:
      payload - The look and feel type to be set.

    • PostSettingsLookandfeelCustomV1

      Object PostSettingsLookandfeelCustomV1(@Nullable @Nullable String spaceKey, @NotNull @NotNull LookAndFeel payload)
      PostSettingsLookandfeelCustomV1 Update look and feel settings 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](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
      Parameters:
      spaceKey - 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.
      payload - 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](#api-settings-lookandfeel-get) and modify it as needed.

    • DeleteSettingsLookandfeelCustomV1

      void DeleteSettingsLookandfeelCustomV1(@Nullable @Nullable String spaceKey)
      DeleteSettingsLookandfeelCustomV1 Reset look and feel settings 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](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
      Parameters:
      spaceKey - 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.

    • GetSettingsSystemInfoV1

      SystemInfoEntity GetSettingsSystemInfoV1()
      GetSettingsSystemInfoV1 Get system info Returns the system information for the Confluence Cloud tenant. This information is used by Atlassian. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).