List scans

GET

/v2/scans

Last modified:2025-09-01 18:52:30

Get a list of scans

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Query Params

Responses

🟢200OK

application/json

Scans list

Body

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/v2/scans?page&per_page&q&date_range_start&date_range_end&relative_date_range&sort_by&limited&extended&scheduled&status' \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <api-key>'

Response Example

200 - Normal response example

{
    "content": {
        "application/json": {
            "schema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "properties": {
                                "id": {
                                    "type": "string",
                                    "format": "uuid"
                                },
                                "type": {
                                    "type": "string"
                                },
                                "attributes": {
                                    "type": "object",
                                    "properties": {
                                        "id": {
                                            "type": "string",
                                            "format": "uuid"
                                        },
                                        "name": {
                                            "type": "string",
                                            "description": "Name of the scan"
                                        },
                                        "comment": {
                                            "type": "string",
                                            "description": "Comment about the scan"
                                        },
                                        "creation_time": {
                                            "type": "string",
                                            "format": "date-time"
                                        },
                                        "modification_time": {
                                            "type": "string",
                                            "format": "date-time"
                                        },
                                        "status": {
                                            "type": "string",
                                            "description": "Status of the scan"
                                        },
                                        "schedule_next_time": {
                                            "type": "string",
                                            "description": "Next time the scan will run",
                                            "nullable": true
                                        },
                                        "target": {
                                            "type": "object",
                                            "description": "Target of the scan",
                                            "properties": {
                                                "id": {
                                                    "type": "string",
                                                    "format": "uuid"
                                                },
                                                "name": {
                                                    "type": "string"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "meta": {
                        "$ref": "spec/requests/v2/schemas/json/metadata.json"
                    }
                }
            }
        }
    }
}

Modified at 2025-09-01 18:52:30

Statistics for a scan

Create Scan