1CLI4(1)                     General Commands Manual                    CLI4(1)
2
3
4

NAME

6       cli4 - Command line access to CloudFlare v4 API
7
8

SYNOPSIS

10       cli4   [-V]   [-h|--help]   [-v|--verbose]   [-q|--quiet]   [-j|--json]
11       [-y|--yaml] [-n|--ndjson]  [item=value  ...]   [-G|--get]  [-P|--patch]
12       [-O|--post] [-U|--put] [-D|--delete] /command...
13
14

DESCRIPTION

16       cli4 provides command line access to CloudFlare v4 API
17
18

OPTIONS

20       [-V, --version]
21              Display program version number and exit.
22
23       [-h, --help]
24              This information (in a terse form).
25
26       [-v, --verbose]
27              Provide some protcol debugging information.
28
29       [-q, --quiet]
30              Don't output any JSON/YAML responses.
31
32       [-j, --json]
33              Output response data in JSON format (the default).
34
35       [-y, --yaml]
36              Output  response  data  in  YAML  format (if yaml package
37              installed).
38
39       [-n, --ndjson]
40              Output response data in NDJSON format (if jsonlines pack‐
41              age installed).
42
43       --get  Send HTTP request as a GET (the default).
44
45       --patch
46              Send HTTP request as a PATCH.
47
48       --post Send HTTP request as a POST.
49
50       --put  Send HTTP request as a PUT.
51
52       --delete
53              Send HTTP request as a DELETE.
54
55       item=value
56              Set  a paramater or data value to send with a GET, PATCH,
57              POST, PUT or DELETE command.  The  value  is  sent  as  a
58              string.
59
60       item:=value
61              Set  a paramater or data value to send with a GET, PATCH,
62              POST, PUT or DELETE command. The  value  is  sent  as  an
63              interger.
64
65       /command...
66              The  API command.  The command uses slash (/) to seperate
67              the verbs in the same way that the CloudFlare v4 API doc‐
68              umentation  does.   Any  verb  starting with colon (:) is
69              either converted to zone_id,  user_id,  organtization_id,
70              or otherwise.
71
72

RESULTS

74       The output is either JSON or YAML formatted.
75
76

EXAMPLES

78       cli4 /zones List infomation for all zones.
79
80       cli4 /zones/:example.com List specific zone info.
81
82       cli4  /zones/:example.com/settings  List settings for a specific
83       zone.
84
85       cli4      --delete      purge_everything=true      /zones/:exam‐
86       ple.com/purge_cache Purge cache for a specific zone.
87
88       cli4     --delete    files='[http://example.com/css/styles.css]'
89       /zones/:example.com/purge_cache Purge cache for a specific zone.
90
91       cli4                --delete                files='[http://exam‐
92       ple.com/css/styles.css,http://example.com/js/script.js]
93       /zones/:example.com/purge_cache Purge cache for a specific zone.
94
95       cli4     --delete     tags='[tag1,tag2,tag3]'      /zones/:exam‐
96       ple.com/purge_cache Purge cache for a specific zone.
97
98       cli4  /zones/:example.com/available_plans  List  available plans
99       for a zone.
100
101       cli4  --patch  status=active   /zones/:example.com/dnssec   Make
102       DNSSEC active for specfic zone.
103
104       cli4  /zones/:example.com/dnssec List DNSSEC infomation and sta‐
105       tus for a specific zone.
106
107

SEE ALSO

109       The CloudFlare API  can  be  found  https://api.cloudflare.com/.
110       Each  API call is provided via a similarly named function within
111       the CloudFlare class.
112
113
114
115                                                                       CLI4(1)