credentials

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

Overview

Name	credentials
Type	Resource
Id	cloudflare.vulnerability_scanner.credentials

Fields

The following fields are returned by SELECT queries:

get

Successful response.

Name	Datatype	Description
id	string (uuid)	Credential identifier.
name	string	Human-readable name. (example: Admin API key)
credential_set_id	string (uuid)	Parent credential set identifier.
location_name	string	Name of the header or cookie where the credential is attached. (example: Authorization)
location	string	Where the credential is attached in outgoing requests. (header, cookie)

list

Successful response.

Name	Datatype	Description
id	string (uuid)	Credential identifier.
name	string	Human-readable name. (example: Admin API key)
credential_set_id	string (uuid)	Parent credential set identifier.
location_name	string	Name of the header or cookie where the credential is attached. (example: Authorization)
location	string	Where the credential is attached in outgoing requests. (header, cookie)

Methods

The following methods are available for this resource:

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

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_id	string (uuid)	Credential identifier.
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 by ID.

SELECT
id,
name,
credential_set_id,
location_name,
location
FROM cloudflare.vulnerability_scanner.credentials
WHERE account_id = '{{ account_id }}' -- required
AND credential_set_id = '{{ credential_set_id }}' -- required
AND credential_id = '{{ credential_id }}' -- required
;

list

Returns all credentials within a credential set.

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

INSERT examples

create

Creates a new credential within a credential set.

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

Manifest

# Description fields are for documentation purposes
- name: credentials
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the credentials resource.
  - name: credential_set_id
    value: "{{ credential_set_id }}"
    description: Required parameter for the credentials resource.
  - name: location
    value: "{{ location }}"
    description: |
      Where the credential is attached in outgoing requests.
    valid_values: ['header', 'cookie']
  - name: location_name
    value: "{{ location_name }}"
    description: |
      Name of the header or cookie where the credential is attached.
  - name: name
    value: "{{ name }}"
    description: |
      Human-readable name.
  - name: value
    value: "{{ value }}"
    description: |
      The credential value (e.g. API key, session token). Write-only. Never returned in responses.

UPDATE examples

edit

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

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

REPLACE examples

update

Replaces a credential. All fields must be provided.

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

DELETE examples

delete

Deletes a credential.

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