leases

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

Overview

Name	leases
Type	Resource
Id	cloudflare.addressing.leases

Fields

The following fields are returned by SELECT queries:

list

List Leases response

Name	Datatype	Description
id	string	Identifier for the lease (example: 8fee4b6fd361283a72381ccfda355471)
owner_id	string	Cloudflare account ID of the account owning the lease. (example: 3a7d3de1d0682240cf046c7f50866cc5)
active_from	string (date-time)	Timestamp of the moment the lease was created. (example: 2020-01-01T00:00:00Z)
cidrs	array	CIDRs attached to the lease
created_at	string (date-time)	Timestamp of the moment the object was created.
modified_at	string (date-time)	Timestamp of the moment the object was modified.
purpose	string	Describes the purpose of the addresses. (example: Spectrum Static IPs)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	account_id		List all leases owned by the 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	The Cloudflare account ID.

SELECT examples

list

List all leases owned by the account.

SELECT
id,
owner_id,
active_from,
cidrs,
created_at,
modified_at,
purpose
FROM cloudflare.addressing.leases
WHERE account_id = '{{ account_id }}' -- required
;