colos
Creates, updates, deletes, gets or lists a colos resource.
Overview
| Name | colos |
| Type | Resource |
| Id | cloudflare.zero_trust.colos |
Fields
The following fields are returned by SELECT queries:
- list
List colos response
| Name | Datatype | Description |
|---|---|---|
airportCode | string | Airport code (example: SFO) |
city | string | City (example: San Francisco) |
countryCode | string | Country code (example: US) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | account_id | from, to, sortBy | 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. |
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. |
from | string | Start time for connection period in ISO (RFC3339 - ISO 8601) format |
sortBy | string | Type of usage that colos should be sorted by. If unspecified, returns all Cloudflare colos sorted alphabetically. |
to | string | End time for connection period in ISO (RFC3339 - ISO 8601) format |
SELECT examples
- list
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 }}'
;