ownership

Creates, updates, deletes, gets or lists an ownership resource.

Overview

Name	ownership
Type	Resource
Id	cloudflare.magic_transit.ownership

Fields

The following fields are returned by SELECT queries:

list

List PCAPs Bucket Ownership response.

Name	Datatype	Description
id	string	The bucket ID associated with the packet captures API. (example: 9883874ecac311ec8475433579a6bf5f)
destination_conf	string	The full URI for the bucket. This field only applies to full packet captures. (example: s3://pcaps-bucket?region=us-east-1)
filename	string	The ownership challenge filename stored in the bucket. (example: ownership-challenge-9883874ecac311ec8475433579a6bf5f.txt)
status	string	The status of the ownership challenge. Can be pending, success or failed. (pending, success, failed) (example: success)
submitted	string	The RFC 3339 timestamp when the bucket was added to packet captures API. (example: 2020-01-01T08:00:00Z)
validated	string	The RFC 3339 timestamp when the bucket was validated. (example: 2020-01-01T08:00:00Z)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	account_id		List all buckets configured for use with PCAPs API.
delete	delete	ownership_id, account_id		Deletes buckets added to the packet captures API.
validate	exec	account_id, destination_conf, ownership_challenge		Validates buckets added to the packet captures API.

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

SELECT examples

list

List all buckets configured for use with PCAPs API.

SELECT
id,
destination_conf,
filename,
status,
submitted,
validated
FROM cloudflare.magic_transit.ownership
WHERE account_id = '{{ account_id }}' -- required
;

DELETE examples

delete

Deletes buckets added to the packet captures API.

DELETE FROM cloudflare.magic_transit.ownership
WHERE ownership_id = '{{ ownership_id }}' --required
AND account_id = '{{ account_id }}' --required
;

Lifecycle Methods

validate

Validates buckets added to the packet captures API.

EXEC cloudflare.magic_transit.ownership.validate 
@account_id='{{ account_id }}' --required 
@@json=
'{
"destination_conf": "{{ destination_conf }}", 
"ownership_challenge": "{{ ownership_challenge }}"
}'
;