Skip to content
/
Update a reporting schedu...

Update a reporting schedule by ID.

Request

Security
ApiKeyAuth
Path
reportIdintegerrequired

The ID of the report schedule.

Bodyapplication/json

The parameters to update a schedule.

report_typestringrequired
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"
Example:"VIRTUALIZATION_STORAGE_SUMMARY"
cron_expressionstringrequired

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/"

Example:"0 0 2 ? * Mon-Fri"
time_zonestring

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

Example:"America/Los_Angeles"
messagestringrequired
Example:"sample message"
file_formatstringrequired
Value:"CSV"
Example:"CSV"
enabledbooleanrequired
Default:true
Example:true
recipientsArray of strings, (email), non-empty, uniquerequired
Example:
[
  "user@example.com"
]
tagsArray of objects(Tag)
sort_columnstring
Enum:"engine_id""engine_name""engine_hostname""total_capacity""free_storage""used_storage""used_percentage""dsource_count""vdb_count""total_object_count"
Example:"engine_name"
row_countinteger, >= 1
Example:1
curl -i -X PUT \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-data/2026.5.0.0/continuous-data-apis-dct-2026.5.0.0/reporting/schedule/{reportId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "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": [
      "user@example.com"
    ],
    "tags": [
      {
        "key": "key-1",
        "value": "value-1"
      }
    ],
    "sort_column": "engine_name",
    "row_count": 1
  }'

Responses

OK

Bodyapplication/json
report_idintegerread-only
Example:123
report_typestringrequired
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"
Example:"VIRTUALIZATION_STORAGE_SUMMARY"
cron_expressionstringrequired

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/"

Example:"0 0 2 ? * Mon-Fri"
time_zonestring

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

Example:"America/Los_Angeles"
messagestringrequired
Example:"sample message"
file_formatstringrequired
Value:"CSV"
Example:"CSV"
enabledbooleanrequired
Default:true
Example:true
recipientsArray of strings, (email), non-empty, uniquerequired
Example:
[
  "user@example.com"
]
tagsArray of objects(Tag)
sort_columnstring
Enum:"engine_id""engine_name""engine_hostname""total_capacity""free_storage""used_storage""used_percentage""dsource_count""vdb_count""total_object_count"
Example:"engine_name"
row_countinteger, >= 1
Example:1
Response
{
  "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": [
    "user@example.com"
  ],
  "tags": [
    { … }
  ],
  "sort_column": "engine_name",
  "row_count": 1
}