API: Add documentation for CRL endpoint

iake123 · Mar 2, 2017 · cdf03f4 · cdf03f4
1 parent 9ea4134
commit cdf03f4
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/doc/api/endpoint_crl.txt b/doc/api/endpoint_crl.txt
@@ -0,0 +1,18 @@
+THE CRL ENDPOINT
+
+Endpoint: /api/v1/cfssl/crl
+Method:   GET
+
+Optional URL Query parameters:
+
+    * expiry: a value, in seconds, after which the CRL should expire
+      from the moment of the request.
+
+Result:
+
+    The returned result is an empty JSON object
+
+Example:
+
+    $ curl ${CFSSL_HOST}/api/v1/cfssl/crl
+    $ curl ${CFSSL_HOST}/api/v1/cfssl/crl?expiry=7200h
diff --git a/doc/api/intro.txt b/doc/api/intro.txt
@@ -12,6 +12,7 @@ under the name `endpoint_<endpoint>`. These nine endpoints are:
 
       - authsign: authenticated signing endpoint
       - bundle: build certificate bundles
+      - crl: generates a CRL out of the certificate DB
       - info: obtain information about the CA, including the CA
         certificate
       - init_ca: initialise a new certificate authority