cloudflare_accounts

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

Overview

Name	cloudflare_accounts
Type	Resource
Id	datadog.integrations.cloudflare_accounts

Fields

The following fields are returned by SELECT queries:

get_cloudflare_account

Name	Datatype	Description
id	string	The ID of the Cloudflare account, a hash of the account name. (example: c1a8e059bfd1e911cf10b626340c9a54)
attributes	object	Attributes object of a Cloudflare account.
type	string	The JSON:API type for this API. Should always be cloudflare-accounts. (cloudflare-accounts) (default: cloudflare-accounts, example: cloudflare-accounts)

list_cloudflare_accounts

Name	Datatype	Description
id	string	The ID of the Cloudflare account, a hash of the account name. (example: c1a8e059bfd1e911cf10b626340c9a54)
attributes	object	Attributes object of a Cloudflare account.
type	string	The JSON:API type for this API. Should always be cloudflare-accounts. (cloudflare-accounts) (default: cloudflare-accounts, example: cloudflare-accounts)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_cloudflare_account	select	account_id		Get a Cloudflare account.
list_cloudflare_accounts	select			List Cloudflare accounts.
create_cloudflare_account	insert	data		Create a Cloudflare account.
update_cloudflare_account	update	account_id, data		Update a Cloudflare account.
delete_cloudflare_account	delete	account_id		Delete a Cloudflare account.

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	None
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.

SELECT examples

get_cloudflare_account

Get a Cloudflare account.

SELECT
id,
attributes,
type
FROM datadog.integrations.cloudflare_accounts
WHERE account_id = '{{ account_id }}' -- required
;

list_cloudflare_accounts

List Cloudflare accounts.

SELECT
id,
attributes,
type
FROM datadog.integrations.cloudflare_accounts
;

INSERT examples

create_cloudflare_account

Create a Cloudflare account.

INSERT INTO datadog.integrations.cloudflare_accounts (
data
)
SELECT 
'{{ data }}' /* required */
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: cloudflare_accounts
props:
  - name: data
    description: |
      Data object for creating a Cloudflare account.
    value:
      attributes:
        api_key: "{{ api_key }}"
        email: "{{ email }}"
        name: "{{ name }}"
        resources:
          - "{{ resources }}"
        zones:
          - "{{ zones }}"
      type: "{{ type }}"

UPDATE examples

update_cloudflare_account

Update a Cloudflare account.

UPDATE datadog.integrations.cloudflare_accounts
SET 
data = '{{ data }}'
WHERE 
account_id = '{{ account_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data;

DELETE examples

delete_cloudflare_account

Delete a Cloudflare account.

DELETE FROM datadog.integrations.cloudflare_accounts
WHERE account_id = '{{ account_id }}' --required
;