Settings Admin

Get admin appearance settings

Changed on

Get admin appearance system settings. <br> Includes branding and asset configuration options.

get/pimcore-studio/api/settings/admin

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/settings/admin
  • Auth: none declared

Response

Admin system settings data

additionalAttributesobject

AdditionalAttributes

writeableboolean required

Whether the settings are writeable

Example response

{
  "branding": {
    "backgroundShade": "#CCCCCC",
    "brandColor": "#FFCC00",
    "loginScreenCustomBackgroundImage": {
      "id": 83,
      "type": "object",
      "subtype": "Product",
      "fullPath": "/path/to/element",
      "isPublished": true,
      "hasViewAccess": true
    },
    "customLogo": {
      "id": 83,
      "type": "object",
      "subtype": "Product",
      "fullPath": "/path/to/element",
      "isPublished": true,
      "hasViewAccess": true
    }
  },
  "assets": {
    "disable_tree_preview": true
  },
  "writeable": true
}

Changes

  • 81b097a1505fRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status