Content Configuration get

Content Configuration get

Retrieves the current configuration values.

Returns an authorization error if you do not have all of the privileges described as follows:

  • Operation execution requires ContentLibrary.GetConfiguration.
Request
URI
GET
https://{api_host}/api/content/configuration
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

The Content ConfigurationModel instance representing the configuration of the Content Library Service.

Returns Content ConfigurationModel of type(s) application/json 
{
    "automatic_sync_enabled": false,
    "automatic_sync_start_hour": 0,
    "automatic_sync_stop_hour": 0,
    "maximum_concurrent_item_syncs": 0
}
boolean
automatic_sync_enabled
Optional

Whether automatic synchronization is enabled.

When automatic synchronization is enabled, the Content Library Service will automatically synchronize all subscribed libraries on a daily basis. Subscribed libraries with the Content ConfigurationModel.automatic_sync_enabled flag turned on will be synchronized every hour between Content ConfigurationModel.automatic_sync_start_hour and Content ConfigurationModel.automatic_sync_stop_hour.

The default value is true.

This property is not used for the create operation. It will always be present in the response of the get or list operations. It is optional for the update operation.

integer As int64 As int64
automatic_sync_start_hour
Optional

The hour at which the automatic synchronization will start. This value is between 0 (midnight) and 23 inclusive.

The default value is 20.

This property is not used for the create operation. It will always be present in the response of the get or list operations. It is optional for the update operation.

integer As int64 As int64
automatic_sync_stop_hour
Optional

The hour at which the automatic synchronization will stop. Any active synchronization operation will continue to run, however no new synchronization operations will be triggered after the stop hour. This value is between 0 (midnight) and 23 inclusive.

The default value is 7.

This property is not used for the create operation. It will always be present in the response of the get or list operations. It is optional for the update operation.

integer As int64 As int64
maximum_concurrent_item_syncs
Optional

The maximum allowed number of library items to synchronize concurrently from remote libraries. This must be a positive number. The service may not be able to guarantee the requested concurrency if there is no available capacity.

This setting is global across all subscribed libraries. The default value is 5.

This property is not used for the create operation. It will always be present in the response of the get or list operations. It is optional for the update operation.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/content/configuration
On This Page
Content Operations
GET
Content Configuration get
PATCH
Content Configuration update