PRprobely
Targets

Disable Active API Authentication Method

Changed on

Disables the currently active API authentication method and, when another method is ready on the same row, switches to it so the target stays authenticated. Since BAW-2131 the stored credentials of the deactivated method (payload SA fields or browser-auth token descriptors) are preserved so the caller can toggle the active method back via a PUT of api_login_method without re-entering them. Callers that want to truly clear a method's stored configuration should PATCH the api-scan-settings endpoint with empty strings.

delete/targets/{id}/api-auth/

Request

  • Base URL
    https://api.probely.com
  • URL
    https://api.probely.com/targets/{id}/api-auth/
  • Auth
    API key in header Authorization

Path parameters

idstring required

A unique Base58 value identifying this object.

Response

idstring required

A unique Base58 value identifying this object.

lowsinteger nullable required

Number of unresolved vulnerability findings with low severity.

mediumsinteger nullable required

Number of unresolved vulnerability findings with medium severity.

highsinteger nullable required

Number of unresoved vulnerability findings with high severity.

criticalsinteger nullable required

Number of unresolved vulnerability findings with critical severity.

riskinteger nullable required
scan_profilestring

Identifier of the scan profile.

typestring

Type of target.
Possible values are "single" for a web application and "api" for an API.
Defaults to "single".

unlimitedboolean

If true, the target has unlimited scans.
If false, the target scans consume credits.
Learn more about unlimited scans vs scans with credits.

report_type'default' | 'executive_summary' | 'owasp' | 'owasp_web_2021' | 'owasp_web_2025' | 'pci' | 'pci_v3_2_1' | 'pci4' | 'pci_v4_0_1' | 'iso27001' | 'hipaa'

Type of scan report produced for the target:
(Defaults to default)

  • default - Standard
  • executive_summary - Executive Summary
  • owasp - OWASP Top 10 2021
  • owasp_web_2021 - OWASP Top 10 2021
  • owasp_web_2025 - OWASP Top 10 2025
  • pci - PCI DSS 3.2.1
  • pci_v3_2_1 - PCI DSS 3.2.1
  • pci4 - PCI DSS 4.0.1
  • pci_v4_0_1 - PCI DSS 4.0.1
  • iso27001 - ISO 27001
  • hipaa - HIPAA
report_fileformat'pdf' | 'docx'

Report format for the target:
(Defaults to pdf)

  • pdf - PDF file format.
  • docx - DOCX file format.
include_deduplicated_endpointsboolean nullable

If true or null, the coverage report includes rejected endpoints, when the plan allows it.
If false, it includes only the endpoints sent to the scanner.
Rejected endpoints are kept for 90 days after the scan.

fail_fastboolean

If true, scans fail on recoverable errors.
If false, scans continue on recoverable errors.
Defaults to true.

login_videostring required
changedstring date-time required

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

incrementalboolean

If true, on-demand scans can be incremental to narrow the coverage to new and updated URLs.
Learn more about partial scans.
Defaults to false.

reduced_scopeboolean

If true, on-demand scans can have reduced scope to narrow the coverage to defined URLs.
Learn more about partial scans.
Defaults to false.

schedule_incrementalboolean

If true, scheduled scans can be incremental to narrow the coverage to new and updated URLs.
Learn more about partial scans.
Defaults to false.

schedule_reduced_scopeboolean

If true, scheduled scans can have reduced scope to narrow the coverage to defined URLs.
Learn more about partial scans.
Defaults to false.

crawl_sequences_onlyboolean

If true, on-demand scans can only crawl navigation sequences to narrow the coverage.
Learn more about partial scans.
Defaults to false.

schedule_crawl_sequences_onlyboolean

If true, scheduled scans can only crawl navigation sequences to narrow the coverage.
Learn more about partial scans.
Defaults to false.

cancel_scan_on_nav_seq_failureboolean

If true, scans are canceled if one of the navigation sequences fails. Defaults to false.

Changes

  • 0b2f6cbe644dRevision changes
    • warning

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

    • warning

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

    • 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 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 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 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 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

    • warning

      added the new zip enum value to the ////////// response property for the response 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 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 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

      the response optional property became read-only for the status

    • info

      added the optional write-only property next_scan/allOf[ScheduledScan]/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 next_scan/allOf[ScheduledScan]/target/allOf[SimpleScope]/site/allOf[Target]/api_scan_settings/allOf[APIScanSettings]/staged_collection_id to the response with the status

    • info

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

    • info

      added the optional write-only property site/allOf[PatchedTarget]/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

      the response property became required for 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

    • 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

    • 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

  • e29879bff01bRevision changes
    • warning

      added the new application/graphql enum value to the //////////////////// response property for the response 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

    • warning

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

    • 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 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 required property /////////////// to the response with the status