Update Findings Scheduled Report
PUT/stored-reports/:id/
Request
Path Parameters
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
Body
required
h
- Hourlyd
- Dailyw
- Weeklym
- Monthlyq
- Quarterly1
- Monday2
- Tuesday3
- Wednesday4
- Thursday5
- Friday6
- Saturday7
- Sundayfirst
- Firstsecond
- Secondthird
- Thirdfourth
- Fourthlast
- Last
Possible values: <= 255 characters
Name of the report.
Date and time when the next report will be generated, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".
Possible values: [h
, d
, w
, m
, q
, ``]
Recurrence of the report generation:
(if ""
it's a one-time report)
Possible values: <= 64 characters
Two-letter country code for the time zone of the date_time
, as an ISO 3166-1 alpha-2 code.
If true, the report is scheduled to be generated on a specific week.
If false, the report is generated on the day set in date_time
.
This is only applicable if the recurrence
is monthly or quarterly.
Defaults to false.
Possible values: >= -2147483648
and <= 2147483647
, [1
, 2
, 3
, 4
, 5
, 6
, 7
, null
]
The day of the week on which the report is generated:
(This is only applicable if on_day_of_week
is true)
Possible values: [first
, second
, third
, fourth
, last
, ``, null
]
The week of the month in which the report is generated:
(This is only applicable if on_day_of_week
is true)
filters objectrequired
severity object
state object
assignee object
label object
If true, filter results by new findings.
If false, filter results by old findings.
target_label object
target object
team object
Possible values: <= 1024 characters
Search findings
Default value: default
Default value: pdf
Body
required
h
- Hourlyd
- Dailyw
- Weeklym
- Monthlyq
- Quarterly1
- Monday2
- Tuesday3
- Wednesday4
- Thursday5
- Friday6
- Saturday7
- Sundayfirst
- Firstsecond
- Secondthird
- Thirdfourth
- Fourthlast
- Last
Possible values: <= 255 characters
Name of the report.
Date and time when the next report will be generated, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".
Possible values: [h
, d
, w
, m
, q
, ``]
Recurrence of the report generation:
(if ""
it's a one-time report)
Possible values: <= 64 characters
Two-letter country code for the time zone of the date_time
, as an ISO 3166-1 alpha-2 code.
If true, the report is scheduled to be generated on a specific week.
If false, the report is generated on the day set in date_time
.
This is only applicable if the recurrence
is monthly or quarterly.
Defaults to false.
Possible values: >= -2147483648
and <= 2147483647
, [1
, 2
, 3
, 4
, 5
, 6
, 7
, null
]
The day of the week on which the report is generated:
(This is only applicable if on_day_of_week
is true)
Possible values: [first
, second
, third
, fourth
, last
, ``, null
]
The week of the month in which the report is generated:
(This is only applicable if on_day_of_week
is true)
filters objectrequired
severity object
state object
assignee object
label object
If true, filter results by new findings.
If false, filter results by old findings.
target_label object
target object
team object
Possible values: <= 1024 characters
Search findings
Default value: default
Default value: pdf
Body
required
h
- Hourlyd
- Dailyw
- Weeklym
- Monthlyq
- Quarterly1
- Monday2
- Tuesday3
- Wednesday4
- Thursday5
- Friday6
- Saturday7
- Sundayfirst
- Firstsecond
- Secondthird
- Thirdfourth
- Fourthlast
- Last
Possible values: <= 255 characters
Name of the report.
Date and time when the next report will be generated, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".
Possible values: [h
, d
, w
, m
, q
, ``]
Recurrence of the report generation:
(if ""
it's a one-time report)
Possible values: <= 64 characters
Two-letter country code for the time zone of the date_time
, as an ISO 3166-1 alpha-2 code.
If true, the report is scheduled to be generated on a specific week.
If false, the report is generated on the day set in date_time
.
This is only applicable if the recurrence
is monthly or quarterly.
Defaults to false.
Possible values: >= -2147483648
and <= 2147483647
, [1
, 2
, 3
, 4
, 5
, 6
, 7
, null
]
The day of the week on which the report is generated:
(This is only applicable if on_day_of_week
is true)
Possible values: [first
, second
, third
, fourth
, last
, ``, null
]
The week of the month in which the report is generated:
(This is only applicable if on_day_of_week
is true)
filters objectrequired
severity object
state object
assignee object
label object
If true, filter results by new findings.
If false, filter results by old findings.
target_label object
target object
team object
Possible values: <= 1024 characters
Search findings
Default value: default
Default value: pdf
Responses
- 200
- 400
- 401
- 404
- 500
- application/json
- Schema
- Example (from schema)
Schema
h
- Hourlyd
- Dailyw
- Weeklym
- Monthlyq
- Quarterly1
- Monday2
- Tuesday3
- Wednesday4
- Thursday5
- Friday6
- Saturday7
- Sundayfirst
- Firstsecond
- Secondthird
- Thirdfourth
- Fourthlast
- Last
A unique Base58 value identifying this object.
Possible values: <= 255 characters
Name of the report.
Date and time when the next report will be generated, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".
Possible values: [h
, d
, w
, m
, q
, ``]
Recurrence of the report generation:
(if ""
it's a one-time report)
Possible values: <= 64 characters
Two-letter country code for the time zone of the date_time
, as an ISO 3166-1 alpha-2 code.
If true, the report is scheduled to be generated on a specific week.
If false, the report is generated on the day set in date_time
.
This is only applicable if the recurrence
is monthly or quarterly.
Defaults to false.
Possible values: >= -2147483648
and <= 2147483647
, [1
, 2
, 3
, 4
, 5
, 6
, 7
, null
]
The day of the week on which the report is generated:
(This is only applicable if on_day_of_week
is true)
Possible values: [first
, second
, third
, fourth
, last
, ``, null
]
The week of the month in which the report is generated:
(This is only applicable if on_day_of_week
is true)
filters objectrequired
severity object
state object
assignee object
label object
If true, filter results by new findings.
If false, filter results by old findings.
target_label object
target object
team object
Possible values: <= 1024 characters
Search findings
Default value: default
Default value: pdf
If true, the report is generated.
Defaults to true.
{
"id": "string",
"name": "string",
"date_time": "2024-09-10T15:58:29.265Z",
"recurrence": "h",
"timezone": "string",
"on_day_of_week": true,
"scheduled_day_of_week": 1,
"week_index": "first",
"filters": {
"severity": {},
"state": {},
"assignee": {},
"label": {},
"new": true,
"target_label": {},
"target": {},
"team": {},
"search": "string"
},
"report_type": "default",
"report_fileformat": "pdf",
"enabled": true
}
- application/json
- Schema
- Example (from schema)
Schema
{
"<field name>": [
"Errors related to field <field name>."
],
"non_field_errors": [
"Errors not related to any field specific field."
]
}
- application/json
- Schema
- Example (from schema)
Schema
{
"detail": "Incorrect authentication credentials."
}
- application/json
- Schema
- Example (from schema)
Schema
{
"detail": "Not found."
}
- application/json
- Schema
- Example (from schema)
Schema
{
"detail": "Unexpected error while handling your request."
}