PRprobely
Reports

Create Findings Scheduled Report

Changed on
post/stored-reports/

Request

  • Base URL
    https://api.probely.com
  • URL
    https://api.probely.com/stored-reports/
  • Auth
    API key in header Authorization

Request body

idstring required

A unique Base58 value identifying this object.

namestring required

Name of the report.

date_timestring date-time nullable

Date and time when the next report will be generated, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".

recurrence'h' | 'd' | 'w' | 'm' | 'q' | ''

Recurrence of the report generation:
(if "" it's a one-time report)

  • h - Hourly
  • d - Daily
  • w - Weekly
  • m - Monthly
  • q - Quarterly
timezonestring

Two-letter country code for the time zone of the date_time, as an ISO 3166-1 alpha-2 code.

on_day_of_weekboolean

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.

scheduled_day_of_week1 | 2 | 3 | 4 | 5 | 6 | 7 | null nullable

The day of the week on which the report is generated:
(This is only applicable if on_day_of_week is true)

  • 1 - Monday
  • 2 - Tuesday
  • 3 - Wednesday
  • 4 - Thursday
  • 5 - Friday
  • 6 - Saturday
  • 7 - Sunday
week_index'first' | 'second' | 'third' | 'fourth' | 'last' | '' | 'null' nullable

The week of the month in which the report is generated:
(This is only applicable if on_day_of_week is true)

  • first - First
  • second - Second
  • third - Third
  • fourth - Fourth
  • last - Last
report_typestring
report_fileformatstring
enabledboolean required

If true, the report is generated.
Defaults to true.

Response

idstring required

A unique Base58 value identifying this object.

namestring required

Name of the report.

date_timestring date-time nullable

Date and time when the next report will be generated, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".

recurrence'h' | 'd' | 'w' | 'm' | 'q' | ''

Recurrence of the report generation:
(if "" it's a one-time report)

  • h - Hourly
  • d - Daily
  • w - Weekly
  • m - Monthly
  • q - Quarterly
timezonestring

Two-letter country code for the time zone of the date_time, as an ISO 3166-1 alpha-2 code.

on_day_of_weekboolean

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.

scheduled_day_of_week1 | 2 | 3 | 4 | 5 | 6 | 7 | null nullable

The day of the week on which the report is generated:
(This is only applicable if on_day_of_week is true)

  • 1 - Monday
  • 2 - Tuesday
  • 3 - Wednesday
  • 4 - Thursday
  • 5 - Friday
  • 6 - Saturday
  • 7 - Sunday
week_index'first' | 'second' | 'third' | 'fourth' | 'last' | '' | 'null' nullable

The week of the month in which the report is generated:
(This is only applicable if on_day_of_week is true)

  • first - First
  • second - Second
  • third - Third
  • fourth - Fourth
  • last - Last
report_typestring
report_fileformatstring
enabledboolean required

If true, the report is generated.
Defaults to true.

Changes

  • 0b2f6cbe644dRevision changes
    • info

      added the new optional request property / (media type: application/json)

    • info

      added the new optional request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property / (media type: multipart/form-data)

    • info

      added the optional write-only property filters/snyk_group to the response with the status

  • e29879bff01bRevision changes
    • warning

      added the new owasp_web_2021 enum value to the / response property for the response status

    • warning

      added the new owasp_web_2025 enum value to the / response property for the response status

    • warning

      added the new pci_v3_2_1 enum value to the / response property for the response status

    • warning

      added the new pci_v4_0_1 enum value to the / response property for the response status

    • info

      added the new owasp_web_2021 enum value to the request property / (media type: application/json)

    • info

      added the new owasp_web_2021 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new owasp_web_2021 enum value to the request property / (media type: multipart/form-data)

    • info

      added the new owasp_web_2025 enum value to the request property / (media type: application/json)

    • info

      added the new owasp_web_2025 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new owasp_web_2025 enum value to the request property / (media type: multipart/form-data)

    • info

      added the new pci_v3_2_1 enum value to the request property / (media type: application/json)

    • info

      added the new pci_v3_2_1 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new pci_v3_2_1 enum value to the request property / (media type: multipart/form-data)

    • info

      added the new pci_v4_0_1 enum value to the request property / (media type: application/json)

    • info

      added the new pci_v4_0_1 enum value to the request property / (media type: application/x-www-form-urlencoded)

    • info

      added the new pci_v4_0_1 enum value to the request property / (media type: multipart/form-data)