Configuration

The configuration resource contains the system wide configuration that would typically be tuned by an administrator or set once when installing VidiCore and your application on a new system.

See also

See Configuration properties for more information about the available configuration properties.

Configuration resources

GET /configuration

Returns the available configuration resource endpoints.

Produces:
  • application/xml, application/json – URIListDocument containing the names of the endpoints.
  • text/plain – CRLF-delimited list of names

Indexing settings

Retrieve the indexing configuration

GET /configuration/indexing

Returns the current indexing configuration.

Produces:
Role:

_configuration_read

Update the indexing configuration

PUT /configuration/indexing

Updates the indexing configuration.

Status Codes:
  • 200 OK – The configuration was updated successfully.
Accepts:
Role:

_administrator

Metrics settings

See Monitoring for examples.

Retrieve the metrics configuration

GET /configuration/metrics

Returns the current metrics configuration.

Produces:
Role:

_configuration_read

Update the metrics configuration

PUT /configuration/metrics

Updates the metrics configuration.

Status Codes:
  • 200 OK – The configuration was updated successfully.
Accepts:
Role:

_administrator

Path alias configuration

See Content paths for information on paths and aliases.

Retrieve the path alias configuration

GET /configuration/path-alias

Returns the current path alias configuration.

Produces:
Role:

_configuration_read

Example

GET /configuration/path-alias

<PathAliasConfigurationDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <alias>v(name)=metadata.timespan[start=-INF][end=+INF].field[name=$name].value.value</alias>
</PathAliasConfigurationDocument>

Update the path alias configuration

PUT /configuration/path-alias

Updates the path alias configuration.

Status Codes:
  • 200 OK – The configuration was updated successfully.
Accepts:
Role:

_administrator

Example

PUT /configuration/path-alias
Content-Type: application/xml

<PathAliasConfigurationDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <alias>v(name)=metadata.timespan[start=-INF][end=+INF].field[name=$name].value.value</alias>
  <alias>detail(tag)=shape[tag=$tag].containerComponent.format,shape[tag=$tag].videoComponent.[codec,duration]</alias>
</PathAliasConfigurationDocument>

200 OK

Job pool configuration

Retrieve the job pool configuration

GET /configuration/job-pool

Returns the current job pool configuration.

Produces:
Role:

_configuration_read

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.

Accepts:
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.

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 job pool

DELETE /configuration/job-pool/(priority)

Deletes the job pool with the given priority threshold.

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

Retrieve the FTP pool configuration

GET /configuration/ftp-pool

Returns the current FTP connection pool configuration.

Produces:
Role:

_configuration_read

Example

GET /configuration/ftp-pool

<FtpPoolConfigurationDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <pool/>
</FtpPoolConfigurationDocument>

Update the FTP pool configuration

PUT /configuration/ftp-pool

Updates the FTP connection pool configuration.

Accepts:
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.

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"/>

Log report configuration

Retrieve the log report configuration

GET /configuration/logreport

Returns the current LogReport configuration.

Produces:
Role:

_configuration_read

Update the log report configuration

PUT /configuration/logreport

Updates the LogReport configuration.

Status Codes:
  • 200 OK – The configuration was updated successfully.
Accepts:
Role:

_administrator

CORS configuration

New in version 4.15.

See CORS configuration for examples.

Retrieve the CORS configuration

GET /configuration/cors

Returns the current CORS configuration.

Produces:
Role:

_configuration_read

Update the CORS configuration

PUT /configuration/cors

Updates the CORS configuration.

Status Codes:
  • 200 OK – The configuration was updated successfully.
Accepts:
Role:

_administrator

Database purging configuration

Retrieve the database purging configuration

GET /configuration/purging

Returns the current database purging configuration.

Produces:
Role:

_configuration_read

Update the database purging configuration

PUT /configuration/purging

Updates the database purging configuration. Note that if a category element is missing, e.g. auditTrail, that category is left unchanged. To remove a particular category, use an empty element, <auditTrail/>.

Status Codes:
  • 200 OK – The configuration was updated successfully.
Accepts:
Role:

_administrator

Example

PUT /configuration/purging
Content-Type: application/xml

<DatabasePurgingConfigurationDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <auditTrail>
    <age>1440</age>
    <uri>ftp://user:password@myhost/logs/</uri>
    <compress>true</compress>
  </auditTrail>
</DatabasePurgingConfigurationDocument>

Remove the database purging configuration

DELETE /configuration/purging

Removes all database purging configuration.

Status Codes:
  • 200 OK – The configuration was updated successfully.
Role:

_administrator

Default job priority configuration

New in version 5.2.1.

Retrieve the default job priority configuration

GET /configuration/job-priority

Returns the current default job priority configuration.

Produces:
Role:

_configuration_read

Update the default job priority configuration

PUT /configuration/job-priority

Updates the default job priority configuration.

Status Codes:
  • 200 OK – The configuration was updated successfully.
Accepts:
Role:

_administrator

Example

PUT /configuration/job-priority
Content-Type: application/xml

<JobPriorityConfigurationDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <job type="IMPORT">MEDIUM</job>
  <job type="EXPORT">HIGH</job>
</JobPriorityConfigurationDocument>

Remove the default job priority configuration

DELETE /configuration/job-priority

Removes all database purging configuration.

Status Codes:
  • 200 OK – The configuration was updated successfully.
Role:

_administrator

OAuth2 configuration

New in version 4.17.

See Configure OAuth2 using the API for examples.

Retrieve the OAuth2 configuration

GET /configuration/auth

Returns the current OAuth2 configuration.

Produces:
Role:

_configuration_read

Update the OAuth2 configuration

PUT /configuration/auth

Updates the OAuth2 configuration.

Status Codes:
  • 200 OK – The configuration was updated successfully.
Accepts:
Produces:
Role:

_administrator

Delete the OAuth2 configuration

DELETE /configuration/auth

Deletes and resets the current OAuth2 configuration.

Role:_administrator

Bulky metadata storage configuration

New in version 5.3.

See Bulky metadata storage for examples.

Retrieve the bulky metdata storage configuration

GET /configuration/bulkymetadata

Returns the current bulky metadata configuration, together with some status information.

Produces:
Role:

_configuration_read

Update the bulky metdata storage configuration

PUT /configuration/bulkymetadata

Updates the bulky metadata configuration.

Status Codes:
  • 200 OK – The configuration was updated successfully.
Accepts:
Role:

_administrator

Configuration properties

List all configuration properties

GET /configuration/properties

Returns a document containing all configuration properties set in the system.

Produces:
Role:

_configuration_read

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>

Retrieve a 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:
Role:

_configuration_read

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/update a configuration property

PUT /configuration/properties

Creates or updates a configuration property.

Status Codes:
  • 200 OK – The configuration property was created/modified successfully.
Accepts:
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/update multiple configuration properties

New in version 4.17.

POST /configuration/properties

Creates or updates multiple configuration properties at once, using a ConfigurationPropertyListDocument.

Status Codes:
  • 200 OK – The configuration properties were created/modified successfully.
Accepts:
Role:

_administrator

Example

POST /configuration/properties

<ConfigurationPropertyListDocument xmlns="http://xml.vidispine.com/schema/vidispine">
 <property>
  <key>apiuri</key>
  <value>http://vidispine.example.com:8080/API/</value>
 </property>
 <property>
  <key>noauthuri</key>
  <value>http://noauth.example.com:8080/</value>
 </property>
</ConfigurationPropertyListDocument>

Create/update a 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

Example

PUT /configuration/properties/apiuri

http://127.0.0.1:18080/API/

Delete a configuration property

DELETE /configuration/properties/(key)

Removes a configuration property.

Status Codes:
  • 200 OK – The configuration property was successfully deleted
Role:

_administrator

Example

DELETE /configuration/properties/example_property

200 OK

Usage reporting

For inspecting and changing properties of the Usage Collectors.

Get all usage collectors

GET /configuration/usage-collector

Returns a list of all usage collectors.

Status Codes:
  • 200 OK – The list of usage collectors configuration was successfully returned
Produces:
Role:

_configuration_read

Get a specific usage collector

GET /configuration/usage-collector/(name)

Returns a specific usage collector.

Status Codes:
  • 200 OK – The usage collector configuration was successfully returned
  • 404 Not found – The usage collectors is not found
Produces:
Role:

_configuration_read

Configure the interval of a specific usage collector

PUT /configuration/usage-collector/(name)/interval

Sets the interval (in seconds) of the frequency for collecting usages.

Status Codes:
  • 200 OK – The interval was successfully updated
Accepts:
  • text/plain – Number of seconds
Produces:
Role:

_administrator

Enabling a specific usage collector

PUT /configuration/usage-collector/(name)/enable

Enable a specific usage collector.

Status Codes:
  • 200 OK – The usage collector was successfully enabled
Produces:
Role:

_administrator
PUT /configuration/usage-collector/(name)/disable

Disable a specific usage collector.

Status Codes:
  • 200 OK – The usage collector was successfully disabled
Produces:
Role:

_administrator