diff --git a/code/scripts/main/api/README.md b/code/scripts/main/api/README.md deleted file mode 100644 index 06a267e..0000000 --- a/code/scripts/main/api/README.md +++ /dev/null @@ -1,76 +0,0 @@ -### General - -For all get request, there are a possibility to pass a payloads with differents param in json -```code -{'key1': 'value1', 'key2': 'value2'} -``` - -All actions need a valid ticket. This ticket is generate when the client valid the connexion on the backend php. -it's saved in the database with an expiration key. -Each tickets are uniq. - -Example to dump database: -``` code -GET /api/v1/instance//database/ -d '{'userid': '1', 'ticket': 'SFQSF22dFF','action': 'dump'}' -``` - -##### Instance management -Actions limited to proxmox api (wrapper) -```code -GET /api/v1/instance -GET /api/v1/instance/ -POST /api/v1/instance/ -PUT /api/v1/instance/ -DELETE /api/v1/instance/ -``` - -##### Packages management -Actions in the instances for packages managements -```code -GET /api/v1/instance//package -POST /api/v1/instance//packages -PUT /api/v1/instance//packages -DELETE /api/v1/instance//package -``` - -##### vhosts management -Actions in the instances for packages managements -```code -GET /api/v1/instance//vhost -GET /api/v1/instance//vhost/ -POST /api/v1/instance//vhost/ -PUT /api/v1/instance//vhost/ -DELETE /api/v1/instance//vhost/ -``` - -##### Databases -Actions in the instances for packages managements -```code -GET /api/v1/instance//database -GET /api/v1/instance//database/ -POST /api/v1/instance//database/ -PUT /api/v1/instance//database/ -DELETE /api/v1/instance//database/ -``` - -##### Nodes management -Actions to proxmox nodes availables -```code -GET /api/v1/node -GET /api/v1/node/ -``` - -##### services management -```code -GET /api/v1/service/ssl/instance//vhost/ -GET /api/v1/service/ssl/instance//vhost/ -POST api/v1/service/ssl/instance//vhost/ -PUT /api/v1/service/ssl/instance//vhost/ -DELETE /api/v1/service/ssl/instance//vhost/ - -GET /api/v1/service/cache/instance//vhost/ -GET /api/v1/service/cache/instance//vhost/ -POST api/v1/service/cache/instance//vhost/ -PUT /api/v1/service/cache/instance//vhost/ -DELETE /api/v1/service/cache/instance//vhost/ -```