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

GET/accounts/{account_id}/vuln_scanner/credential_sets

Create credential set

POST/accounts/{account_id}/vuln_scanner/credential_sets

Get credential set

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

Update credential set

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

Edit credential set

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

Delete credential set

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

ModelsExpand Collapse

CredentialSetListResponse object { id, name }

id: string

Credential set identifier.

formatuuid

name: string

Human-readable name.

CredentialSetCreateResponse object { id, name }

id: string

Credential set identifier.

formatuuid

name: string

Human-readable name.

CredentialSetGetResponse object { id, name }

id: string

Credential set identifier.

formatuuid

name: string

Human-readable name.

CredentialSetUpdateResponse object { id, name }

id: string

Credential set identifier.

formatuuid

name: string

Human-readable name.

CredentialSetEditResponse object { id, name }

id: string

Credential set identifier.

formatuuid

name: string

Human-readable name.

CredentialSetDeleteResponse = unknown

Credential SetsCredentials

List credentials

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

Create credential

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

Get credential

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

Update credential

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

Edit credential

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

Delete credential

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

ModelsExpand Collapse

CredentialListResponse object { 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" or "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 object { 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" or "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 object { 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" or "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 object { 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" or "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 object { 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" or "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