Skip to content

Fetch a virtualization policy by Id.

Request

Security
ApiKeyAuth
Path
policyIdstring, non-emptyrequired

The ID of the Virtualization Policy.

curl -i -X GET \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/2025.2.0.0/continuous-data-apis-dct-2025.2.0.0/virtualization-policies/{policyId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Returns a single virtualization policy

Bodyapplication/json
idstring
namestring
dct_managedboolean

Whether this virtualization policy is managed by DCT or by an individual Delphix Engine.

create_userstring

The user who created this virtualization policy.

create_timestampstring, (date-time)

The time this virtualization policy was created.

namespacestring
namespace_idstring

The namespace id of this virtualization policy.

namespace_namestring

The namespace name of this virtualization policy.

is_replicaboolean

Is this a replicated object.

engine_idstring
engine_namestring

The name of the engine the policy belongs to.

policy_typestring(PolicyType)

The type of a virtualization policy.

Enum:"REFRESH_POLICY""SNAPSHOT_POLICY""SYNC_POLICY""RETENTION_POLICY""REPLICA_RETENTION_POLICY""QUOTA_POLICY"
timezone_idstring
default_policyboolean

True if this is the default policy created when the system is setup.

Default:false
effective_typestring

Whether this policy has been directly applied or inherited. See the effectivePolicies parameter of the list call for details.

Enum:"DIRECT_APPLIED""INHERITED"
data_durationinteger

Amount of time to keep source data [Retention Policy].

data_unitstring

Time unit for data_duration [Retention Policy].

Enum:"DAY""WEEK""MONTH""QUARTER""YEAR"
log_durationinteger

Amount of time to keep log data [Retention Policy].

log_unitstring

Time unit for log_duration [Retention Policy].

Enum:"DAY""WEEK""MONTH""QUARTER""YEAR"
num_of_dailyinteger

Number of daily snapshots to keep [Retention Policy].

num_of_weeklyinteger

Number of weekly snapshots to keep [Retention Policy].

day_of_weekstring

Day of week upon which to enforce weekly snapshot retention [Retention Policy].

Enum:"MONDAY""TUESDAY""WEDNESDAY""THURSDAY""FRIDAY""SATURDAY""SUNDAY"
num_of_monthlyinteger

Number of monthly snapshots to keep [Retention Policy].

day_of_monthinteger

Day of month upon which to enforce monthly snapshot retention [Retention Policy].

num_of_yearlyinteger

Number of yearly snapshots to keep [Retention Policy].

day_of_yearstring

Day of year upon which to enforce yearly snapshot retention, expressed a month / day string (e.g., "Jan 1") [Retention Policy].

schedulesArray of objects(VirtualizationSchedule)
provision_sourcestring(ProvisionSource)

The source of the data to provision from [Refresh Policy].

Enum:"LATEST_SNAPSHOT""LATEST_TIME_FLOW_LOG"
sizeinteger or null, (int64)

Size of the quota, in bytes. (QUOTA_POLICY only).

tagsArray of objects(Tag)

The tags that are applied to this VirtualizationPolicy.

num_targetsinteger

The number of target dSources or VDBs to which this policy has been applied.

customizedboolean

True if this policy is customized specifically for one object. Customized policies cannot be shared between objects.

Default:false
Response
{ "id": "string", "name": "string", "dct_managed": true, "create_user": "string", "create_timestamp": "2019-08-24T14:15:22Z", "namespace": "string", "namespace_id": "string", "namespace_name": "string", "is_replica": true, "engine_id": "string", "engine_name": "string", "policy_type": "REFRESH_POLICY", "timezone_id": "string", "default_policy": false, "effective_type": "DIRECT_APPLIED", "data_duration": 0, "data_unit": "DAY", "log_duration": 0, "log_unit": "DAY", "num_of_daily": 0, "num_of_weekly": 0, "day_of_week": "MONDAY", "num_of_monthly": 0, "day_of_month": 0, "num_of_yearly": 0, "day_of_year": "string", "schedules": [ { … } ], "provision_source": "LATEST_SNAPSHOT", "size": 0, "tags": [ { … } ], "num_targets": 0, "customized": false }