Skip to content
Start here

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 { 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
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 { 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 { 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 { 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 { 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 { 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