Settings

Update system settings

Changed on

Update system settings. <br> This endpoint allows you to update various system configuration parameters including: <br>

<ul> <li><strong>general</strong>: Language settings (valid languages, fallback languages, required languages, default language), domain configuration, and translation debugging</li> <li><strong>objects</strong>: Object versioning settings (days and steps to keep)</li> <li><strong>assets</strong>: Asset versioning settings (days and steps to keep)</li> <li><strong>documents</strong>: Document versioning settings and localized error pages</li> </ul> <strong>Note:</strong> Only the settings provided in the request body will be updated.
put/pimcore-studio/api/settings

Request

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

Request body

Example request

{
  "general": {
    "valid_languages": [
      "en",
      "de",
      "fr"
    ],
    "fallback_languages": {
      "de": "en",
      "fr": "en"
    },
    "required_languages": [
      "en"
    ],
    "default_language": "en"
  },
  "objects": {
    "versions": {
      "steps": 10
    }
  },
  "assets": {
    "versions": {
      "steps": 10
    }
  },
  "documents": {
    "versions": {
      "steps": 10
    },
    "error_pages": {
      "localized": {
        "en": "",
        "de": ""
      }
    }
  },
  "email": {
    "debug": {
      "email_addresses": [
        "debug@example.com"
      ]
    }
  }
}

Response

Updated system settings

Changes