Skip to main content
GET
/
waap
/
v1
/
domains
/
{domain_id}
/
api-discovery
/
scan-results
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
)
page = client.waap.domains.api_discovery.list_scan_results(
    domain_id=1,
)
page = page.results[0]
print(page.id)
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "start_time": "2023-11-07T05:31:56Z",
      "end_time": "2023-11-07T05:31:56Z",
      "status": "SUCCESS",
      "type": "TRAFFIC_SCAN",
      "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 The domain ID

Query Parameters

​
ordering
enum<string>
default:-start_time

Sort the response by given field. Sort the response by given field.

Available options:
id,
type,
start_time,
end_time,
status,
message,
-id,
-type,
-start_time,
-end_time,
-status,
-message
​
type
enum<string> | null

Filter by the path of the scan type Filter by the path of the scan type

Available options:
TRAFFIC_SCAN,
API_DESCRIPTION_FILE_SCAN
​
status
enum<string> | null

Filter by the status of the scan Filter by the status of the scan

Available options:
SUCCESS,
FAILURE,
IN_PROGRESS
​
message
string | null

Filter by the message of the scan. Supports '' as a wildcard character Filter by the message of the scan. Supports '' as a wildcard character

Maximum string length: 1024
​
limit
integer
default:100

Number of items to return Number of items to return

Required range: 0 <= x <= 100
​
offset
integer
default:0

Number of items to skip Number of items to skip

Required range: 0 <= x <= 100000

Response

Successful Response

​
limit
integer
required

Number of items requested in the response

​
offset
integer
required

Items response offset used

​
count
integer
required

Number of items contain in the response

​
results
ApiScanResult · object[]
required

List of items returned in the response following given criteria