Zones and StorageCenters objects represent Storage Zones - hosted or on-premise areas that provide data repository services. ShareFile.com define multiple zones for providing file services - not only storage, but indexing, thumbnails, anti-virus, previews, etc. Account administrators can also create on-premise Zones to provide these services, and to connector to other storage repositories - such as CIFS and SharePoint. A Zone loosely represents a Site. Inside a Zone, Admin deploy multiple Storage Centers - the servers that perform the Zone activities.
GET https://account.sf-api.com/sf/v3/Zones
Retrieve the list of Zones accessible to the authenticated user This method will concatenate the list of private zones in the user's account and the list of public zones accessible to this account. Any user can see the list of zones.
| services | ZoneService | Collection of services for filtering the output - only zones that contain all elements in the list are retrieved |
| includeDisabled | Boolean | Include "disabled" zones - zones without an associated enabled storagecenter. Defaults to off. |
Returns: The list of public and private zones accessible to this user
GET https://account.sf-api.com/sf/v3/Zones(id)
Retrieve a single zone by ID
| id | String | Zone identifier |
| secret | Boolean |
Returns: A single zone objected based on provided ID
POST https://account.sf-api.com/sf/v3/Zones
{
"Name":"Name",
"HeartbeatTolerance":10,
"ZoneServices":"StorageZone, SharepointConnector, NetworkShareConnector"
}
Creates a new Zone.
Returns: the created zone
PATCH https://account.sf-api.com/sf/v3/Zones(id)
{
"Name":"Name",
"HeartbeatTolerance":10,
"ZoneServices":"StorageZone, SharepointConnector, NetworkShareConnector"
}
Updates an existing zone
| id | String | The zone identifier |
| zone | Zone | New parameters for the zone |
Returns: The modified zone
DELETE https://account.sf-api.com/sf/v3/Zones(id)?force=false&newDefaultZoneId=newzoneid
Removes an existing zone
| id | String | The zone identifier |
| force | Boolean | Specify whether the zone will be deleted if there are elements in this zone - including storage centers and expired items. Default is false |
| newDefaultZoneId | String | Specify new default zone id |
POST https://account.sf-api.com/sf/v3/Zones(id)/ResetSecret
Resets the current Zone Secret to a new Random value Caution! This Call will invalidate all Storage Center communications until the Storage Center Zone secret is also updated. User must be a Zone admin to perform this action
| id | String | Zone Identifier |
Returns: The modified Zone object
GET https://account.sf-api.com/sf/v3/Zones(parentid)/Tenants
| parentid | String | ID of the multi-tenant zone |
Returns: List of tenant accounts, not including the zone admin account.
POST https://account.sf-api.com/sf/v3/Zones(parentid)/Tenants?accountId=tenantaccount
| parentid | String | ID of the multi-tenant zone |
| accountId | String | ID of the tenant account to add |
DELETE https://account.sf-api.com/sf/v3/Zones(parentid)/Tenants(id)?newDefaultZoneId=newzoneid
| parentid | String | ID of the multi-tenant zone |
| id | String | Tenant account ID to remove from the zone |
| newDefaultZoneId | String | ID of new default zone to assign to the tenant |
| expireItems | Boolean | Should the tenant's items in the zone be expired? Do this only if the items have already been migrated, or are no longer needed |
GET https://account.sf-api.com/sf/v3/Zones(id)/Metadata
Gets metadata associated with the specified zone
| id | String | The Zone identifier |
Returns: the zone metadata feed
POST https://account.sf-api.com/sf/v3/Zones(id)/Metadata
[
{"Name":"metadataName1", "Value":"metadataValue1", "IsPublic":"true"},
{"Name":"metadataName2", "Value":"metadataValue2", "IsPublic":"false"}
]
Creates or updates Metadata entries associated with the specified zone
| id | String | The Zone Identifier |
| metadata | Metadata[] | A list of metadata entries. Only zone admins can retrieve, set or modify entries that have IsPublic set to false. |
Returns: the zone metadata feed