Get Scan Result

GET /waap/v1/domains/{domain_id}/api-discovery/scan-results/{scan_id}

Python

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
waap_api_scan_result = client.waap.domains.api_discovery.scan_results.get(
    scan_id="scan_id",
    domain_id=1,
)
print(waap_api_scan_result.id)

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "start_time": "2023-11-07T05:31:56Z",
  "end_time": "2023-11-07T05:31:56Z",
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

domain_id · integer · required

The domain ID

scan_id · string · required

The scan ID

Response

200

application/json

Successful Response

The result of a scan

id · string<uuid> · required

The scan ID

start_time · string<date-time> · required

The date and time the scan started

end_time · string<date-time> | null · required

The date and time the scan ended

status · enum<string> · required

The status of the scan

Available options: SUCCESS, FAILURE, IN_PROGRESS

type · enum<string> · required

The type of scan

Available options: TRAFFIC_SCAN, API_DESCRIPTION_FILE_SCAN

message · string · required

The message associated with the scan