delegations

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

Overview

Name	delegations
Type	Resource
Id	cloudflare.addressing.delegations

Fields

The following fields are returned by SELECT queries:

list

List Prefix Delegations response

Name	Datatype	Description
id	string	Identifier of a Delegation. (example: d933b1530bc56c9953cf8ce166da8004)
delegated_account_id	string	Account identifier for the account to which prefix is being delegated. (example: b1946ac92492d2347c6235b4d2611184)
parent_prefix_id	string	Identifier of an IP Prefix. (example: 2af39739cc4e3b5910c918468bb89828)
cidr	string	IP Prefix in Classless Inter-Domain Routing format. (example: 192.0.2.0/24)
created_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
modified_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
list	select	prefix_id, account_id		List all delegations for a given account IP prefix.
create	insert	prefix_id, account_id, cidr, delegated_account_id		Create a new account delegation for a given IP prefix.
delete	delete	delegation_id, prefix_id, account_id		Delete an account delegation for a given IP prefix.

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.
delegation_id	string
prefix_id	string	The IP prefix ID.

SELECT examples

list

List all delegations for a given account IP prefix.

SELECT
id,
delegated_account_id,
parent_prefix_id,
cidr,
created_at,
modified_at
FROM cloudflare.addressing.delegations
WHERE prefix_id = '{{ prefix_id }}' -- required
AND account_id = '{{ account_id }}' -- required
;

INSERT examples

create

Create a new account delegation for a given IP prefix.

INSERT INTO cloudflare.addressing.delegations (
cidr,
delegated_account_id,
prefix_id,
account_id
)
SELECT 
'{{ cidr }}' /* required */,
'{{ delegated_account_id }}' /* required */,
'{{ prefix_id }}',
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: delegations
props:
  - name: prefix_id
    value: "{{ prefix_id }}"
    description: Required parameter for the delegations resource.
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the delegations resource.
  - name: cidr
    value: "{{ cidr }}"
    description: |
      IP Prefix in Classless Inter-Domain Routing format.
  - name: delegated_account_id
    value: "{{ delegated_account_id }}"
    description: |
      Account identifier for the account to which prefix is being delegated.

DELETE examples

delete

Delete an account delegation for a given IP prefix.

DELETE FROM cloudflare.addressing.delegations
WHERE delegation_id = '{{ delegation_id }}' --required
AND prefix_id = '{{ prefix_id }}' --required
AND account_id = '{{ account_id }}' --required
;