tokens

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

Overview

Name	tokens
Type	Resource
Id	cloudflare.aisearch.tokens

Fields

The following fields are returned by SELECT queries:

get

Token details.

Name	Datatype	Description
id	string (uuid)
name	string
cf_api_id	string
created_at	string (date-time)
created_by	string
enabled	boolean
legacy	boolean
modified_at	string (date-time)
modified_by	string

list

List of tokens.

Name	Datatype	Description
id	string (uuid)
name	string
cf_api_id	string
created_at	string (date-time)
created_by	string
enabled	boolean
legacy	boolean
modified_at	string (date-time)
modified_by	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, id		Read token.
list	select	account_id	page, per_page, search	List tokens.
create	insert	account_id, name, cf_api_id, cf_api_key		Create a new token.
update	replace	account_id, id, name, cf_api_id, cf_api_key		Update token.
delete	delete	account_id, id		Delete token.

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.
id	string	Resource ID.
page	integer	Page number (1-indexed).
per_page	integer	Number of results per page.
search	string	Filter tokens whose name contains this string (case-insensitive).

SELECT examples

get

Read token.

SELECT
id,
name,
cf_api_id,
created_at,
created_by,
enabled,
legacy,
modified_at,
modified_by
FROM cloudflare.aisearch.tokens
WHERE account_id = '{{ account_id }}' -- required
AND id = '{{ id }}' -- required
;

list

List tokens.

SELECT
id,
name,
cf_api_id,
created_at,
created_by,
enabled,
legacy,
modified_at,
modified_by
FROM cloudflare.aisearch.tokens
WHERE account_id = '{{ account_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND search = '{{ search }}'
;

INSERT examples

create

Create a new token.

INSERT INTO cloudflare.aisearch.tokens (
cf_api_id,
cf_api_key,
legacy,
name,
account_id
)
SELECT 
'{{ cf_api_id }}' /* required */,
'{{ cf_api_key }}' /* required */,
{{ legacy }},
'{{ name }}' /* required */,
'{{ account_id }}'
RETURNING
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: tokens
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the tokens resource.
  - name: cf_api_id
    value: "{{ cf_api_id }}"
  - name: cf_api_key
    value: "{{ cf_api_key }}"
  - name: legacy
    value: {{ legacy }}
    default: true
  - name: name
    value: "{{ name }}"

REPLACE examples

update

Update token.

REPLACE cloudflare.aisearch.tokens
SET 
cf_api_id = '{{ cf_api_id }}',
cf_api_key = '{{ cf_api_key }}',
legacy = {{ legacy }},
name = '{{ name }}'
WHERE 
account_id = '{{ account_id }}' --required
AND id = '{{ id }}' --required
AND name = '{{ name }}' --required
AND cf_api_id = '{{ cf_api_id }}' --required
AND cf_api_key = '{{ cf_api_key }}' --required
RETURNING
result,
success;

DELETE examples

delete

Delete token.

DELETE FROM cloudflare.aisearch.tokens
WHERE account_id = '{{ account_id }}' --required
AND id = '{{ id }}' --required
;