1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
.TH CLI4 1
.SH NAME
cli4 \- Command line access to Cloudflare v4 API
.SH SYNOPSIS
.B cli4
[\fB\-V\fR|\fB\-\-version]
[\fB\-h\fR|\fB\-\-help]
[\fB\-v\fR|\fB\-\-verbose]
[\fB\-e\fR|\fB\-\-examples]
[\fB\-q\fR|\fB\-\-quiet]
[\fB\-j\fR|\fB\-\-json]
[\fB\-y\fR|\fB\-\-yaml]
[\fB\-n\fR|\fB\-\-ndjson]
[\fB\-r\fR|\fB\-\-raw]
[\fB\ir\fR|\fB\-\-image]
[\fB\-d\fR|\fB\-\-dump]
[\fB\-b\fR|\fB\-\-binary]
[\fB\-A openapi-url\fR|\fB\-\-openapi openapi-url]
[\fB\-p profile-name\fR|\fB\-\-profile profile-name]
[\fBitem\fR=\fIvalue\fR ...]
[=\fIvalue\fR ...]
[\fBitem\fR=@\fIfilename\fR ...]
[=@\fIfilename\fR ...]
[\fB\-G\fR|\fB\-\-get]
[\fB\-P\fR|\fB\-\-patch]
[\fB\-O\fR|\fB\-\-post]
[\fB\-U\fR|\fB\-\-put]
[\fB\-D\fR|\fB\-\-delete]
.IR /command ...
.SH DESCRIPTION
.B cli4
provides command line access to Cloudflare v4 API
.SH OPTIONS
.TP
.IP "[\-V, \-\-version]"
Display program version number and exit.
.IP "[\-h, \-\-help]"
This information (in a terse form).
.IP "[\-v, \-\-verbose]"
Provide some protcol debugging information.
.IP "[\-e, \-\-example]"
Show the path to the examples folder/directory.
.IP "[\-q, \-\-quiet]"
Don't output any JSON/YAML responses.
.IP "[\-j, \-\-json]"
Output response data in JSON format (the default).
.IP "[\-y, \-\-yaml]"
Output response data in YAML format (if yaml package installed).
.IP "[\-n, \-\-ndjson]"
Output response data in NDJSON format (if jsonlines package installed).
.IP "[\-r, \-\-raw]"
Output JSON results in raw mode without splitting out the errors and results.
.IP "[\-i, \-\-image]"
Output results as binary (i.e. it's an image).
This isn't normally needed as the API returns a Content-Type to indicate an image is being returned.
This option can be used to allow the API output to be output without any processing (i.e. JSON formatted).
.IP "[\-d, \-\-dump]"
Output a list of all API calls included in the code.
.IP "[\-b, \-\-binary]"
Open files in binary mode.
.IP "[-A \fIopenapi-url\fR, \-\-openapi \fIopenapi-url\fR]"
Decode Cloudflare's OpenAPI spec and output all the known commands.
.IP "[-p \fIprofile-name\fR, \-\-profile \fIprofile-name\fR]"
Select a \fIprofile-name\fR from the configuration file (hence select custom \fIemail\fR/\fItoken\fR values).
.IP "\-\-get"
Send HTTP request as a \fBGET\fR (the default).
.IP "\-\-patch"
Send HTTP request as a \fBPATCH\fR.
.IP "\-\-post"
Send HTTP request as a \fBPOST\fR.
.IP "\-\-put"
Send HTTP request as a \fBPUT\fR.
.IP "\-\-delete"
Send HTTP request as a \fBDELETE\fR.
.IP "item=\fIvalue\fR"
Set a paramater or data value to send with a \fBGET\fR, \fBPATCH\fR, \fBPOST\fR, \fBPUT\fR or \fBDELETE\fR command. The value is sent as a string.
.IP item:=\fIvalue\fR
Set a paramater or data value to send with a \fBGET\fR, \fBPATCH\fR, \fBPOST\fR, \fBPUT\fR or \fBDELETE\fR command. The value is sent as an interger.
.IP item=@\fIfilename\fR
Set a paramater or data value to send with a \fBPOST\fR or \fBPUT\fR command. The value is based on the content of the file.
.IP "\fI/command ...\fR"
The API command(s) to execute.
.SH COMMAND(S)
The command string uses slash (\fB/\fR) to seperate the verbs in the same way that the Cloudflare v4 API documentation does.
Any verb starting with colon (\fB:\fR) is either converted to zone_id, user_id, organtization_id, or otherwise.
Any verb starting with coloe (\fB:\fR) and followed by 32 hex chracters is passed thru raw.
Any verb starting with two colons (\fB::\fR) is passed thru raw.
.SH RESULTS
The output is either JSON or YAML formatted.
.SH EXAMPLES
.B cli4 /zones
List infomation for all zones.
.B cli4 /zones/:example.com
List specific zone info.
.B cli4 /zones/:example.com/settings
List settings for a specific zone.
.B cli4 --delete purge_everything=true /zones/:example.com/purge_cache
Purge cache for a specific zone.
.B cli4 --delete files='[http://example.com/css/styles.css]' /zones/:example.com/purge_cache
Purge cache for a specific zone.
.B cli4 --delete files='[http://example.com/css/styles.css,http://example.com/js/script.js] /zones/:example.com/purge_cache
Purge cache for a specific zone.
.B cli4 --delete tags='[tag1,tag2,tag3]' /zones/:example.com/purge_cache
Purge cache for a specific zone.
.B cli4 /zones/:example.com/available_plans
List available plans for a zone.
.B cli4 --patch status=active /zones/:example.com/dnssec
Make DNSSEC active for specfic zone.
.B cli4 /zones/:example.com/dnssec
List DNSSEC infomation and status for a specific zone.
.SH SEE ALSO
The Cloudflare API can be found https://api.cloudflare.com/. Each API call is provided via a similarly named function within the Cloudflare class.
|
