credentials

Authenticated-scan credentials and credential stores.

• Toolset name: credentials

• Enabled by default: yes

• Tools: 9 (4 read-only)

Tools

openvas_create_credential

Create credential · mutating

Create a credential for authenticated scans. type selects the kind (up, usk, cc, pw, snmp, snmpv3, or a store-backed cs_* type). Not idempotent.

Parameter	Type	Required	Description
auth_algorithm	string	no	SNMPv3 auth algorithm: md5 or sha1
certificate	string	no	PEM certificate (cc)
comment	string	no	Optional comment
community	string	no	SNMP community string (snmp)
credential_store_id	string	no	Credential store identifier (cs_* types; see openvas_list_credential_stores)
host_identifier	string	no	Write-only external host identifier (cs_* types)
login	string	no	Login/username (up, usk, snmp, snmpv3)
name	string	yes	Credential name
password	string	no	Password (up, pw, snmpv3) or key passphrase (usk)
privacy_algorithm	string	no	SNMPv3 privacy algorithm: aes or des
privacy_password	string	no	SNMPv3 privacy password
private_key	string	no	PEM private key (usk)
type	string	yes	Credential kind: up (username+password), usk (username+SSH key), cc (client certificate), pw (password only), snmp (v1/v2c), snmpv3, or store-backed cs_up, cs_usk, cs_cc, cs_pw, cs_pgp, cs_smime, cs_snmp
vault_id	string	no	Write-only external vault identifier (cs_* types)

openvas_delete_credential

Delete credential · destructive

Delete a credential (to the trashcan by default; ultimate deletes permanently). Fails with 409 if a target still uses it.

Parameter	Type	Required	Description
id	string	yes	Resource UUID
ultimate	boolean	no	Permanently delete instead of moving to the trashcan (default false)

openvas_get_credential

Get credential · read-only

Get one credential by UUID (metadata only, no secrets).

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_get_credential_store

Get credential store · read-only

Get one credential store (connection settings; preference values are write-only and never returned).

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_list_credential_stores

List credential stores · read-only

List the backend credential stores that cs_* credentials can be created in. Answers 501 on gvmd builds without credential stores.

This tool takes no parameters.

openvas_list_credentials

List credentials · read-only

List credentials usable for authenticated scans (metadata only, no secrets).

Parameter	Type	Required	Description
filter	string	no	GMP filter expression, e.g. name~webserver and severity>5
filter_id	string	no	UUID of a saved filter to apply
page	integer	no	Page number, 1-indexed (default 1) (min 0)
per_page	integer	no	Items per page, 1-1000 (default 25) (min 0)

openvas_update_credential

Update credential · destructive

Update a credential (the type cannot change). Idempotent (PUT): omitted fields stay unchanged.

Parameter	Type	Required	Description
auth_algorithm	string	no	md5 or sha1
certificate	string	no
comment	string	no
community	string	no
credential_store_id	string	no
host_identifier	string	no
id	string	yes	UUID of the credential to update
login	string	no
name	string	no
password	string	no
privacy_algorithm	string	no	aes or des
privacy_password	string	no
private_key	string	no
vault_id	string	no

openvas_update_credential_store

Update credential store · destructive

Update a credential store’s connection settings. Idempotent (PUT): omitted fields stay unchanged; preference values are write-only.

Parameter	Type	Required	Description
active	boolean	no
comment	string	no
host	string	no	Store host
id	string	yes	Credential store identifier
path	string	no	Store path
port	integer	no	Store port (0-65535) (min 0, max 65535)
preferences	array	no	Write-only preferences (e.g. tokens) for the store backend Each item: name (string, required): Preference name; value (string, required): Preference value (write-only, never returned).

openvas_verify_credential_store

Verify credential store · mutating

Ask gvmd to verify a credential store’s connection.

Parameter	Type	Required	Description
id	string	yes	Resource UUID