Restricted Content Using REST API
Learn how to manage restricted content for migration jobs using the DryvIQ REST API.
Table of Contents
Overview
When creating a job through the REST API, you can use the restricted_content setting to determine how DryvIQ handles restricted content. You have the following four options.
Options | Behaviors |
---|---|
convert | Zip restricted content so that it can be transferred successfully. This is the default setting. This is the same as the Zip unsupported file types setting in the user interface. |
fail | Log an error if restricted content is encountered. |
warn | Log a warning if restricted content is encountered. |
skip | Ignore if restricted content is encountered. |
Example
{
"name":"Simple Job with Zip Restricted Content",
"kind": "transfer",
"transfer": {
"audit_level": "trace",
"transfer_type": "copy",
"restricted_content": "convert",
"segment_transform": "true",
"versioning": {
"preserve": "native"
},
"source": {
"connection": { "id": "{{cloud_connection_source}}" }
,
"target":
{"path":"/SourcePath"}
},
"destination": {
"connection": { "id": "{{cloud_connection_destination}}" },
"target": {
"path": "/DestinationPath"
}
}
},
"schedule": {
"mode": "auto"
}
}
Platform Restricted Content
To determine what is restricted content for your given platform or connection, use the following calls.
To list general supported features for a given platform, make the following call. No connection is required. It returns information for platforms based on your license.
GET {{url}}v1/connections/platforms?fields=all&active=1
This call returns a list of platform features for a specific ID. You will need the platform ID for this call.
GET {{url}}v1/connections/platforms/{{platform_id}}?fields=all
This call returns a list of connection features. Ensure you have an established connection before making the call.
GET {{url}}v1/connections/{{cloud_connection}}?include=features