Skip to content
This repository was archived by the owner on Nov 22, 2024. It is now read-only.

Commit 9893b45

Browse files
committed
Added info about X-Auth-User-Service-Key which is used by /certificates API call
1 parent 21025d1 commit 9893b45

1 file changed

Lines changed: 12 additions & 3 deletions

File tree

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
## Credit
55

6-
This is based on work by _gnowxilef_ found [here](https://github.com/cloudflare-api/python-cloudflare-v4). It has been seriously expanded upon.
6+
This is based on work by [Felix Wong (gnowxilef)](https://github.com/gnowxilef) found [here](https://github.com/cloudflare-api/python-cloudflare-v4). It has been seriously expanded upon.
77

88
## CloudFlare API version 4
99

@@ -12,9 +12,12 @@ The CloudFlare API can be found [here](https://api.cloudflare.com/). Each API ca
1212
## Installation
1313

1414
```
15-
./setup.py install
15+
./setup.py build
16+
sudo ./setup.py install
1617
```
1718

19+
Or whatever variance of that you want to use.
20+
1821
## Getting Started
1922

2023
A very simple listing of zones within your account; including the IPv6 status of the zone.
@@ -94,10 +97,13 @@ When you create a _CloudFlare_ class you can pass up to three paramaters.
9497

9598
If the account email and API key are not passed when you create the class, then they are retreived from either the users exported shell environment variables or the .cloudflare.cfg or ~/.cloudflare.cfg or ~/.cloudflare/cloudflare.cfg files, in that order.
9699

100+
There is one call that presently doesn't need any email or token certification (the */ips* call); hence you can test without any values saved away.
101+
97102
### Using shell environment variables
98103
```
99104
$ export CF_API_EMAIL='user@example.com'
100105
$ export CF_API_KEY='00000000000000000000000000000000'
106+
$ export CF_API_CERTKEY='v1.0-...'
101107
$
102108
```
103109

@@ -108,12 +114,15 @@ $ cat ~/.cloudflare/cloudflare.cfg
108114
[CloudFlare]
109115
email = user@example.com
110116
token = 00000000000000000000000000000000
117+
certoken = v1.0-...
111118
$
112119
```
113120

121+
The *CF_API_CERTKEY* or *certtoken* values are used for the Origin-CA */certificates* API calls.
122+
114123
## Included example code
115124

116-
The _examples_ folder contains many examples in both simple and verbose formats.
125+
The *examples* folder contains many examples in both simple and verbose formats.
117126

118127
## A DNS zone code example
119128

0 commit comments

Comments
 (0)