Documentation / website-scanner / WebsiteScannerClient

Class: WebsiteScannerClient

Defined in: website-scanner/src/index.ts:4

Extends

• GeneratedWebsiteScannerClient

Constructors

Constructor

new WebsiteScannerClient(options?): WebsiteScannerClient

Defined in: website-scanner/src/index.ts:5

Parameters

Parameter	Type
options?	BrowserStackOptions

Returns

WebsiteScannerClient

Overrides

GeneratedWebsiteScannerClient.constructor

Properties

Property	Type	Description	Inherited from	Defined in
authHeader?	string	HTTP Basic Auth header derived from username and access key.	GeneratedWebsiteScannerClient.authHeader	core/src/api-client.ts:55
baseUrls	object	Base URLs used for API requests.	GeneratedWebsiteScannerClient.baseUrls	core/src/api-client.ts:53
baseUrls.sdk	string	-	-	core/src/api-client.ts:53
baseUrls.sdkCloud	string	-	-	core/src/api-client.ts:53
clientTimeout?	number	-	GeneratedWebsiteScannerClient.clientTimeout	core/src/api-client.ts:66
fetchFn	(input, init?) => Promise<Response>	Fetch implementation used to make HTTP requests.	GeneratedWebsiteScannerClient.fetchFn	core/src/api-client.ts:59
registry	CodecRegistry	Registry of request and response codecs.	GeneratedWebsiteScannerClient.registry	core/src/api-client.ts:61
userAgent	string	User-Agent string sent with every request.	GeneratedWebsiteScannerClient.userAgent	core/src/api-client.ts:57

Methods

createWebsiteScannerAuthConfig()

createWebsiteScannerAuthConfig(body, options?): Promise<{ data?: { id?: number; name?: string; password?: string; passwordSelector?: string; submitSelector?: string; type?: string; url?: string; username?: string; usernameSelector?: string; }; success?: boolean; }>

Defined in: openapi/generated/website-scanner.client.ts:106

Creates a new authentication configuration for the Website Scanner to access login-protected pages during scans.

Parameters

Parameter	Type	Description
body	{ authData: { password?: string; passwordSelector?: string; submitSelector?: string; url?: string; username?: string; usernameSelector?: string; }; name: string; type: "basic" | "form_2"; }	-
body.authData	{ password?: string; passwordSelector?: string; submitSelector?: string; url?: string; username?: string; usernameSelector?: string; }	-
body.authData.password?	string	-
body.authData.passwordSelector?	string	-
body.authData.submitSelector?	string	-
body.authData.url?	string	-
body.authData.username?	string	-
body.authData.usernameSelector?	string	-
body.name?	string	-
body.type?	"basic" | "form_2"	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ data?: { id?: number; name?: string; password?: string; passwordSelector?: string; submitSelector?: string; type?: string; url?: string; username?: string; usernameSelector?: string; }; success?: boolean; }>

Inherited from

GeneratedWebsiteScannerClient.createWebsiteScannerAuthConfig

---

createWebsiteScannerScan()

createWebsiteScannerScan(body, options?): Promise<{ data?: { projectId?: number; reportId?: number; }; success?: boolean; }>

Defined in: openapi/generated/website-scanner.client.ts:170

Creates a new Website Scanner scan project with the specified configuration.

Parameters

Parameter	Type	Description
body	{ instantRun?: boolean; name: string; recurring?: boolean; scanData: { urlSet: string[]; }; }	-
body.instantRun?	boolean	-
body.name?	string	-
body.recurring?	boolean	-
body.scanData?	{ urlSet: string[]; }	-
body.scanData.urlSet?	string[]	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ data?: { projectId?: number; reportId?: number; }; success?: boolean; }>

Inherited from

GeneratedWebsiteScannerClient.createWebsiteScannerScan

---

execute()

protected execute<T>(spec): Promise<T>

Defined in: core/src/api-client.ts:126

Internal

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
spec	{[key: string]: unknown; baseUrl?: "sdk" | "sdkCloud"; method: HttpMethod; operationId: string; params?: { path?: Record<string, unknown>; query?: Record<string, unknown>; }; path: string; requestCodec?: string; requestCodecConfig?: unknown; requestInput?: unknown; responseCodec: string; responseCodecConfig: unknown; signal?: AbortSignal; }
spec.baseUrl?	"sdk" | "sdkCloud"
spec.method	HttpMethod
spec.operationId	string
spec.params?	{ path?: Record<string, unknown>; query?: Record<string, unknown>; }
spec.params.path?	Record<string, unknown>
spec.params.query?	Record<string, unknown>
spec.path	string
spec.requestCodec?	string
spec.requestCodecConfig?	unknown
spec.requestInput?	unknown
spec.responseCodec	string
spec.responseCodecConfig	unknown
spec.signal?	AbortSignal

Returns

Promise<T>

Inherited from

GeneratedWebsiteScannerClient.execute

---

getWebsiteScannerScan()

getWebsiteScannerScan(projId, options?): Promise<{ data?: { active?: boolean; id?: number; isRunning?: boolean; name?: string; recurring?: boolean; }; success?: boolean; }>

Defined in: openapi/generated/website-scanner.client.ts:149

Returns details for a specific Website Scanner scan project.

Parameters

Parameter	Type	Description
projId	number	The unique ID of the scan project
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ data?: { active?: boolean; id?: number; isRunning?: boolean; name?: string; recurring?: boolean; }; success?: boolean; }>

Inherited from

GeneratedWebsiteScannerClient.getWebsiteScannerScan

---

getWebsiteScannerScanRunStatus()

getWebsiteScannerScanRunStatus(projId, reportId, options?): Promise<{ status?: "failed" | "queued" | "processing" | "finalizing" | "completed"; success?: boolean; }>

Defined in: openapi/generated/website-scanner.client.ts:236

Returns the current execution status of a specific Website Scanner scan run.

Parameters

Parameter	Type	Description
projId	number	-
reportId	number	The unique ID of the scan run report
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ status?: "failed" | "queued" | "processing" | "finalizing" | "completed"; success?: boolean; }>

Inherited from

GeneratedWebsiteScannerClient.getWebsiteScannerScanRunStatus

---

getWebsiteScannerScanRunSummary()

getWebsiteScannerScanRunSummary(projId, reportId, product?, options?): Promise<{ data?: {[key: string]: unknown; }; success?: boolean; }>

Defined in: openapi/generated/website-scanner.client.ts:257

Returns the summary for a specific Website Scanner scan run, including issue counts and scan metadata.

Parameters

Parameter	Type	Description
projId	number	-
reportId	number	-
product?	string	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ data?: {[key: string]: unknown; }; success?: boolean; }>

Inherited from

GeneratedWebsiteScannerClient.getWebsiteScannerScanRunSummary

---

listWebsiteScannerAuthConfigs()

listWebsiteScannerAuthConfigs(options?): Promise<{ data?: {[key: string]: unknown; }; success?: boolean; }>

Defined in: openapi/generated/website-scanner.client.ts:85

Returns all saved authentication configurations used by the Website Scanner for login-protected pages.

Parameters

Parameter	Type	Description
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ data?: {[key: string]: unknown; }; success?: boolean; }>

Inherited from

GeneratedWebsiteScannerClient.listWebsiteScannerAuthConfigs

---

listWebsiteScannerScanRuns()

listWebsiteScannerScanRuns(projId, page?, pageSize?, options?): Promise<{ data?: {[key: string]: unknown; }; success?: boolean; }>

Defined in: openapi/generated/website-scanner.client.ts:214

Returns a paginated list of all scan runs for a specific Website Scanner scan project.

Parameters

Parameter	Type	Description
projId	number	The unique ID of the scan project
page?	number	-
pageSize?	number	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ data?: {[key: string]: unknown; }; success?: boolean; }>

Inherited from

GeneratedWebsiteScannerClient.listWebsiteScannerScanRuns

---

listWebsiteScannerScans()

listWebsiteScannerScans(page?, pageSize?, options?): Promise<{ data?: { info?: {[key: string]: unknown; }; projects?: object[]; }; success?: boolean; }>

Defined in: openapi/generated/website-scanner.client.ts:127

Returns a paginated list of all configured Website Scanner scans for your account.

Parameters

Parameter	Type	Description
page?	number	-
pageSize?	number	-
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ data?: { info?: {[key: string]: unknown; }; projects?: object[]; }; success?: boolean; }>

Inherited from

GeneratedWebsiteScannerClient.listWebsiteScannerScans

---

triggerWebsiteScannerScanRun()

triggerWebsiteScannerScanRun(projectId, options?): Promise<{ data?: { scanRunId?: number; }; success?: boolean; }>

Defined in: openapi/generated/website-scanner.client.ts:192

Triggers a new scan run for an existing Website Scanner scan project.

Parameters

Parameter	Type	Description
projectId	number	The unique ID of the scan project
options?	ExecuteOptions	Optional abort signal and other request options

Returns

Promise<{ data?: { scanRunId?: number; }; success?: boolean; }>

Inherited from

GeneratedWebsiteScannerClient.triggerWebsiteScannerScanRun