API Reference

Vulnerability Scanner

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Credential Sets

List Credential Sets

client.vulnerabilityScanner.credentialSets.list(CredentialSetListParams { account_id, page, per_page } params?, RequestOptionsoptions?): V4PagePaginationArray<CredentialSetListResponse { id, name } >

GET/accounts/{account_id}/vuln_scanner/credential_sets

Create Credential Set

client.vulnerabilityScanner.credentialSets.create(CredentialSetCreateParams { account_id, name } params, RequestOptionsoptions?): CredentialSetCreateResponse { id, name }

POST/accounts/{account_id}/vuln_scanner/credential_sets

Get Credential Set

client.vulnerabilityScanner.credentialSets.get(stringcredentialSetId, CredentialSetGetParams { account_id } params?, RequestOptionsoptions?): CredentialSetGetResponse { id, name }

GET/accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}

Update Credential Set

client.vulnerabilityScanner.credentialSets.update(stringcredentialSetId, CredentialSetUpdateParams { account_id, name } params, RequestOptionsoptions?): CredentialSetUpdateResponse { id, name }

PUT/accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}

Edit Credential Set

client.vulnerabilityScanner.credentialSets.edit(stringcredentialSetId, CredentialSetEditParams { account_id, name } params, RequestOptionsoptions?): CredentialSetEditResponse { id, name }

PATCH/accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}

Delete Credential Set

client.vulnerabilityScanner.credentialSets.delete(stringcredentialSetId, CredentialSetDeleteParams { account_id } params?, RequestOptionsoptions?): CredentialSetDeleteResponse | null

DELETE/accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}

ModelsExpand Collapse

CredentialSetListResponse { id, name }

id: string

Credential set identifier.

formatuuid

name: string

Human-readable name.

CredentialSetCreateResponse { id, name }

id: string

Credential set identifier.

formatuuid

name: string

Human-readable name.

CredentialSetGetResponse { id, name }

id: string

Credential set identifier.

formatuuid

name: string

Human-readable name.

CredentialSetUpdateResponse { id, name }

id: string

Credential set identifier.

formatuuid

name: string

Human-readable name.

CredentialSetEditResponse { id, name }

id: string

Credential set identifier.

formatuuid

name: string

Human-readable name.

CredentialSetDeleteResponse = unknown

Credential SetsCredentials

List Credentials

client.vulnerabilityScanner.credentialSets.credentials.list(stringcredentialSetId, CredentialListParams { account_id, page, per_page } params?, RequestOptionsoptions?): V4PagePaginationArray<CredentialListResponse { id, credential_set_id, location, 2 more } >

GET/accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}/credentials

Create Credential

client.vulnerabilityScanner.credentialSets.credentials.create(stringcredentialSetId, CredentialCreateParams { account_id, location, location_name, 2 more } params, RequestOptionsoptions?): CredentialCreateResponse { id, credential_set_id, location, 2 more }

POST/accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}/credentials

Get Credential

client.vulnerabilityScanner.credentialSets.credentials.get(stringcredentialSetId, stringcredentialId, CredentialGetParams { account_id } params?, RequestOptionsoptions?): CredentialGetResponse { id, credential_set_id, location, 2 more }

GET/accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}/credentials/{credential_id}

Update Credential

client.vulnerabilityScanner.credentialSets.credentials.update(stringcredentialSetId, stringcredentialId, CredentialUpdateParams { account_id, location, location_name, 2 more } params, RequestOptionsoptions?): CredentialUpdateResponse { id, credential_set_id, location, 2 more }

PUT/accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}/credentials/{credential_id}

Edit Credential

client.vulnerabilityScanner.credentialSets.credentials.edit(stringcredentialSetId, stringcredentialId, CredentialEditParams { account_id, location, location_name, 2 more } params, RequestOptionsoptions?): CredentialEditResponse { id, credential_set_id, location, 2 more }

PATCH/accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}/credentials/{credential_id}

Delete Credential

client.vulnerabilityScanner.credentialSets.credentials.delete(stringcredentialSetId, stringcredentialId, CredentialDeleteParams { account_id } params?, RequestOptionsoptions?): CredentialDeleteResponse | null

DELETE/accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}/credentials/{credential_id}

ModelsExpand Collapse

CredentialListResponse { id, credential_set_id, location, 2 more }

A credential attached to API requests during scanning. The credential value is write-only and never returned in responses.

id: string

Credential identifier.

formatuuid

credential_set_id: string

Parent credential set identifier.

formatuuid

location: "header" | "cookie"

Where the credential is attached in outgoing requests.

One of the following:

"header"

"cookie"

location_name: string

Name of the header or cookie where the credential is attached.

name: string

Human-readable name.

CredentialCreateResponse { id, credential_set_id, location, 2 more }

A credential attached to API requests during scanning. The credential value is write-only and never returned in responses.

id: string

Credential identifier.

formatuuid

credential_set_id: string

Parent credential set identifier.

formatuuid

location: "header" | "cookie"

Where the credential is attached in outgoing requests.

One of the following:

"header"

"cookie"

location_name: string

Name of the header or cookie where the credential is attached.

name: string

Human-readable name.

CredentialGetResponse { id, credential_set_id, location, 2 more }

A credential attached to API requests during scanning. The credential value is write-only and never returned in responses.

id: string

Credential identifier.

formatuuid

credential_set_id: string

Parent credential set identifier.

formatuuid

location: "header" | "cookie"

Where the credential is attached in outgoing requests.

One of the following:

"header"

"cookie"

location_name: string

Name of the header or cookie where the credential is attached.

name: string

Human-readable name.

CredentialUpdateResponse { id, credential_set_id, location, 2 more }

A credential attached to API requests during scanning. The credential value is write-only and never returned in responses.

id: string

Credential identifier.

formatuuid

credential_set_id: string

Parent credential set identifier.

formatuuid

location: "header" | "cookie"

Where the credential is attached in outgoing requests.

One of the following:

"header"

"cookie"

location_name: string

Name of the header or cookie where the credential is attached.

name: string

Human-readable name.

CredentialEditResponse { id, credential_set_id, location, 2 more }

A credential attached to API requests during scanning. The credential value is write-only and never returned in responses.

id: string

Credential identifier.

formatuuid

credential_set_id: string

Parent credential set identifier.

formatuuid

location: "header" | "cookie"

Where the credential is attached in outgoing requests.

One of the following:

"header"

"cookie"

location_name: string

Name of the header or cookie where the credential is attached.

name: string

Human-readable name.

CredentialDeleteResponse = unknown