credential_sets

Creates, updates, deletes, gets or lists a credential_sets resource.

Overview

Name	credential_sets
Type	Resource
Id	cloudflare.vulnerability_scanner.credential_sets

Fields

The following fields are returned by SELECT queries:

get

Successful response.

Name	Datatype	Description
id	string (uuid)	Credential set identifier.
name	string	Human-readable name. (example: Production API credentials)

list

Successful response.

Name	Datatype	Description
id	string (uuid)	Credential set identifier.
name	string	Human-readable name. (example: Production API credentials)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, credential_set_id		Returns a single credential set by ID.
list	select	account_id	page, per_page	Returns all credential sets for the account.
create	insert	account_id, name		Creates a new credential set.
edit	update	account_id, credential_set_id		Updates a credential set with only the provided fields; omitted fields remain unchanged.
update	replace	account_id, credential_set_id, name		Replaces a credential set. All fields must be provided.
delete	delete	account_id, credential_set_id		Deletes a credential set and all of its credentials.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
credential_set_id	string (uuid)	Credential set identifier.
page	integer	Page number of paginated results.
per_page	integer	Number of results per page.

SELECT examples

get

Returns a single credential set by ID.

SELECT
id,
name
FROM cloudflare.vulnerability_scanner.credential_sets
WHERE account_id = '{{ account_id }}' -- required
AND credential_set_id = '{{ credential_set_id }}' -- required
;

list

Returns all credential sets for the account.

SELECT
id,
name
FROM cloudflare.vulnerability_scanner.credential_sets
WHERE account_id = '{{ account_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;

INSERT examples

create

Creates a new credential set.

INSERT INTO cloudflare.vulnerability_scanner.credential_sets (
name,
account_id
)
SELECT 
'{{ name }}' /* required */,
'{{ account_id }}'
RETURNING
errors,
messages,
result,
result_info,
success
;

Manifest

# Description fields are for documentation purposes
- name: credential_sets
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the credential_sets resource.
  - name: name
    value: "{{ name }}"
    description: |
      Human-readable name.

UPDATE examples

edit

Updates a credential set with only the provided fields; omitted fields remain unchanged.

UPDATE cloudflare.vulnerability_scanner.credential_sets
SET 
name = '{{ name }}'
WHERE 
account_id = '{{ account_id }}' --required
AND credential_set_id = '{{ credential_set_id }}' --required
RETURNING
errors,
messages,
result,
result_info,
success;

REPLACE examples

update

Replaces a credential set. All fields must be provided.

REPLACE cloudflare.vulnerability_scanner.credential_sets
SET 
name = '{{ name }}'
WHERE 
account_id = '{{ account_id }}' --required
AND credential_set_id = '{{ credential_set_id }}' --required
AND name = '{{ name }}' --required
RETURNING
errors,
messages,
result,
result_info,
success;

DELETE examples

delete

Deletes a credential set and all of its credentials.

DELETE FROM cloudflare.vulnerability_scanner.credential_sets
WHERE account_id = '{{ account_id }}' --required
AND credential_set_id = '{{ credential_set_id }}' --required
;