Reporting

Search the saving storage summary report for virtualization engines.

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

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

Example: limit=100
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: "dependant_vdbs" "-dependant_vdbs" "unvirtualized_space" "-unvirtualized_space" "current_timeflows_unvirtualized_space" "-current_timeflows_unvirtualized_space" "virtualized_space" "-virtualized_space" "name" "-name" "engine_name" "-engine_name" "dsource_id" "-dsource_id" "estimated_savings" "-estimated_savings" "estimated_savings_perc" "-estimated_savings_perc" "estimated_current_timeflows_savings" "-estimated_current_timeflows_savings" "estimated_current_timeflows_savings_perc" "-estimated_current_timeflows_savings_perc"
Example: sort=dependant_vdbs
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

Returns a list of saving storage summary data of virtualization engines.

post/reporting/storage-savings-report/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
{
  • "items": [
    ],
  • "response_metadata": {
    },
  • "totals": {
    }
}

Gets the inventory report for virtualization engine VDBs.

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

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

Example: limit=100
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: "name" "-name" "type" "-type" "version" "-version" "parent_id" "-parent_id" "parent_name" "-parent_name" "creation_date" "-creation_date" "last_refreshed_date" "-last_refreshed_date" "parent_timeflow_location" "-parent_timeflow_location" "parent_timeflow_timestamp" "-parent_timeflow_timestamp" "parent_timeflow_timezone" "-parent_timeflow_timezone" "enabled" "-enabled" "status" "-status" "engine_name" "-engine_name" "storage_size" "-storage_size"
Example: sort=name
Responses
200

Returns a list of inventory data of VDBs.

get/reporting/vdb-inventory-report
Response samples
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Search the inventory report for virtualization engine VDBs.

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

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

Example: limit=100
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: "name" "-name" "type" "-type" "version" "-version" "parent_id" "-parent_id" "parent_name" "-parent_name" "creation_date" "-creation_date" "last_refreshed_date" "-last_refreshed_date" "parent_timeflow_location" "-parent_timeflow_location" "parent_timeflow_timestamp" "-parent_timeflow_timestamp" "parent_timeflow_timezone" "-parent_timeflow_timezone" "enabled" "-enabled" "status" "-status" "engine_name" "-engine_name" "storage_size" "-storage_size"
Example: sort=name
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

Returns a list of inventory data of VDBs.

post/reporting/vdb-inventory-report/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
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Gets the usage report for virtualization engine dSources.

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

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

Example: limit=100
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: "name" "-name" "unvirtualized_space" "-unvirtualized_space" "actual_space" "-actual_space" "dependant_vdbs" "-dependant_vdbs" "engine_name" "-engine_name"
Example: sort=name
Responses
200

Returns a list of dSource usage data.

get/reporting/dsource-usage-report
Response samples
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Search the usage report for virtualization engine dSources.

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

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

Example: limit=100
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: "name" "-name" "unvirtualized_space" "-unvirtualized_space" "actual_space" "-actual_space" "dependant_vdbs" "-dependant_vdbs" "engine_name" "-engine_name"
Example: sort=name
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

Returns a list of dSource usage data.

post/reporting/dsource-usage-report/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
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Gets the consumption report for virtualization engine dSources.

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

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

Example: limit=100
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: "name" "-name" "status" "-status" "database_type" "-database_type" "engine_id" "-engine_id" "engine_name" "-engine_name" "last_consumption_date" "-last_consumption_date" "ingested_size" "-ingested_size"
Example: sort=name
Responses
200

Returns a list of dSource consumption data.

get/reporting/dsource-consumption-report
Response samples
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Search the consumption report for virtualization engine DSources.

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

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

Example: limit=100
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: "name" "-name" "status" "-status" "database_type" "-database_type" "engine_id" "-engine_id" "engine_name" "-engine_name" "last_consumption_date" "-last_consumption_date" "ingested_size" "-ingested_size"
Example: sort=name
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

Returns a list of dSource consumption data.

post/reporting/dsource-consumption-report/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
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Gets the audit log summary report.

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

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

Example: limit=100
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: "account_id" "-account_id" "account_first_name" "-account_first_name" "account_last_name" "-account_last_name" "vdb_refreshes" "-vdb_refreshes" "masking_jobs" "-masking_jobs"
Example: sort=account_first_name
Responses
200

Returns a list of aggregated audit log entries for each account.

get/reporting/audit-logs-summary-report
Response samples
{
  • "items": [
    ],
  • "response_metadata": {
    },
  • "totals": {
    }
}

Gets the storage summary report for virtualization engines.

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

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

Example: limit=100
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: "engine_id" "-engine_id" "engine_name" "-engine_name" "engine_hostname" "-engine_hostname" "total_capacity" "-total_capacity" "free_storage" "-free_storage" "used_storage" "-used_storage" "used_percentage" "-used_percentage" "dsource_count" "-dsource_count" "vdb_count" "-vdb_count" "total_object_count" "-total_object_count" "reserved_storage" "-reserved_storage" "dsource_used_storage" "-dsource_used_storage" "vdb_used_storage" "-vdb_used_storage"
Example: sort=engine_id
Responses
200

Returns a list of storage summary data of virtualization engines.

get/reporting/virtualization-storage-summary-report
Response samples
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Search the storage summary report for virtualization engines.

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

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

Example: limit=100
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: "engine_id" "-engine_id" "engine_name" "-engine_name" "engine_hostname" "-engine_hostname" "total_capacity" "-total_capacity" "free_storage" "-free_storage" "used_storage" "-used_storage" "used_percentage" "-used_percentage" "dsource_count" "-dsource_count" "vdb_count" "-vdb_count" "total_object_count" "-total_object_count" "reserved_storage" "-reserved_storage" "dsource_used_storage" "-dsource_used_storage" "vdb_used_storage" "-vdb_used_storage"
Example: sort=engine_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

Returns a list of storage summary data of virtualization engines.

post/reporting/virtualization-storage-summary-report/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
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Gets the report of API usage metrics over a given time period. This API returns at the most 10000 results in the response to protect against the server running out of memory. Users might not hit this limit with the default report without any 'apiUsageReportGroupByParam' param but can hit this limit if the groupBy is by too granular like by 'client_name' or 'user_agent' only. Hence it is advisable to use startDate and endDate to 'limit' the scope of the report.

SecurityApiKeyAuth
Request
query Parameters
start_date
string <date-time>

Report start date/time. Defaults to first API request.

Example: start_date=2022-05-29T19:00:00.000Z
end_date
string <date-time>

Report end date/time. Defaults to current time.

Example: end_date=2022-06-07T19:10:00.000Z
api_metric_kind
string

Restrict the list to API usage metric of the given kind

Enum: "automation" "governance"
Example: api_metric_kind=automation
group_by
Array of strings non-empty

The field to group results by.

Items Enum: "api_endpoint" "api_method" "kind" "client_name" "user_agent" "dct_version"
client_name
Array of strings non-empty

The Client names to be included in the report.

user_agent
Array of strings non-empty

The UserAgent names to be included in the report.

dct_version
Array of strings non-empty

The DCT versions to be included in the report.

Responses
200

Returns a list of API usage metrics.

get/reporting/api-usage-report
Response samples
{
  • "items": [
    ],
  • "total_automation_api_count": 4200,
  • "total_governance_api_count": 4200
}

List all report schedules.

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: "report_id" "-report_id" "report_type" "-report_type" "cron_expression" "-cron_expression" "time_zone" "-time_zone" "message" "-message" "file_format" "-file_format" "enabled" "-enabled" "sort_column" "-sort_column"
Example: sort=report_id
Responses
200

OK

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

Create a new report schedule.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

The parameters to create a reporting schedule.

report_type
required
string
Enum: "VIRTUALIZATION_STORAGE_SUMMARY" "ENGINE_PERFORMANCE_ANALYTIC" "VDB_INVENTORY_DATA" "DSOURCE_USAGE_DATA" "DSOURCE_CONSUMPTION_DATA" "MASKING_EXECUTION_METRICS" "AUDIT_LOGS_SUMMARY" "STORAGE_SAVINGS_SUMMARY" "DATA_RISK_SUMMARY"
cron_expression
required
string

Standard cron expressions are supported e.g. 0 15 10 L * ? - Schedule at 10:15 AM on the last day of every month, 0 0 2 ? * Mon-Fri - Schedule at 2:00 AM every Monday, Tuesday, Wednesday, Thursday and Friday. For more details kindly refer- "http://www.quartz-scheduler.org/documentation/"

time_zone
string

Timezones are specified according to the Olson tzinfo database - "https://en.wikipedia.org/wiki/List_of_tz_database_time_zones".

message
required
string
file_format
required
string
Value: "CSV"
enabled
required
boolean
Default: true
recipients
required
Array of strings <email> non-empty unique
sort_column
string
Enum: "engine_id" "engine_name" "engine_hostname" "total_capacity" "free_storage" "used_storage" "used_percentage" "dsource_count" "vdb_count" "total_object_count" "name" "unvirtualized_space" "actual_space" "dependant_vdbs" "type" "version" "parent_id" "parent_name" "creation_date" "parent_timeflow_location" "parent_timeflow_timestamp" "parent_timeflow_timezone" "enabled" "status" "connector_id" "connector_name" "connector_type" "last_profiled_date" "last_masked_date" "is_profiled" "is_sensitive_data" "is_masked" "is_at_risk" "data_elements_total" "data_elements_not_sensitive" "data_elements_sensitive_masked" "data_elements_sensitive_unmasked" "records_total" "records_not_sensitive" "records_sensitive_masked" "records_sensitive_unmasked" "-engine_id" "-engine_name" "-engine_hostname" "-total_capacity" "-free_storage" "-used_storage" "-used_percentage" "-dsource_count" "-vdb_count" "-total_object_count" "-unvirtualized_space" "-actual_space" "-dependant_vdbs" "-name" "-type" "-version" "-parent_id" "-parent_name" "-creation_date" "-parent_timeflow_location" "-parent_timeflow_timestamp" "-parent_timeflow_timezone" "-enabled" "-status" "-connector_id" "-connector_name" "-connector_type" "-last_profiled_date" "-last_masked_date" "-is_profiled" "-is_sensitive_data" "-is_masked" "-is_at_risk" "-data_elements_total" "-data_elements_not_sensitive" "-data_elements_sensitive_masked" "-data_elements_sensitive_unmasked" "-records_total" "-records_not_sensitive" "-records_sensitive_masked" "-records_sensitive_unmasked"
row_count
integer >= 1
make_current_account_owner
boolean
Default: true

Whether the account creating this reporting schedule must be configured as owner of the reporting schedule.

Responses
200

Returns the newly created schedule for a report.

post/reporting/schedule
Request samples
application/json
{
  • "report_type": "VIRTUALIZATION_STORAGE_SUMMARY",
  • "cron_expression": "0 0 2 ? * Mon-Fri",
  • "time_zone": "America/Los_Angeles",
  • "message": "sample message",
  • "file_format": "CSV",
  • "enabled": true,
  • "recipients": [
    ],
  • "sort_column": "engine_name",
  • "row_count": 1,
  • "make_current_account_owner": true
}
Response samples
application/json
{
  • "report_id": 123,
  • "report_type": "VIRTUALIZATION_STORAGE_SUMMARY",
  • "cron_expression": "0 0 2 ? * Mon-Fri",
  • "time_zone": "America/Los_Angeles",
  • "message": "sample message",
  • "file_format": "CSV",
  • "enabled": true,
  • "recipients": [
    ],
  • "tags": [
    ],
  • "sort_column": "engine_name",
  • "row_count": 1
}

Search for report schedules.

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: "report_id" "-report_id" "report_type" "-report_type" "cron_expression" "-cron_expression" "time_zone" "-time_zone" "message" "-message" "file_format" "-file_format" "enabled" "-enabled" "sort_column" "-sort_column"
Example: sort=report_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/reporting/schedule/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": {
    }
}

Returns a report schedule by ID.

SecurityApiKeyAuth
Request
path Parameters
reportId
required
integer

The ID of the report schedule.

Responses
200

OK

get/reporting/schedule/{reportId}
Response samples
application/json
{
  • "report_id": 123,
  • "report_type": "VIRTUALIZATION_STORAGE_SUMMARY",
  • "cron_expression": "0 0 2 ? * Mon-Fri",
  • "time_zone": "America/Los_Angeles",
  • "message": "sample message",
  • "file_format": "CSV",
  • "enabled": true,
  • "recipients": [
    ],
  • "tags": [
    ],
  • "sort_column": "engine_name",
  • "row_count": 1
}

Update a reporting schedule by ID.

SecurityApiKeyAuth
Request
path Parameters
reportId
required
integer

The ID of the report schedule.

Request Body schema: application/json
report_type
required
string
Enum: "VIRTUALIZATION_STORAGE_SUMMARY" "ENGINE_PERFORMANCE_ANALYTIC" "VDB_INVENTORY_DATA" "DSOURCE_USAGE_DATA" "DSOURCE_CONSUMPTION_DATA" "MASKING_EXECUTION_METRICS" "AUDIT_LOGS_SUMMARY" "STORAGE_SAVINGS_SUMMARY" "DATA_RISK_SUMMARY"
cron_expression
required
string

Standard cron expressions are supported e.g. 0 15 10 L * ? - Schedule at 10:15 AM on the last day of every month, 0 0 2 ? * Mon-Fri - Schedule at 2:00 AM every Monday, Tuesday, Wednesday, Thursday and Friday. For more details kindly refer- "http://www.quartz-scheduler.org/documentation/"

time_zone
string

Timezones are specified according to the Olson tzinfo database - "https://en.wikipedia.org/wiki/List_of_tz_database_time_zones".

message
required
string
file_format
required
string
Value: "CSV"
enabled
required
boolean
Default: true
recipients
required
Array of strings <email> non-empty unique
Array of objects (Tag)
sort_column
string
Enum: "engine_id" "engine_name" "engine_hostname" "total_capacity" "free_storage" "used_storage" "used_percentage" "dsource_count" "vdb_count" "total_object_count" "name" "unvirtualized_space" "actual_space" "dependant_vdbs" "type" "version" "parent_id" "parent_name" "creation_date" "parent_timeflow_location" "parent_timeflow_timestamp" "parent_timeflow_timezone" "enabled" "status" "connector_id" "connector_name" "connector_type" "last_profiled_date" "last_masked_date" "is_profiled" "is_sensitive_data" "is_masked" "is_at_risk" "data_elements_total" "data_elements_not_sensitive" "data_elements_sensitive_masked" "data_elements_sensitive_unmasked" "records_total" "records_not_sensitive" "records_sensitive_masked" "records_sensitive_unmasked" "-engine_id" "-engine_name" "-engine_hostname" "-total_capacity" "-free_storage" "-used_storage" "-used_percentage" "-dsource_count" "-vdb_count" "-total_object_count" "-unvirtualized_space" "-actual_space" "-dependant_vdbs" "-name" "-type" "-version" "-parent_id" "-parent_name" "-creation_date" "-parent_timeflow_location" "-parent_timeflow_timestamp" "-parent_timeflow_timezone" "-enabled" "-status" "-connector_id" "-connector_name" "-connector_type" "-last_profiled_date" "-last_masked_date" "-is_profiled" "-is_sensitive_data" "-is_masked" "-is_at_risk" "-data_elements_total" "-data_elements_not_sensitive" "-data_elements_sensitive_masked" "-data_elements_sensitive_unmasked" "-records_total" "-records_not_sensitive" "-records_sensitive_masked" "-records_sensitive_unmasked"
row_count
integer >= 1
Responses
200

OK

put/reporting/schedule/{reportId}
Request samples
application/json
{
  • "report_type": "VIRTUALIZATION_STORAGE_SUMMARY",
  • "cron_expression": "0 0 2 ? * Mon-Fri",
  • "time_zone": "America/Los_Angeles",
  • "message": "sample message",
  • "file_format": "CSV",
  • "enabled": true,
  • "recipients": [
    ],
  • "tags": [
    ],
  • "sort_column": "engine_name",
  • "row_count": 1
}
Response samples
application/json
{
  • "report_id": 123,
  • "report_type": "VIRTUALIZATION_STORAGE_SUMMARY",
  • "cron_expression": "0 0 2 ? * Mon-Fri",
  • "time_zone": "America/Los_Angeles",
  • "message": "sample message",
  • "file_format": "CSV",
  • "enabled": true,
  • "recipients": [
    ],
  • "tags": [
    ],
  • "sort_column": "engine_name",
  • "row_count": 1
}

Delete report schedule by ID.

SecurityApiKeyAuth
Request
path Parameters
reportId
required
integer

The ID of the report schedule.

Responses
204

No Content

delete/reporting/schedule/{reportId}

Get tags for a report schedule.

SecurityApiKeyAuth
Request
path Parameters
reportId
required
integer

The ID of the report schedule.

Responses
200

Ok

get/reporting/schedule/{reportId}/tags
Response samples
application/json
{
  • "tags": [
    ]
}

Create tags for a report schedule.

SecurityApiKeyAuth
Request
path Parameters
reportId
required
integer

The ID of the report schedule.

Request Body schema: application/json
required

Tags information for report schedule.

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

Array of tags with key value pairs

Responses
201

Created

post/reporting/schedule/{reportId}/tags
Request samples
application/json
{
  • "tags": [
    ]
}
Response samples
application/json
{
  • "tags": [
    ]
}

Delete tags for a report schedule.

SecurityApiKeyAuth
Request
path Parameters
reportId
required
integer

The ID of the report schedule.

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/reporting/schedule/{reportId}/tags/delete
Request samples
application/json

Delete all tags for given object - No request body required

{ }

Gets the performance analytics report for engines.

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

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

Example: limit=100
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: "engine_id" "-engine_id" "engine_name" "-engine_name" "cpu_cores_count" "-cpu_cores_count" "cpu_utilization" "-cpu_utilization" "total_memory" "-total_memory" "average_disk_latency_read" "-average_disk_latency_read" "average_disk_latency_write" "-average_disk_latency_write" "average_disk_latency_total" "-average_disk_latency_total" "average_disk_throughput_read" "-average_disk_throughput_read" "average_disk_throughput_write" "-average_disk_throughput_write" "average_disk_throughput_total" "-average_disk_throughput_total" "average_disk_iops_read" "-average_disk_iops_read" "average_disk_iops_write" "-average_disk_iops_write" "average_disk_iops_total" "-average_disk_iops_total" "average_nfs_latency_read" "-average_nfs_latency_read" "average_nfs_latency_write" "-average_nfs_latency_write" "average_nfs_latency_total" "-average_nfs_latency_total" "average_nfs_throughput_read" "-average_nfs_throughput_read" "average_nfs_throughput_write" "-average_nfs_throughput_write" "average_nfs_throughput_total" "-average_nfs_throughput_total" "average_nfs_iops_read" "-average_nfs_iops_read" "average_nfs_iops_write" "-average_nfs_iops_write" "average_nfs_iops_total" "-average_nfs_iops_total" "average_iscsi_latency_read" "-average_iscsi_latency_read" "average_iscsi_latency_write" "-average_iscsi_latency_write" "average_iscsi_latency_total" "-average_iscsi_latency_total" "average_iscsi_throughput_read" "-average_iscsi_throughput_read" "average_iscsi_throughput_write" "-average_iscsi_throughput_write" "average_iscsi_throughput_total" "-average_iscsi_throughput_total" "average_iscsi_iops_read" "-average_iscsi_iops_read" "average_iscsi_iops_write" "-average_iscsi_iops_write" "average_iscsi_iops_total" "-average_iscsi_iops_total" "average_network_throughput_transmit" "-average_network_throughput_transmit" "average_network_throughput_receive" "-average_network_throughput_receive"
Example: sort=engine_name
Responses
200

Returns a list of performance analytics data of engines.

get/reporting/engine-performance-analytic-report
Response samples
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Search the performance analytic report for engines.

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

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

Example: limit=100
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: "engine_id" "-engine_id" "engine_name" "-engine_name" "cpu_cores_count" "-cpu_cores_count" "cpu_utilization" "-cpu_utilization" "total_memory" "-total_memory" "average_disk_latency_read" "-average_disk_latency_read" "average_disk_latency_write" "-average_disk_latency_write" "average_disk_latency_total" "-average_disk_latency_total" "average_disk_throughput_read" "-average_disk_throughput_read" "average_disk_throughput_write" "-average_disk_throughput_write" "average_disk_throughput_total" "-average_disk_throughput_total" "average_disk_iops_read" "-average_disk_iops_read" "average_disk_iops_write" "-average_disk_iops_write" "average_disk_iops_total" "-average_disk_iops_total" "average_nfs_latency_read" "-average_nfs_latency_read" "average_nfs_latency_write" "-average_nfs_latency_write" "average_nfs_latency_total" "-average_nfs_latency_total" "average_nfs_throughput_read" "-average_nfs_throughput_read" "average_nfs_throughput_write" "-average_nfs_throughput_write" "average_nfs_throughput_total" "-average_nfs_throughput_total" "average_nfs_iops_read" "-average_nfs_iops_read" "average_nfs_iops_write" "-average_nfs_iops_write" "average_nfs_iops_total" "-average_nfs_iops_total" "average_iscsi_latency_read" "-average_iscsi_latency_read" "average_iscsi_latency_write" "-average_iscsi_latency_write" "average_iscsi_latency_total" "-average_iscsi_latency_total" "average_iscsi_throughput_read" "-average_iscsi_throughput_read" "average_iscsi_throughput_write" "-average_iscsi_throughput_write" "average_iscsi_throughput_total" "-average_iscsi_throughput_total" "average_iscsi_iops_read" "-average_iscsi_iops_read" "average_iscsi_iops_write" "-average_iscsi_iops_write" "average_iscsi_iops_total" "-average_iscsi_iops_total" "average_network_throughput_transmit" "-average_network_throughput_transmit" "average_network_throughput_receive" "-average_network_throughput_receive"
Example: sort=engine_name
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

Returns a list of performance analytics data of engines.

post/reporting/engine-performance-analytic-report/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
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Returns the DCT Product Information.

SecurityApiKeyAuth
Responses
200

OK

get/reporting/product_info
Response samples
application/json
{
  • "api_version": "1.0.0",
  • "product_version": "1.0.0",
  • "system_uuid": "string",
  • "product_upgrade_history": [
    ],
  • "supported_api_versions": [
    ],
  • "deployment_mode": "string"
}
➔ Next to DatabaseTemplates