The Timeflows API from Delphix — 8 operation(s) for timeflows.
openapi: 3.0.0
info:
title: Delphix DCT Algorithms Timeflows API
version: 3.28.0
description: Delphix DCT API
contact:
name: Delphix Support
url: https://portal.perforce.com/s/
email: support@delphix.com
servers:
- url: /dct/v3
security:
- ApiKeyAuth: []
tags:
- name: Timeflows
paths:
/timeflows:
get:
tags:
- Timeflows
summary: Retrieve the list of timeflows.
operationId: get_timeflows
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/timeflowsSortParam'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: ListTimeflowsResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/Timeflow'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/timeflows/{timeflowId}:
parameters:
- $ref: '#/components/parameters/timeflowIdParam'
get:
summary: Get a Timeflow by ID.
operationId: get_timeflow_by_id
tags:
- Timeflows
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Timeflow'
patch:
summary: Update values of a timeflow.
operationId: update_timeflow
tags:
- Timeflows
requestBody:
content:
application/json:
schema:
x-body-name: update_timeflow_parameters
$ref: '#/components/schemas/UpdateTimeflowParameters'
description: The new data to update a timeflow.
responses:
'202':
description: OK
content:
application/json:
schema:
type: object
title: UpdateTimeflowResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
delete:
summary: Delete a timeflow.
operationId: delete_timeflow
tags:
- Timeflows
requestBody:
content:
application/json:
schema:
x-body-name: delete_timeflow_parameter
$ref: '#/components/schemas/DeleteTimeflowParameters'
responses:
'202':
description: OK
content:
application/json:
schema:
type: object
title: DeleteTimeflowResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/timeflows/{timeflowId}/timeflowSnapshotDayRange:
parameters:
- $ref: '#/components/parameters/timeflowIdParam'
- name: timezone
in: query
required: false
schema:
type: string
description: The timezone in which the snapshot timestamps are to be interpreted. This property gets precedence over timezone_offset. If the timezone in this property is unknown to the application, the timezone_offset is used as fallback to interpret the snapshot timestamps.
- name: timezone_offset
in: query
required: false
schema:
type: integer
minimum: -64800
maximum: 64800
description: The offset in seconds of timezone in which the snapshot timestamps are to be interpreted. This property is used as fallback to interpret the snapshot timestamps if timezone is not valid.
get:
summary: Returns the count of TimeFlow snapshots of the Timeflow aggregated by day.
operationId: get_timeflow_snapshot_day_range
tags:
- Timeflows
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SnapshotsDayRangesResponse'
/timeflows/{timeflowId}/tags:
parameters:
- $ref: '#/components/parameters/timeflowIdParam'
post:
tags:
- Timeflows
summary: Create tags for a Timeflow.
operationId: create_timeflow_tags
requestBody:
content:
application/json:
schema:
x-body-name: timeflow_tags
$ref: '#/components/schemas/TagsRequest'
description: Tags information for Timeflow.
required: true
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
get:
tags:
- Timeflows
summary: Get tags for a Timeflow.
operationId: get_timeflow_tags
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/TagsResponse'
/timeflows/{timeflowId}/tags/delete:
parameters:
- $ref: '#/components/parameters/timeflowIdParam'
post:
tags:
- Timeflows
summary: Delete tags for a Timeflow.
operationId: delete_timeflow_tags
requestBody:
$ref: '#/components/requestBodies/DeleteTags'
responses:
'204':
description: No Content
/timeflows/search:
post:
tags:
- Timeflows
summary: Search timeflows.
operationId: search_timeflows
x-filterable:
fields:
id:
type: string
engine_id:
type: string
namespace:
type: string
name:
type: string
namespace_id:
type: string
namespace_name:
type: string
is_replica:
type: boolean
dataset_id:
type: string
creation_type:
type: string
parent_snapshot_id:
type: string
parent_point_location:
type: string
parent_point_timestamp:
type: string
parent_point_timeflow_id:
type: string
source_data_timestamp:
type: string
oracle_incarnation_id:
type: string
oracle_cdb_timeflow_id:
type: string
oracle_tde_uuid:
type: integer
mssql_database_guid:
type: string
is_active:
type: boolean
creation_timestamp:
type: string
activation_timestamp:
type: string
parent_vdb_id:
type: string
parent_dsource_id:
type: string
source_vdb_id:
type: string
source_dsource_id:
type: string
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/timeflowsSortParam'
requestBody:
$ref: '#/components/requestBodies/SearchBody'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: SearchTimeflowsResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/Timeflow'
response_metadata:
$ref: '#/components/schemas/PaginatedResponseMetadata'
/timeflows/{timeflowId}/repair:
parameters:
- $ref: '#/components/parameters/timeflowIdParam'
post:
tags:
- Timeflows
summary: Repair a Timeflow.
operationId: timeflow_repair
requestBody:
content:
application/json:
schema:
x-body-name: timeflow_repair
$ref: '#/components/schemas/TimeflowRepairRequest'
description: Timeflow repair information.
required: true
responses:
'200':
description: Ok
content:
application/json:
schema:
type: object
title: TimeflowRepairResponse
properties:
job:
$ref: '#/components/schemas/Job'
description: The initiated job.
/timeflows/{timeflowId}/timeflow_snapshot_ranges:
parameters:
- $ref: '#/components/parameters/timeflowIdParam'
post:
tags:
- Timeflows
summary: Return the provisionable range of each snapshot of the given timeflow.
operationId: get_timeflow_snapshot_ranges
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TimeflowSnapshotRangesParameters'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
title: TimeflowSnapshotRangesResponse
properties:
items:
type: array
items:
$ref: '#/components/schemas/TimeflowSnapshotRange'
components:
schemas:
Tag:
type: object
required:
- key
- value
properties:
key:
description: Key of the tag
type: string
minLength: 1
maxLength: 4000
example: key-1
value:
description: Value of the tag
type: string
minLength: 1
maxLength: 4000
example: value-1
VirtualizationTaskEvent:
deprecated: true
properties:
message_details:
type: string
Engine:
properties:
engine_id:
type: string
minLength: 1
maxLength: 4000
engine_name:
type: string
minLength: 1
maxLength: 4000
TimeflowSnapshotRangesParameters:
type: object
properties:
start_date:
type: string
format: date-time
description: The start date to get the timeflow snapshot ranges
example: '2025-12-17T15:05:30+05:30'
end_date:
type: string
format: date-time
description: The end date to get the timeflow snapshot ranges.
example: '2025-12-18T15:05:30+05:30'
PaginatedResponseMetadata:
type: object
properties:
prev_cursor:
description: Pointer to the previous page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.
type: string
next_cursor:
description: Pointer to the next page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.
type: string
total:
description: The total number of results. This value may not be provided.
type: integer
format: int_64
JobTaskEvent:
properties:
message_details:
type: string
DeleteTag:
type: object
properties:
key:
description: Key of the tag
type: string
minLength: 1
maxLength: 4000
example: key-1
value:
description: Value of the tag
type: string
minLength: 1
maxLength: 4000
example: value-1
tags:
description: List of tags to be deleted
type: array
minItems: 1
maxItems: 1000
uniqueItems: true
items:
$ref: '#/components/schemas/Tag'
Timeflow:
description: Virtualization Engine Timeflow of a dSource or VDB.
type: object
properties:
id:
description: The Timeflow ID.
type: string
example: timeflow-123
engine_id:
description: The ID of the engine the timeflow belongs to.
type: string
example: 1
namespace:
description: Alternate namespace for this object, for replicated and restored timeflows.
type: string
nullable: true
example: NAMESPACE-1
namespace_id:
description: The namespace id of this timeflows.
type: string
nullable: true
example: 1-NAMESPACE-1
namespace_name:
description: The namespace name of this timeflows.
type: string
nullable: true
example: test-engine-1
is_replica:
description: Is this a replicated object.
type: boolean
example: true
name:
description: The timeflow's name.
type: string
example: DB_PROVISION@2023-01-25T09:00:30
dataset_id:
type: string
description: The ID of the timeflow's dSource or VDB.
example: dataset-123
creation_type:
description: The source action that created the timeflow.
type: string
enum:
- INITIAL
- INDETERMINATE
- REFRESH
- ROLLBACK
- TEMPORARY
- TRANSFORMATION
- V2P
- PDB_PLUG
- ORACLE_LIVE_SOURCE_RESYNC
- SOURCE_CONTINUITY
- INCREMENTAL_V2P
example: REFRESH
parent_snapshot_id:
type: string
description: The ID of the timeflow's parent snapshot.
example: snapshot-123
parent_point_location:
type: string
description: The location on the parent timeflow from which this timeflow was provisioned. This will not be present for timeflows derived from linked sources.
example: '1178883'
parent_point_timestamp:
type: string
description: The timestamp on the parent timeflow from which this timeflow was provisioned. This will not be present for timeflows derived from linked sources.
format: date-time
example: '2021-05-01T08:51:34.148000+00:00'
parent_point_timeflow_id:
type: string
description: A reference to the parent timeflow from which this timeflow was provisioned. This will not be present for timeflows derived from linked sources.
example: timeflow-123
parent_vdb_id:
type: string
description: The ID of the parent VDB. This is mutually exclusive with parent_dsource_id.
example: dataset-123
parent_dsource_id:
type: string
description: The ID of the parent dSource. This is mutually exclusive with parent_vdb_id.
example: dataset-123
source_vdb_id:
type: string
description: The ID of the source VDB. This is mutually exclusive with source_dsource_id.
example: dataset-123
source_dsource_id:
type: string
description: The ID of the source dSource. This is mutually exclusive with source_vdb_id.
example: dataset-123
source_data_timestamp:
type: string
description: The timestamp on the root ancestor timeflow from which this timeflow originated. This logical time acts as reference to the origin source data.
format: date-time
example: '2021-05-01T08:51:34.148000+00:00'
oracle_incarnation_id:
type: string
description: Oracle-specific incarnation identifier for this timeflow.
example: '123'
oracle_cdb_timeflow_id:
type: string
description: A reference to the mirror CDB timeflow if this is a timeflow for a PDB.
example: cdb-123
oracle_tde_uuid:
type: string
description: The unique identifier for timeflow-specific TDE objects that reside outside of Delphix storage.
example: tde-indentifier
mssql_database_guid:
type: string
description: MSSQL-specific recovery branch identifier for this timeflow.
example: DATABASE-1
is_active:
type: boolean
description: Whether this timeflow is currently active or not.
example: false
creation_timestamp:
type: string
format: date-time
description: The time when the timeflow was created.
example: '2021-05-01T08:51:34Z'
activation_timestamp:
type: string
format: date-time
description: The time when this timeflow became active.
example: '2021-05-01T08:51:34Z'
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
JobTask:
properties:
id:
type: string
parent_job_id:
type: string
start_time:
type: string
format: date-time
end_time:
type: string
format: date-time
title:
type: string
percent_complete:
type: integer
minimum: 0
maximum: 100
events:
type: array
items:
$ref: '#/components/schemas/JobTaskEvent'
status:
type: string
enum:
- PENDING
- STARTED
- TIMEDOUT
- RUNNING
- CANCELED
- FAILED
- SUSPENDED
- WAITING
- COMPLETED
- ABANDONED
TagsRequest:
type: object
required:
- tags
properties:
tags:
description: Array of tags with key value pairs
type: array
items:
$ref: '#/components/schemas/Tag'
minItems: 1
maxItems: 1000
uniqueItems: true
SearchBody:
description: Search body.
type: object
properties:
filter_expression:
type: string
minLength: 5
maxLength: 50000
example: string_field CONTAINS "over" AND numberic_field GT 9000 OR string_field2 EQ "Goku"
SnapshotDayRange:
description: Count of TimeFlow snapshots aggregated by day.
type: object
properties:
count:
description: Number of TimeFlow snapshots on that day.
type: integer
format: int64
example: 1
date:
description: Date for which TimeFlow snapshots have been aggregated.
type: string
format: date
example: '2019-09-20'
start_of_day:
description: Start of day of this range in the time zone used for computation.
type: string
format: date-time
example: '2019-09-20T07:00:00.000Z'
end_of_day:
description: End of day of this range in the time zone used for computation.
type: string
format: date-time
example: '2019-09-21T07:00:00.000Z'
TimeflowSnapshotRange:
description: Represents a snapshot provisionable range.
properties:
start_point_location:
type: string
description: The starting location of this range.
example: '1178883'
start_point_timestamp:
type: string
description: The start timestamp of this range.
format: date-time
example: '2023-04-01T08:51:34.148000+00:00'
end_point_location:
type: string
description: The ending location of this range.
example: '1178884'
end_point_timestamp:
type: string
description: The end timestamp of this range.
format: date-time
example: '2023-04-01T09:51:34.148000+00:00'
provisionable:
type: boolean
description: Whether or not this snapshot is provisionable.
example: true
snapshot_id:
type: string
description: Id of the timeflow snapshot.
example: 1-ORACLE_SNAPSHOT-1
TimeflowRepairRequest:
type: object
required:
- host
- username
- directory
- start_location
- end_location
properties:
host:
type: string
description: Hostname of the remote host.
example: test.host.com
minLength: 1
maxLength: 256
port:
type: integer
format: int32
default: 22
example: 22
description: Port to connect to remote host.
minimum: 1
maximum: 65535
username:
type: string
description: Username to connect to remote host.
example: username
minLength: 1
maxLength: 256
directory:
type: string
description: Location of the missing logs on the host.
example: folder1/folder2
minLength: 1
maxLength: 2048
start_location:
type: string
description: The database specific identifier specifying the start location of the missing log.
example: '123456'
minLength: 1
maxLength: 20
end_location:
type: string
description: The database specific identifier specifying the end location of the missing log.
example: '654321'
minLength: 1
maxLength: 20
use_engine_public_key:
type: boolean
description: Whether to use public key authentication.
example: true
password:
x-dct-toolkit-credential-field: true
description: The password of the user to connect to remote host machine.
type: string
minLength: 1
maxLength: 255
example: password
key_pair_private_key:
x-dct-toolkit-credential-field: true
type: string
minLength: 1
maxLength: 256
example: private key
description: The private key of the key pair credentials.
key_pair_public_key:
type: string
minLength: 1
maxLength: 256
example: public key
description: The public key of the key pair credentials.
vault_id:
type: string
description: The DCT id or name of the vault from which to read the host credentials.
minLength: 1
maxLength: 256
example: my-vault
hashicorp_vault_engine:
x-dct-toolkit-credential-field: true
type: string
description: Vault engine name where the credential is stored.
minLength: 1
maxLength: 256
example: kv
hashicorp_vault_secret_path:
x-dct-toolkit-credential-field: true
type: string
description: Path in the vault engine where the credential is stored.
minLength: 1
maxLength: 256
example: oracle-env
hashicorp_vault_username_key:
x-dct-toolkit-credential-field: true
type: string
description: Key for the username in the key-value store.
minLength: 1
maxLength: 256
example: username
hashicorp_vault_secret_key:
x-dct-toolkit-credential-field: true
type: string
description: Key for the password in the key-value store.
minLength: 1
maxLength: 256
example: secret
azure_vault_name:
x-dct-toolkit-credential-field: true
type: string
description: Azure key vault name (ORACLE, ASE and MSSQL_DOMAIN_USER only).
minLength: 1
maxLength: 256
example: azure_vault
azure_vault_username_key:
x-dct-toolkit-credential-field: true
type: string
description: Azure vault key for the username in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only).
minLength: 1
maxLength: 256
example: username
azure_vault_secret_key:
x-dct-toolkit-credential-field: true
type: string
description: Azure vault key for the password in the key-value store (ORACLE, ASE and MSSQL_DOMAIN_USER only).
minLength: 1
maxLength: 256
example: secret
cyberark_vault_query_string:
x-dct-toolkit-credential-field: true
type: string
description: Query to find a credential in the CyberArk vault.
minLength: 1
maxLength: 256
example: Safe=Test;Folder=Test;Object=Test
use_kerberos_authentication:
type: boolean
description: Whether to use kerberos authentication.
example: true
sshVerificationStrategy:
$ref: '#/components/schemas/SSHVerificationStrategy'
SnapshotsDayRangesResponse:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SnapshotDayRange'
VirtualizationTask:
deprecated: true
properties:
id:
type: string
parent_job_id:
type: string
start_time:
type: string
format: date-time
end_time:
type: string
format: date-time
title:
type: string
percent_complete:
type: integer
minimum: 0
maximum: 100
events:
type: array
items:
$ref: '#/components/schemas/VirtualizationTaskEvent'
status:
type: string
enum:
- PENDING
- STARTED
- TIMEDOUT
- RUNNING
- CANCELED
- FAILED
- SUSPENDED
- WAITING
- COMPLETED
- ABANDONED
UpdateTimeflowParameters:
type: object
description: Parameters to update a Timeflow.
properties:
name:
type: string
description: The name of the timeflow.
minLength: 1
maxLength: 1024
example: 'Latest on parent refresh #02'
TagsResponse:
type: object
properties:
tags:
description: Array of tags with key value pairs
type: array
items:
$ref: '#/components/schemas/Tag'
DeleteTimeflowParameters:
type: object
description: Parameters to delete a timeflow.
properties:
force_delete:
type: boolean
description: Whether to delete all the dependent Bookmarks.
SSHVerificationStrategy:
description: Mechanism to use for ssh host verification.
required:
- name
properties:
name:
description: The name of the verification strategy.
type: string
enum:
- RAW_KEY
- FINGERPRINT
- ACCEPT_ALWAYS
key_type:
description: The type of SSH key.
type: string
enum:
- RSA
- DSA
- ECDSA
- ED25519
raw_key:
description: Base64-encoded ssh key of the host for RAW_KEY verification.
type: string
minLength: 1
fingerprint_type:
description: Hash function for the fingerprint for FINGERPRINT verification.
type: string
enum:
- SHA256
- SHA512
fingerprint:
description: Base-64 encoded fingerprint of the ssh key of the host for FINGERPRINT verification.
type: string
minLength: 1
Job:
description: An asynchronous task.
type: object
properties:
id:
description: The Job entity ID.
type: string
example: job-123
status:
description: The status of the job.
type: string
enum:
- PENDING
- STARTED
- TIMEDOUT
- RUNNING
- CANCELED
- FAILED
- SUSPENDED
- WAITING
- COMPLETED
- ABANDONED
example: RUNNING
is_waiting_for_telemetry:
description: 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.
type: boolean
type:
description: The type of job being done.
type: string
example: DB_REFRESH
localized_type:
description: The i18n translated type of job being done.
type: string
example: DB Refresh
error_details:
description: Details about the failure for FAILED jobs.
type: string
example: Unable to connect to the engine.
warning_message:
description: Warnings for the job.
type: string
example: 'Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.'
target_id:
description: A reference to the job's target.
type: string
example: vdb-123
target_name:
description: A reference to the job's target name.
type: string
example: vdb
start_time:
description: The time the job started executing.
type: string
format: date-time
example: '2022-01-02T05:11:24.148000+00:00'
update_time:
description: The time the job was last updated.
type: string
format: date-time
example: '2022-01-02T06:11:24.148000+00:00'
trace_id:
description: traceId of the request which created this Job
type: string
engine_ids:
description: IDs of the engines this Job is executing on.
type: array
items:
type: string
deprecated: true
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
engines:
type: array
items:
$ref: '#/components/schemas/Engine'
account_id:
description: The ID of the account who initiated this job.
type: integer
example: 1
account_name:
description: 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-<id>.
type: string
example: User 1
compliance_node_id:
description: The ID of the associated compliance node, if applicable.
type: string
nullable: true
compliance_node_name:
description: The name of the associated compliance node, if applicable.
type: string
nullable: true
percent_complete:
description: Completion percentage of the Job.
type: integer
minimum: 0
maximum: 100
example: '50'
virtualization_tasks:
deprecated: true
type: array
items:
$ref: '#/components/schemas/VirtualizationTask'
tasks:
type: array
items:
$ref: '#/components/schemas/JobTask'
execution_id:
description: The ID of the associated masking execution, if any.
type: string
nullable: true
result_type:
description: The type of the job result. This is the type of the object present in the result.
type: string
result:
description: The result of the job execution. This is JSON serialized string of the result object whose type is specified by result_type property.
type: object
discriminator:
propertyName: class_type
parameters:
timeflowIdParam:
in: path
name: timeflowId
schema:
type: string
minLength: 1
required: true
description: The ID of the timeflow.
timeflowsSortParam:
name: sort
in: query
description: The field to sort results by. A property name with a prepended '-' signifies descending order.
example: id
required: false
schema:
type: string
enum:
- id
- -id
- engine_id
- -engine_id
- namespace
- -namespace
- name
- -name
- dataset_id
- -dataset_id
# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/delphix/refs/heads/main/openapi/delphix-timeflows-api-openapi.yml