Scans

List Scan Endpoints

Changed on

Returns discovered endpoints in JSON (paginated) or CSV format depending on the Accept header. Default format is CSV for backward compatibility. With the target's All URLs report setting enabled, skipped URLs and their reasons are included for 90 days.

get/targets/{target_id}/scans/{id}/endpoints/

Request

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

Path parameters

idstring required

A unique Base58 value identifying this object.

target_idstring required

Identifier of the target.

Query parameters

authenticatedstring[]

Whether the endpoint was discovered while authenticated. unknown selects the endpoints where the crawler did not record it.

categorystring[]

The crawler's own four categories, which result cannot express on its own: accepted is what the scanner was given; limits_hit is a scan limit; deduplicated is same-content detection or an exact URL repeat; out_of_scope is everything else the crawler dropped.

fieldsstring

Comma-separated columns to write, for the CSV only. Absent, every column is written. The columns keep the serializer's order, not the order they are named in.

format'csv' | 'json'
hoststring

Host of the endpoint's URL, comma-separated for several. A bare host (e.g. example.com) selects either scheme and any port. Prefix with a scheme (e.g. https://example.com) to match that exact origin: that scheme and the scheme's default port, or the port given (https://example.com:8443).

methodstring[]

HTTP method. Repeat the parameter to select several.

orderingstring

Field to order by, optionally prefixed with - to reverse, and comma-separated to order within a group. One of: changed, url, method, status, result, reason, authenticated, raw_request_size, raw_response_size, request_parameters_count, response_time_ms, page_load_ms, operation_name, operation_type. JSON only, and it defaults to -changed; the CSV keeps its own oldest-first order.

reasonstring

Exact reason string, comma-separated for several. An empty value selects the endpoints that carry no reason, which are the accepted ones.

request_methodstring
resultstring[]

Coverage decision. accepted is what the scanner was given; rejected is everything the crawler dropped, with reason saying why.

searchstring

Case-insensitive substring of the URL.

status_codestring
status_code_groupstring[]

Leading digit of the HTTP status code, so 4 selects every 4XX response; other selects any response outside 1XX-5XX (a 601, say); none selects the endpoints with no response code. Repeat to select several.

urlstring

Response

Paginated JSON with envelope: {count, page_total, page, length, results}

countinteger

Total number of results.

page_totalinteger

Total number of pages.

pageinteger

Number of the current page.
The first page is 1.
Defaults to 1 if no specific page is requested.

lengthinteger

Number of results returned per page.

Example response

{
  "count": 6,
  "page_total": 1,
  "page": 1,
  "length": 10
}

Changes

    • info

      added the new optional query request parameter authenticated

    • info

      added the new optional query request parameter category

    • info

      added the new optional query request parameter fields

    • info

      added the new optional query request parameter format

    • info

      added the new optional query request parameter host

    • info

      added the new optional query request parameter method

    • info

      added the new optional query request parameter ordering

    • info

      added the new optional query request parameter reason

    • info

      added the new optional query request parameter request_method

    • info

      added the new optional query request parameter result

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter status_code

    • info

      added the new optional query request parameter status_code_group

    • info

      added the new optional query request parameter url

    • info

      added the media type application/csv for the response with the status

    • info

      added the media type application/csv for the response with the status

    • info

      added the media type application/csv for the response with the status

    • info

      added the media type application/csv for the response with the status

    • info

      added the media type application/json for the response with the status