Configuration¶
The configuration resource contains the system wide configuration that would typically be tuned by an administrator or set once when installing Vidispine and your application on a new system.
See also
See Configuration properties for more information about the available configuration properties.
Indexing settings¶
Get the indexing configuration¶
- GET /configuration/indexing¶
Returns the current indexing configuration.
Produces: - application/xml, application/json – IndexingConfigurationDocument
Role: _administrator
Update the indexing configuration¶
- PUT /configuration/indexing¶
Updates the indexing configuration.
Status Codes: - 200 OK – The configuration was updated successfully.
Accepts: - application/xml – IndexingConfigurationDocument
Role: _administrator
Metrics settings¶
See Monitoring for examples.
Get the metrics configuration¶
- GET /configuration/metrics¶
Returns the current metrics configuration.
Produces: - application/xml, application/json – MetricsConfigurationDocument
Role: _administrator
Update the metrics configuration¶
- PUT /configuration/metrics¶
Updates the metrics configuration.
Status Codes: - 200 OK – The configuration was updated successfully.
Accepts: - application/xml – MetricsConfigurationDocument
Role: _administrator
Job pool configuration¶
Get the job pool configuration¶
- GET /configuration/job-pool¶
Returns the current job pool configuration.
New in version 4.2.2.
Produces: - application/xml, application/json – JobPoolListDocument
Role: _administrator
Example¶
GET /configuration/job-pool
<JobPoolListDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<maxConcurrent>3</maxConcurrent>
</JobPoolListDocument>
Update the job pool configuration¶
- PUT /configuration/job-pool¶
Updates the job pool configuration.
New in version 4.2.2.
Accepts: - application/xml, application/json – JobPoolListDocument
Role: _administrator
Example¶
PUT /configuration/job-pool
Content-Type: application/xml
<JobPoolListDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<maxConcurrent>5</maxConcurrent>
<pool>
<priorityThreshold>HIGH</priorityThreshold>
<size>2</size>
</pool>
<pool>
<priorityThreshold>MEDIUM</priorityThreshold>
<size>3</size>
</pool>
</JobPoolListDocument>
Delete all job pools¶
- DELETE /configuration/job-pool¶
Deletes all job pools.
Note that the max concurrent jobs setting will not be affected.
New in version 4.2.2.
Role: _administrator
Example¶
GET /configuration/job-pool
<JobPoolListDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<maxConcurrent>5</maxConcurrent>
<pool>
<priorityThreshold>HIGH</priorityThreshold>
<size>2</size>
</pool>
<pool>
<priorityThreshold>MEDIUM</priorityThreshold>
<size>3</size>
</pool>
</JobPoolListDocument>
DELETE /configuration/job-pool
GET /configuration/job-pool
<JobPoolListDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<maxConcurrent>5</maxConcurrent>
</JobPoolListDocument>
Delete a specific job pool¶
- DELETE /configuration/job-pool/(priority)¶
Deletes the job pool with the given priority threshold.
New in version 4.2.2.
Role: _administrator
Example¶
GET /configuration/job-pool
<JobPoolListDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<maxConcurrent>5</maxConcurrent>
<pool>
<priorityThreshold>HIGH</priorityThreshold>
<size>2</size>
</pool>
<pool>
<priorityThreshold>MEDIUM</priorityThreshold>
<size>3</size>
</pool>
</JobPoolListDocument>
DELETE /configuration/job-pool/MEDIUM
GET /configuration/job-pool
<JobPoolListDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<maxConcurrent>5</maxConcurrent>
<pool>
<priorityThreshold>HIGH</priorityThreshold>
<size>2</size>
</pool>
</JobPoolListDocument>
FTP pool configuration¶
Get the FTP pool configuration¶
- GET /configuration/ftp-pool¶
Returns the current FTP connection pool configuration.
New in version 4.2.4.
Produces: - application/xml, application/json – FtpPoolConfigurationDocument
Role: _administrator
Example¶
GET /configuration/ftp-pool
<FtpPoolConfigurationDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<pool/>
</FtpPoolConfigurationDocument>
Update the job pool configuration¶
- PUT /configuration/ftp-pool¶
Updates the FTP connection pool configuration.
New in version 4.2.4.
Accepts: - application/xml, application/json – FtpPoolConfigurationDocument
Role: _administrator
Example¶
PUT /configuration/ftp-pool
Content-Type: application/xml
<FtpPoolConfigurationDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<pool>
<minSize>0</minSize>
<maxSize>-1</maxSize>
<evictionInterval>30000</evictionInterval>
<minIdleTime>60000</minIdleTime>
</pool>
</FtpPoolConfigurationDocument>
Delete the FTP pool¶
- DELETE /configuration/ftp-pool¶
Deletes the FTP connection pool.
New in version 4.2.4.
Role: _administrator
Example¶
GET /configuration/ftp-pool
<FtpPoolConfigurationDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<pool/>
</FtpPoolConfigurationDocument>
DELETE /configuration/ftp-pool
GET /configuration/ftp-pool
<FtpPoolConfigurationDocument xmlns="http://xml.vidispine.com/schema/vidispine"/>
Configuration properties¶
Get list of configuration properties¶
- GET /configuration/properties¶
Returns a document containing all configuration properties set in the system.
Produces: - application/xml, application/json – ConfigurationPropertyListDocument
Role: _administrator
Example¶
GET /configuration/properties
<ConfigurationPropertyListDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<property lastChange="2014-06-03T15:18:49.608+02:00">
<key>apiuri</key>
<value>http://vs.example.com:8080/API</value>
</property>
</ConfigurationPropertyListDocument>
Get a single configuration property¶
- GET /configuration/properties/(key)¶
Returns a document or string containing all current setting for a configuration property.
Status Codes: - 200 OK – The value is returned
- 404 Not found – The configuration property is not set
Produces: - application/xml, application/json – ConfigurationPropertyDocument
- text/plain – String value
Role: _administrator
Example¶
GET /configuration/properties/apiuri
Accept: application/xml
<ConfigurationPropertyDocument xmlns="http://xml.vidispine.com/schema/vidispine" lastChange="2014-06-03T15:18:49.608+02:00">
<key>apiuri</key>
<value>http://vs.example.com:8080/API</value>
</ConfigurationPropertyDocument>
GET /configuration/properties/apiuri
Accept: text/plain
http://vs.example.com:8080/API
Create/modify configuration property¶
- PUT /configuration/properties¶
Creates or updates a configuration property.
Status Codes: - 200 OK – The configuration property was created/modified successfully.
Accepts: - application/xml – ConfigurationPropertyDocument
Role: _administrator
Example¶
PUT /configuration/properties
<ConfigurationPropertyDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<key>apiuri</key>
<value>http://127.0.0.1:18080/API/</value>
</ConfigurationPropertyDocument>
Create/modify configuration property¶
- PUT /configuration/properties/(key)¶
Creates or updates a configuration property.
Status Codes: - 200 OK – The configuration property was created/modified successfully.
Accepts: - text/plain – String value
Role: _administrator
Remove a configuration property¶
- DELETE /configuration/properties/(property-name)¶
Removes a configuration property.
Status Codes: - 200 OK – The configuration property was successfully deleted
Role: _administrator