# Create a VirtualizationPolicy.

Endpoint: POST /virtualization-policies
Version: 3.21.0
Security: ApiKeyAuth

## Security:

  - `ApiKeyAuth` (unknown)
    apiKey in header Authorization

## Request body:

  - `application/json` (unknown)
    The parameters to create a DCT-managed VirtualizationPolicy.

## Request fields (application/json):

  - `name` (string, required)
    The name of the virtualization policy.
    Example: my-policy

  - `policy_type` (string, required)
    The type of a virtualization policy.
    Enum: "REFRESH_POLICY", "SNAPSHOT_POLICY", "SYNC_POLICY", "RETENTION_POLICY", "REPLICA_RETENTION_POLICY", "QUOTA_POLICY"

  - `policy_targets` (array)
    The target objects that will have this policy applied to them upon creation of the policy.

  - `policy_targets.object_type` (string)
    A DCT specific target policy object type.
    Enum: "CDB", "DSOURCE", "VCDB", "VDB", "DATASET_GROUP", "REPLICATION_PROFILE", "NAMESPACE"

  - `policy_targets.object_id` (string)
    The ID of the object, the policy to be applied to.

  - `provision_source` (string)
    The source of the data to provision from [Refresh Policy].
    Enum: "LATEST_SNAPSHOT", "LATEST_TIME_FLOW_LOG"

  - `timezone_id` (string)
    The timezone to use for scheduling.
    Example: America/Los_Angeles

  - `data_duration` (integer)
    Amount of time to keep source data [Retention Policy].
    Example: 1

  - `data_unit` (string)
    Time unit for data_duration [Retention Policy].
    Enum: "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"

  - `log_duration` (integer)
    Amount of time to keep log data [Retention Policy].
    Example: 1

  - `log_unit` (string)
    Time unit for log_duration [Retention Policy].
    Enum: "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"

  - `num_of_daily` (integer)
    Number of daily snapshots to keep [Retention Policy].
    Example: 1

  - `num_of_weekly` (integer)
    Number of weekly snapshots to keep [Retention Policy].
    Example: 1

  - `day_of_week` (string)
    Day of week upon which to enforce weekly snapshot retention [Retention Policy].
    Enum: "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"

  - `num_of_monthly` (integer)
    Number of monthly snapshots to keep [Retention Policy].
    Example: 1

  - `day_of_month` (integer)
    Day of month upon which to enforce monthly snapshot retention [Retention Policy].
    Example: 1

  - `num_of_yearly` (integer)
    Number of yearly snapshots to keep [Retention Policy].
    Example: 1

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

  - `schedules` (array)
    The schedules for this policy.

  - `schedules.cron_string` (string, required)

  - `schedules.cutoff_time` (integer)

  - `size` (integer)
    Size of the quota, in bytes. [Quota Policy].
    Example: 1

  - `tags` (array)
    The tags to be created for the policy.

  - `tags.key` (string, required)
    Key of the tag
    Example: key-1

  - `tags.value` (string, required)
    Value of the tag
    Example: value-1

## Request examples:

  - `VirtualizationPolicy create` (unknown)
    The request example is intended for creating a VirtualizationPolicy.

## Response 201:

  - `201` (unknown)
    VirtualizationPolicy created

## Response 201 fields (application/json):

  - `job` (object)
    An asynchronous task.

  - `job.id` (string)
    The Job entity ID.
    Example: job-123

  - `job.status` (string)
    The status of the job.
    Enum: "PENDING", "STARTED", "TIMEDOUT", "RUNNING", "CANCELED", "FAILED", "SUSPENDED", "WAITING", "COMPLETED", "ABANDONED"

  - `job.is_waiting_for_telemetry` (boolean)
    Indicates that the operations performed by this Job have completed successfully, but the object changes are not yet reflected. This is only set when when the JOB is in STARTED status, with the guarantee that the job will not transition to the FAILED status. Note that this flag will likely be replaced with a new status in future API versions and be deprecated.

  - `job.type` (string)
    The type of job being done.
    Example: DB_REFRESH

  - `job.localized_type` (string)
    The i18n translated type of job being done.
    Example: DB Refresh

  - `job.error_details` (string)
    Details about the failure for FAILED jobs.
    Example: Unable to connect to the engine.

  - `job.warning_message` (string)
    Warnings for the job.
    Example: Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.

  - `job.target_id` (string)
    A reference to the job's target.
    Example: vdb-123

  - `job.target_name` (string)
    A reference to the job's target name.
    Example: vdb

  - `job.start_time` (string)
    The time the job started executing.
    Example: 2022-01-02T05:11:24.148Z

  - `job.update_time` (string)
    The time the job was last updated.
    Example: 2022-01-02T06:11:24.148Z

  - `job.trace_id` (string)
    traceId of the request which created this Job

  - `job.engine_ids` (array)
    IDs of the engines this Job is executing on.

  - `job.tags` (array)

  - `job.tags.key` (string, required)
    Key of the tag
    Example: key-1

  - `job.tags.value` (string, required)
    Value of the tag
    Example: value-1

  - `job.engines` (array)

  - `job.engines.engine_id` (string)

  - `job.engines.engine_name` (string)

  - `job.account_id` (integer)
    The ID of the account who initiated this job.
    Example: 1

  - `job.account_name` (string)
    The account name which initiated this job. It can be either firstname and lastname combination or firstname or lastname or username or email address or Account-.
    Example: User 1

  - `job.percent_complete` (integer)
    Completion percentage of the Job.
    Example: 50

  - `job.virtualization_tasks` (array)

  - `job.virtualization_tasks.id` (string)

  - `job.virtualization_tasks.parent_job_id` (string)

  - `job.virtualization_tasks.start_time` (string)

  - `job.virtualization_tasks.end_time` (string)

  - `job.virtualization_tasks.title` (string)

  - `job.virtualization_tasks.percent_complete` (integer)

  - `job.virtualization_tasks.events` (array)

  - `job.virtualization_tasks.events.message_details` (string)

  - `job.virtualization_tasks.status` (string)
    Enum: "PENDING", "STARTED", "TIMEDOUT", "RUNNING", "CANCELED", "FAILED", "SUSPENDED", "WAITING", "COMPLETED", "ABANDONED"

  - `job.tasks` (array)

  - `job.tasks.id` (string)

  - `job.tasks.parent_job_id` (string)

  - `job.tasks.start_time` (string)

  - `job.tasks.end_time` (string)

  - `job.tasks.title` (string)

  - `job.tasks.percent_complete` (integer)

  - `job.tasks.events` (array)

  - `job.tasks.events.message_details` (string)

  - `job.tasks.status` (string)
    Enum: "PENDING", "STARTED", "TIMEDOUT", "RUNNING", "CANCELED", "FAILED", "SUSPENDED", "WAITING", "COMPLETED", "ABANDONED"

  - `job.execution_id` (string)
    The ID of the associated masking execution, if any.

  - `job.result_type` (string)
    The type of the job result. This is the type of the object present in the result.

  - `job.result` (object)
    The result of the job execution. This is JSON serialized string of the result object whose type is specified by result_type property.

  - `virtualization_policy` (object)

  - `virtualization_policy.id` (string)

  - `virtualization_policy.name` (string)

  - `virtualization_policy.dct_managed` (boolean)
    Whether this virtualization policy is managed by DCT or by an individual Delphix Engine.

  - `virtualization_policy.create_user` (string)
    The user who created this virtualization policy.

  - `virtualization_policy.create_timestamp` (string)
    The time this virtualization policy was created.

  - `virtualization_policy.namespace` (string)

  - `virtualization_policy.namespace_id` (string)
    The namespace id of this virtualization policy.

  - `virtualization_policy.namespace_name` (string)
    The namespace name of this virtualization policy.

  - `virtualization_policy.is_replica` (boolean)
    Is this a replicated object.

  - `virtualization_policy.engine_id` (string)

  - `virtualization_policy.engine_name` (string)
    The name of the engine the policy belongs to.

  - `virtualization_policy.policy_type` (string)
    The type of a virtualization policy.
    Enum: "REFRESH_POLICY", "SNAPSHOT_POLICY", "SYNC_POLICY", "RETENTION_POLICY", "REPLICA_RETENTION_POLICY", "QUOTA_POLICY"

  - `virtualization_policy.timezone_id` (string)

  - `virtualization_policy.default_policy` (boolean)
    True if this is the default policy created when the system is setup.

  - `virtualization_policy.effective_type` (string)
    Whether this policy has been directly applied or inherited. See the effectivePolicies parameter of the list call for details.
    Enum: "DIRECT_APPLIED", "INHERITED"

  - `virtualization_policy.data_duration` (integer)
    Amount of time to keep source data [Retention Policy].

  - `virtualization_policy.data_unit` (string)
    Time unit for data_duration [Retention Policy].
    Enum: "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"

  - `virtualization_policy.log_duration` (integer)
    Amount of time to keep log data [Retention Policy].

  - `virtualization_policy.log_unit` (string)
    Time unit for log_duration [Retention Policy].
    Enum: "DAY", "WEEK", "MONTH", "QUARTER", "YEAR"

  - `virtualization_policy.num_of_daily` (integer)
    Number of daily snapshots to keep [Retention Policy].

  - `virtualization_policy.num_of_weekly` (integer)
    Number of weekly snapshots to keep [Retention Policy].

  - `virtualization_policy.day_of_week` (string)
    Day of week upon which to enforce weekly snapshot retention [Retention Policy].
    Enum: "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"

  - `virtualization_policy.num_of_monthly` (integer)
    Number of monthly snapshots to keep [Retention Policy].

  - `virtualization_policy.day_of_month` (integer)
    Day of month upon which to enforce monthly snapshot retention [Retention Policy].

  - `virtualization_policy.num_of_yearly` (integer)
    Number of yearly snapshots to keep [Retention Policy].

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

  - `virtualization_policy.schedules` (array)

  - `virtualization_policy.schedules.cron_string` (string, required)

  - `virtualization_policy.schedules.cutoff_time` (integer)

  - `virtualization_policy.provision_source` (string)
    The source of the data to provision from [Refresh Policy].
    Enum: "LATEST_SNAPSHOT", "LATEST_TIME_FLOW_LOG"

  - `virtualization_policy.size` (integer)
    Size of the quota, in bytes. (QUOTA_POLICY only).

  - `virtualization_policy.tags` (array)
    The tags that are applied to this VirtualizationPolicy.

  - `virtualization_policy.num_targets` (integer)
    The number of target dSources or VDBs to which this policy has been applied.

  - `virtualization_policy.customized` (boolean)
    True if this policy is customized specifically for one object. Customized policies cannot be shared between objects.

