ambiser
/
ovh-api-bash-client
mirror of https://github.com/denouche/ovh-api-bash-client.git
9
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

pull/3/head
Antoine Leveugle 2014-04-17 21:31:01 +02:00
parent 928178c732
commit 0c1d719906
1 changed files with 23 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -6,14 +6,37 @@ A bash client for OVH API (https://api.ovh.com/)
Initialize Initialize
---------- ----------
### Create an OVH API Application
In order to create a new OVH API application, run: In order to create a new OVH API application, run:
``` ```
./ovhApiBashClient.sh --initApp ./ovhApiBashClient.sh --initApp
``` ```
### Create a Consumer Key
In order to create a new consumer key, run:
```
./ovhApiBashClient.sh --init
```
Options
-------
Possible arguments are:
```
--url <url> : the API URL to call, for example /domains (default is /me)
--method <method> : the HTTP method to use, for example POST (default is GET)
--data <JSON data> : the data body to send with the request
--init : to initialize the consumer key
--initApp : to initialize the API application
```
Usage Usage
----- -----
### Just some examples:
To make a basic call on GET /me just run: To make a basic call on GET /me just run:
``` ```
./ovhApiBashClient.sh ./ovhApiBashClient.sh
@ -29,15 +52,3 @@ To activate the monitoring on your dedicated server, run:
./ovhApiBashClient.sh --method PUT --url "/dedicated/server/ns00000.ovh.net" --data '{"monitoring": true}' ./ovhApiBashClient.sh --method PUT --url "/dedicated/server/ns00000.ovh.net" --data '{"monitoring": true}'
``` ```
Options
-------
Possible arguments are:
```
--url <url> : the API URL to call, for example /domains (default is /me)
--method <method> : the HTTP method to use, for example POST (default is GET)
--data <JSON data> : the data body to send with the request
--init : to initialize the consumer key
--initApp : to initialize the API application
```