Merge pull request #305 from dpuckett98/patch-2

Update to REST API documentation

Author: jmccormick2001

hugo/content/installation/configuration.adoc

@@ -443,41 +443,144 @@ su - $USER
 Because the *apiserver* implements a REST API, it is possible to integrate with it using your own
 application code. To demonstrate this, the following *curl* commands show the API usage -
 
+Note: Some setups may require the user to add '?version=x.x' to the end of the commands.
+
 *pgo version*
 ....
 curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/version
 ....
 
-*pgo show policy all*
+*pgo show policy <name>*
+....
+curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/policies/<name>
+....
+
+*pgo delete policy <name>*
+....
+curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/policiesdelete/<name>
+....
+
+*pgo show pvc <name>*
+....
+curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/pvc/<name>
+....
+
+*pgo apply policy <name>*
+....
+curl -v -X POST -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/policies/apply/<name>
+....
+
+*pgo show ingest <name>*
+....
+curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/ingest/<name>
+....
+
+*pgo label*
+....
+curl -v -X POST -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/label
+....
+
+*pgo load*
+....
+curl -v -X POST -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/load
+....
+
+*pgo user*
+....
+curl -v -X POST -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/user
+....
+
+*pgo users <name>*
+....
+curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/users/<name>
+....
+
+*pgo delete user <name>*
+....
+curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/usersdelete/<name>
+....
+
+*pgo show upgrade <name>*
 ....
-curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/policies/all
+curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/upgrades/<name>
 ....
 
-*pgo show pvc danger*
+*pgo delete upgrade <name>*
 ....
-curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/pvc/danger
+curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/upgradesdelete/<name>
 ....
 
-*pgo show cluster mycluster*
+*pgo show cluster <name>*
 ....
-curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/clusters/mycluster
+curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/clusters/<name>
 ....
 
-*pgo show upgrade mycluster*
+*pgo delete cluster*
 ....
-curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/upgrades/mycluster
+curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/clustersdelete/<name>
 ....
 
-*pgo test mycluster*
+*pgo test <name>*
 ....
-curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/clusters/test/mycluster
+curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/clusters/test/<name>
 ....
 
-*pgo show backup mycluster*
+*pgo scale <name>*
 ....
-curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/backups/mycluster
+curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/clusters/scale/<name>
 ....
 
+*pgo scale <name>*
+....
+curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/scale/<name>
+....
+
+*pgo scaledown <name>*
+....
+curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/scaledown/<name>
+....
+
+*pgo status*
+....
+curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/status
+....
+
+*pgo df <name>*
+....
+curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/df/<name>
+....
+
+*pgo config*
+....
+curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/config
+....
+
+*pgo show backup <name>*
+....
+curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/backups/<name>
+....
+
+*pgo delete backup <name>*
+....
+curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/backupsdelete/<name>
+....
+
+*pgo backrest <name>*
+....
+curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/backrest/<name>
+....
+
+*pgo reload*
+....
+curl -v -X POST -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/reload
+....
+
+*pgo failover <name>*
+....
+curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/failover/<name>
+....
+
+
 == Deploying pgpool
 
 One option with pgo is enabling the creation of a pgpool deployment in addition to the PostgreSQL cluster.