Sites¶
Manage remote sites.
Managing sites¶
List all sites¶
-
GET
/site
¶ Retrieves the ids of the sites that have been configured.
Query Parameters: - type (string) –
all
(default) - Return the ids of all added sites.current
- Return the id of the current site.
Produces: - application/xml, application/json – URIListDocument
- type (string) –
Update or create a site¶
-
PUT
/site/
(site-id)¶ Adds a new site using the given site definition.
The only supported value for
syncPolicy
is currentlyONDEMAND
.Accepts: - application/xml, application/json – SiteDefinitionDocument
Produces: - application/xml, application/json – SiteDefinitionDocument
Example¶
PUT /site/VY
Content-Type: application/xml
<SiteDefinitionDocument xmlns="http://xml.vidispine.com/schema/vidispine">
<url>http://10.1.2.3:8080/API/</url>
<username>site-manager</username>
<password>p4ssw0rd</password>
<syncPolicy>ONDEMAND</syncPolicy>
</SiteDefinitionDocument>
Retrieve a site¶
-
GET
/site/
(site-id)¶ Retrieves the definition for a specific site.
Produces: - application/xml, application/json – SiteDefinitionDocument
Role: _site_manager