Skip to main content

colos

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

Overview

Namecolos
TypeResource
Idcloudflare.zero_trust.colos

Fields

The following fields are returned by SELECT queries:

List colos response

NameDatatypeDescription
airportCodestringAirport code (example: SFO)
citystringCity (example: San Francisco)
countryCodestringCountry code (example: US)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectaccount_idfrom, to, sortByList Cloudflare colos that account's devices were connected to during a time period, sorted by usage starting from the most used colo. Colos without traffic are also returned and sorted alphabetically.

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.

NameDatatypeDescription
account_idstringThe Cloudflare account ID.
fromstringStart time for connection period in ISO (RFC3339 - ISO 8601) format
sortBystringType of usage that colos should be sorted by. If unspecified, returns all Cloudflare colos sorted alphabetically.
tostringEnd time for connection period in ISO (RFC3339 - ISO 8601) format

SELECT examples

List Cloudflare colos that account's devices were connected to during a time period, sorted by usage starting from the most used colo. Colos without traffic are also returned and sorted alphabetically.

SELECT
airportCode,
city,
countryCode
FROM cloudflare.zero_trust.colos
WHERE account_id = '{{ account_id }}' -- required
AND from = '{{ from }}'
AND to = '{{ to }}'
AND sortBy = '{{ sortBy }}'
;