bookmarks

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

Overview

Name	bookmarks
Type	Resource
Id	cloudflare.zero_trust.bookmarks

Fields

The following fields are returned by SELECT queries:

get

Get a Bookmark application response

Name	Datatype	Description
id	string	The unique identifier for the Bookmark application.
name	string	The name of the Bookmark application. (example: My Website)
app_launcher_visible	boolean	Displays the application in the App Launcher.
created_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
domain	string	The domain of the Bookmark application. (example: example.com)
logo_url	string	The image URL for the logo shown in the App Launcher dashboard. (example: https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg)
updated_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)

list

List Bookmark applications response

Name	Datatype	Description
id	string	The unique identifier for the Bookmark application.
name	string	The name of the Bookmark application. (example: My Website)
app_launcher_visible	boolean	Displays the application in the App Launcher.
created_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
domain	string	The domain of the Bookmark application. (example: example.com)
logo_url	string	The image URL for the logo shown in the App Launcher dashboard. (example: https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg)
updated_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	bookmark_id, account_id		Fetches a single Bookmark application.
list	select	account_id		Lists Bookmark applications.
create	insert	bookmark_id, account_id		Create a new Bookmark application.
update	replace	bookmark_id, account_id		Updates a configured Bookmark application.
delete	delete	bookmark_id, account_id		Deletes a Bookmark application.

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.
bookmark_id	string

SELECT examples

get

Fetches a single Bookmark application.

SELECT
id,
name,
app_launcher_visible,
created_at,
domain,
logo_url,
updated_at
FROM cloudflare.zero_trust.bookmarks
WHERE bookmark_id = '{{ bookmark_id }}' -- required
AND account_id = '{{ account_id }}' -- required
;

list

Lists Bookmark applications.

SELECT
id,
name,
app_launcher_visible,
created_at,
domain,
logo_url,
updated_at
FROM cloudflare.zero_trust.bookmarks
WHERE account_id = '{{ account_id }}' -- required
;

INSERT examples

create

Create a new Bookmark application.

INSERT INTO cloudflare.zero_trust.bookmarks (
bookmark_id,
account_id
)
SELECT 
'{{ bookmark_id }}',
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: bookmarks
props:
  - name: bookmark_id
    value: "{{ bookmark_id }}"
    description: Required parameter for the bookmarks resource.
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the bookmarks resource.

REPLACE examples

update

Updates a configured Bookmark application.

REPLACE cloudflare.zero_trust.bookmarks
SET 
-- No updatable properties
WHERE 
bookmark_id = '{{ bookmark_id }}' --required
AND account_id = '{{ account_id }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Deletes a Bookmark application.

DELETE FROM cloudflare.zero_trust.bookmarks
WHERE bookmark_id = '{{ bookmark_id }}' --required
AND account_id = '{{ account_id }}' --required
;