Snapshots

Retrieve the list of snapshots.

SecurityApiKeyAuth
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

sort
string or null

The field to sort results by. A property name with a prepended '-' signifies descending order.

Enum: "id" "-id" "engine_id" "-engine_id" "namespace" "-namespace" "name" "-name" "consistency" "-consistency" "missing_non_logged_data" "-missing_non_logged_data" "dataset_id" "-dataset_id" "creation_time" "-creation_time" "start_timestamp" "-start_timestamp" "start_location" "-start_location" "timestamp" "-timestamp" "location" "-location" "expiration" "-expiration" "retain_forever" "-retain_forever" "effective_expiration" "-effective_expiration" "effective_retain_forever" "-effective_retain_forever" "timeflow_id" "-timeflow_id" "timezone" "-timezone" "version" "-version" "temporary" "-temporary" "appdata_toolkit" "-appdata_toolkit" "appdata_metadata" "-appdata_metadata" "ase_db_encryption_key" "-ase_db_encryption_key" "mssql_internal_version" "-mssql_internal_version" "mssql_backup_set_uuid" "-mssql_backup_set_uuid" "mssql_backup_software_type" "-mssql_backup_software_type" "mssql_backup_location_type" "-mssql_backup_location_type" "mssql_empty_snapshot" "-mssql_empty_snapshot" "oracle_from_physical_standby_vdb" "-oracle_from_physical_standby_vdb" "oracle_redo_log_size_in_bytes" "-oracle_redo_log_size_in_bytes"
Example: sort=id
Responses
200

OK

get/snapshots
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Get a Snapshot by ID.

SecurityApiKeyAuth
Request
path Parameters
snapshotId
required
string non-empty

The ID of the snapshot.

Responses
200

OK

get/snapshots/{snapshotId}
Response samples
application/json
{
  • "id": "snapshot-123",
  • "engine_id": "1",
  • "namespace": "NAMESPACE-1",
  • "name": "@2023-02-02T14:30:00.589",
  • "namespace_id": "1-NAMESPACE-1",
  • "namespace_name": "test-engine-1",
  • "is_replica": true,
  • "consistency": "CONSISTENT",
  • "missing_non_logged_data": false,
  • "dataset_id": "dataset-123",
  • "creation_time": "2023-02-02T19:30:00.589Z",
  • "start_timestamp": "2021-05-01T08:51:34.148Z",
  • "start_location": "1178883",
  • "timestamp": "2021-05-01T08:51:34.148Z",
  • "location": "1178883",
  • "retention": -1,
  • "expiration": "2021-07-04T00:00:00.000Z",
  • "retain_forever": false,
  • "effective_expiration": "2021-07-04T00:00:00.000Z",
  • "effective_retain_forever": false,
  • "timeflow_id": "1-ORACLE_TIMEFLOW-1",
  • "timezone": "America/New_York,EST-0500",
  • "version": "11.2.0.4.0",
  • "temporary": false,
  • "appdata_toolkit": "APPDATA_TOOLKIT-1",
  • "appdata_metadata": "{}",
  • "ase_db_encryption_key": "keyname",
  • "mssql_internal_version": 706,
  • "mssql_backup_set_uuid": "54290b71-58cd-463d-bd62-7219d4c4d2d5",
  • "mssql_backup_software_type": "NATIVE",
  • "mssql_backup_location_type": "BACKUP_SERVER",
  • "mssql_empty_snapshot": true,
  • "oracle_from_physical_standby_vdb": false,
  • "oracle_redo_log_size_in_bytes": 314572800,
  • "tags": [
    ]
}

Delete a Snapshot.

SecurityApiKeyAuth
Request
path Parameters
snapshotId
required
string non-empty

The ID of the snapshot.

Responses
200

Snapshot delete initiated.

delete/snapshots/{snapshotId}
Response samples
application/json
{
  • "job": {
    }
}

Update values of a Snapshot.

SecurityApiKeyAuth
Request
path Parameters
snapshotId
required
string non-empty

The ID of the snapshot.

Request Body schema: application/json

The new data to update a Snapshot.

expiration
string <date>

The expiration for this snapshot. Mutually exclusive with retain_forever.

retain_forever
boolean

Indicates that the snapshot should be retained forever.

Responses
200

Snapshot update initiated.

patch/snapshots/{snapshotId}
Request samples
application/json
{
  • "expiration": "2021-07-04T00:00:00.000Z",
  • "retain_forever": false
}
Response samples
application/json
{
  • "job": {
    }
}

Unset a Snapshot's expiration, removing expiration and retain_forever values for the snapshot.

SecurityApiKeyAuth
Request
path Parameters
snapshotId
required
string non-empty

The ID of the snapshot.

Responses
200

Snapshot unset retention initiated.

post/snapshots/{snapshotId}/unset_expiration
Response samples
application/json
{
  • "job": {
    }
}

Get tags for a Snapshot.

SecurityApiKeyAuth
Request
path Parameters
snapshotId
required
string non-empty

The ID of the snapshot.

Responses
200

Ok

get/snapshots/{snapshotId}/tags
Response samples
application/json
{
  • "tags": [
    ]
}

Create tags for a Snapshot.

SecurityApiKeyAuth
Request
path Parameters
snapshotId
required
string non-empty

The ID of the snapshot.

Request Body schema: application/json
required

Tags information for Snapshot.

required
Array of objects (Tag) [ 1 .. 1000 ] items unique

Array of tags with key value pairs

Responses
201

Created

post/snapshots/{snapshotId}/tags
Request samples
application/json
{
  • "tags": [
    ]
}
Response samples
application/json
{
  • "tags": [
    ]
}

Delete tags for a Snapshot.

SecurityApiKeyAuth
Request
path Parameters
snapshotId
required
string non-empty

The ID of the snapshot.

Request Body schema: application/json

The parameters to delete tags

key
string [ 1 .. 4000 ] characters

Key of the tag

value
string [ 1 .. 4000 ] characters

Value of the tag

Array of objects (Tag) [ 1 .. 1000 ] items unique

List of tags to be deleted

Responses
204

No Content

post/snapshots/{snapshotId}/tags/delete
Request samples
application/json

Delete all tags for given object - No request body required

{ }

Search snapshots.

SecurityApiKeyAuth
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

sort
string or null

The field to sort results by. A property name with a prepended '-' signifies descending order.

Enum: "id" "-id" "engine_id" "-engine_id" "namespace" "-namespace" "name" "-name" "consistency" "-consistency" "missing_non_logged_data" "-missing_non_logged_data" "dataset_id" "-dataset_id" "creation_time" "-creation_time" "start_timestamp" "-start_timestamp" "start_location" "-start_location" "timestamp" "-timestamp" "location" "-location" "expiration" "-expiration" "retain_forever" "-retain_forever" "effective_expiration" "-effective_expiration" "effective_retain_forever" "-effective_retain_forever" "timeflow_id" "-timeflow_id" "timezone" "-timezone" "version" "-version" "temporary" "-temporary" "appdata_toolkit" "-appdata_toolkit" "appdata_metadata" "-appdata_metadata" "ase_db_encryption_key" "-ase_db_encryption_key" "mssql_internal_version" "-mssql_internal_version" "mssql_backup_set_uuid" "-mssql_backup_set_uuid" "mssql_backup_software_type" "-mssql_backup_software_type" "mssql_backup_location_type" "-mssql_backup_location_type" "mssql_empty_snapshot" "-mssql_empty_snapshot" "oracle_from_physical_standby_vdb" "-oracle_from_physical_standby_vdb" "oracle_redo_log_size_in_bytes" "-oracle_redo_log_size_in_bytes"
Example: sort=id
Request Body schema: application/json

A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension.

Filter Expression Overview

Note: All keywords are case-insensitive

Comparison Operators

Operator Description Example
CONTAINS Substring or membership testing for string and list attributes respectively. field3 CONTAINS 'foobar', field4 CONTAINS TRUE
IN Tests if field is a member of a list literal. List can contain a maximum of 100 values field2 IN ['Goku', 'Vegeta']
GE Tests if a field is greater than or equal to a literal value field1 GE 1.2e-2
GT Tests if a field is greater than a literal value field1 GT 1.2e-2
LE Tests if a field is less than or equal to a literal value field1 LE 9000
LT Tests if a field is less than a literal value field1 LT 9.02
NE Tests if a field is not equal to a literal value field1 NE 42
EQ Tests if a field is equal to a literal value field1 EQ 42

Search Operator

The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically SEARCH '12' would match an item with an attribute with an integer value of 123.

Logical Operators

Ordered by precedence.

Operator Description Example
NOT Logical NOT (Right associative) NOT field1 LE 9000
AND Logical AND (Left Associative) field1 GT 9000 AND field2 EQ 'Goku'
OR Logical OR (Left Associative) field1 GT 9000 OR field2 EQ 'Goku'

Grouping

Parenthesis () can be used to override operator precedence.

For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo')

Literal Values

Literal Description Examples
Nil Represents the absence of a value nil, Nil, nIl, NIL
Boolean true/false boolean true, false, True, False, TRUE, FALSE
Number Signed integer and floating point numbers. Also supports scientific notation. 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2
String Single or double quoted "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar'
Datetime Formatted according to RFC3339 2018-04-27T18:39:26.397237+00:00
List Comma-separated literals wrapped in square brackets [0], [0, 1], ['foo', "bar"]

Limitations

  • A maximum of 8 unique identifiers may be used inside a filter expression.
filter_expression
string [ 5 .. 2000 ] characters
Responses
200

OK

post/snapshots/search
Request samples
application/json

An example of a nested Object comparison testing that at least one repository has a version which is equal to 19.0.0.

{
  • "filter_expression": "repositories CONTAINS {version eq '19.0.0'}"
}
Response samples
application/json
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Get the snapshots at this location for a dataset.

SecurityApiKeyAuth
Request
query Parameters
dataset_id
required
string non-empty

The ID of the dSource or VDB.

Example: dataset_id=dataset-123
location
required
string [ 1 .. 256 ] characters

The location

Example: location=2332584
Responses
200

OK

get/snapshots/find_by_location
Response samples
application/json
{
  • "items": [
    ]
}

Get the snapshots at this timestamp for a dataset.

SecurityApiKeyAuth
Request
query Parameters
dataset_id
required
string non-empty

The ID of the dSource or VDB.

Example: dataset_id=dataset-123
timestamp
required
string <date-time>

The desired point in time.

Example: timestamp=2021-05-01T08:51:34.148Z
Responses
200

OK

get/snapshots/find_by_timestamp
Response samples
application/json
{
  • "items": [
    ]
}

Return the provisionable timeflow range based on a specific snapshot.

SecurityApiKeyAuth
Request
path Parameters
snapshotId
required
string non-empty

The ID of the snapshot.

Responses
200

OK

get/snapshots/{snapshotId}/timeflow_range
Response samples
application/json
{
  • "start_point_location": "1178883",
  • "start_point_timestamp": "2023-04-01T08:51:34.148Z",
  • "end_point_location": "1178884",
  • "end_point_timestamp": "2023-04-01T09:51:34.148Z",
  • "timeflow_id": "timeflow-123",
  • "provisionable": true,
  • "log_delta": 0
}
➔ Next to Timeflows