README.md 844 Bytes
Newer Older
Mark Tearle's avatar
Mark Tearle committed
1 2
# quovadis

Mark Tearle's avatar
Mark Tearle committed
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
REST API to assist with ACME challenges

## API

### Documentation

GET / 

### Register User

POST /register

Params:
* UCC username

Will email to your UCC email address an API key to use with the service

### Update API key

POST /update-api-key

Params:
* UCC username
* Old API key
* New API key

Will update API key

Will email to your UCC email address noting that the API key has been updated

### Update Challenge

POST /update-challenge

Params:

* UCC username
* API key
* Challenge Handle
* Challenge TXT

Will update the DNS TXT record at 

<ucc username>-<challenge handle>.quovadis.ucc.asn.au 

to the contents of Challenge TXT


## Use

This is intended to be used with the certbot hook scripts included alongside this code

register-apikey.sh

certbot-hook-quovadis.sh


## Author

Mark Tearle <[email protected]>