Configuration
The configuration endpoint allows to read certain configuration parameters of the OpenProject instance. Note that there is no 1:1 relationship between this endpoint and the settings you can find in your settings.yml.
For now this endpoint will only allow access to settings deemed useful for a client to know in general.
As clients might rely on the combination of both, the system settings as well as the current user’s preferences, the resource embeds the current user’s preferences so client can fetch both with one request.
Link | Description | Type | Nullable | Supported operations |
---|---|---|---|---|
self | The configuration | Configuration | READ | |
userPreferences | The preferences of the current user | UserPreferences | READ |
Local Properties
Property | Description | Type | Condition | Supported operations |
---|---|---|---|---|
maximumAttachmentFileSize | The maximum allowed size of an attachment in Bytes | Integer | READ | |
perPageOptions | Page size steps to be offered in paginated list UI | Integer[] | READ |
Configuration
View configuration
- Response
200
Toggle details Headers
Content-Type: application/hal+json
Body
{ "_type": "Configuration", "_links": { "self": { "href": "/api/v3/configuration" }, "userPreferences": { "href": "/api/v3/my_preferences" } }, "maximumAttachmentFileSize": 5242880, "perPageOptions": [ 1, 10, 100 ] }
Help and feedback
If you did not find what you were looking for
If you need help from the community or want to support others
If you are eligible for professional support and have more questions
REQUEST SUPPORT
If you find an easily fixable error or need for improvement in the documentation for the stable release
If you would like to suggest bigger updates or improvements to this documentation
If you want to contribute to translate this documentation to another language
If there's something you don't like or understand about this feature
If you want to propose a new feature that OpenProject does not offer yet
To further help OpenProject to shape and test new features
To view OpenProject premium features and pricing
If you want to try all premium features in the OpenProject Cloud Edition 14 days for free
If you want to try all premium features in your on premise Community installation 14 days for free