Scheduled Scans

Create Target's Scheduled Scan

Changed on
post/targets/{target_id}/scheduledscans/

Request

  • Base URL
    https://api.probely.com
  • URL
    https://api.probely.com/targets/{target_id}/scheduledscans/
  • Auth
    API key in header Authorization

Path parameters

target_idstring required

Identifier of the target.

Request body

idstring required

A unique Base58 value identifying this object.

date_timestring date-time required

Date and time of next scan scheduled.

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

Scheduled scan recurrence.

  • h - Hourly
  • d - Daily
  • w - Weekly
  • m - Monthly
  • q - Quarterly
changedstring date-time required

Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".

timezonestring

Timezone in which date_time will run. Expects values from TZ Database. Case sensitive. E.g: US/Central, WET.

Defaults to UTC.

run_on_day_of_weekboolean

Schedule scan to run on specific monthly day of week (for monthly/quarterly recurrence).

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

Day of week to run scan on - monday to sunday (for run on day of week option).

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

Which week of the month to run scan on (with run_on_day_of_week enabled).

  • first - First
  • second - Second
  • third - Third
  • fourth - Fourth
  • last - Last
partial_scanboolean

Future scans set as partial scans, use in conjunction with incremental and reduced_scope.

override_target_settingsboolean

Override scan target's scan settings, use in conjunction with override_target_settings.

incrementalboolean

Future scans set to incremental, use in conjunction with partial_scan and override_target_settings.

reduced_scopeboolean

Future scans set as reduced scope, use in conjunction with partial_scan and override_target_settings.

scan_profilestring nullable

Scan profile to use.
Use the endpoint List Scan Profiles to get all the available scan profiles.
If no scan profile is specified, the scan profile will be the one specified in the target settings.

unlimitedstring required

Response

idstring required

A unique Base58 value identifying this object.

date_timestring date-time required

Date and time of next scan scheduled.

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

Scheduled scan recurrence.

  • h - Hourly
  • d - Daily
  • w - Weekly
  • m - Monthly
  • q - Quarterly
changedstring date-time required

Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".

timezonestring

Timezone in which date_time will run. Expects values from TZ Database. Case sensitive. E.g: US/Central, WET.

Defaults to UTC.

run_on_day_of_weekboolean

Schedule scan to run on specific monthly day of week (for monthly/quarterly recurrence).

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

Day of week to run scan on - monday to sunday (for run on day of week option).

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

Which week of the month to run scan on (with run_on_day_of_week enabled).

  • first - First
  • second - Second
  • third - Third
  • fourth - Fourth
  • last - Last
partial_scanboolean

Future scans set as partial scans, use in conjunction with incremental and reduced_scope.

override_target_settingsboolean

Override scan target's scan settings, use in conjunction with override_target_settings.

incrementalboolean

Future scans set to incremental, use in conjunction with partial_scan and override_target_settings.

reduced_scopeboolean

Future scans set as reduced scope, use in conjunction with partial_scan and override_target_settings.

scan_profilestring nullable

Scan profile to use.
Use the endpoint List Scan Profiles to get all the available scan profiles.
If no scan profile is specified, the scan profile will be the one specified in the target settings.

unlimitedstring required

Changes

    • breaking

      added to the ///// request property allOf list (media type: application/json)

    • breaking

      added to the ///// request property allOf list (media type: application/x-www-form-urlencoded)

    • breaking

      added to the ///// request property allOf list (media type: multipart/form-data)

    • warning

      removed from the ///// request property allOf list (media type: application/json)

    • warning

      removed from the ///// request property allOf list (media type: application/x-www-form-urlencoded)

    • warning

      removed from the ///// request property allOf list (media type: multipart/form-data)

    • warning

      removed the request property ////////// (media type: application/json)

    • warning

      removed the request property ////////// (media type: application/x-www-form-urlencoded)

    • warning

      removed the request property ////////// (media type: multipart/form-data)

    • warning

      removed the request property ////////// (media type: application/json)

    • warning

      removed the request property ////////// (media type: application/x-www-form-urlencoded)

    • warning

      removed the request property ////////// (media type: multipart/form-data)

    • warning

      removed the optional property ////////// from the response with the status

    • warning

      removed the optional property ////////// from the response with the status

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • 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 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 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 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 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 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 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 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 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 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 new bruno enum value to the request property /////////////// (media type: application/json)

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional write-only property target/allOf[SimpleScope]/site/allOf[Target]/api_scan_settings/allOf[APIScanSettings]/snyk_project_id to the response with the status

    • info

      added the optional write-only property target/allOf[SimpleScope]/site/allOf[Target]/api_scan_settings/allOf[APIScanSettings]/staged_collection_id to the response with the status

    • info

      added to the ///// response property allOf list for the response status

    • info

      removed from the ///// response property allOf list for the response status

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ////////// to the response with the status

    • info

      added the required property ///////////////// to the response with the status

    • info

      added the required property /////////////// to the response with the status

    • info

      added the required property ////////// to the response with the status

    • warning

      added the new application/graphql enum value to the /////////////// response property for the response status

    • warning

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

    • 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 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 new application/graphql enum value to the request property /////////////// (media type: application/json)

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      added the optional property /////////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the required property ////////// to the response with the status