Update README.md
parent
928178c732
commit
0c1d719906
35
README.md
35
README.md
|
@ -6,14 +6,37 @@ A bash client for OVH API (https://api.ovh.com/)
|
|||
Initialize
|
||||
----------
|
||||
|
||||
### Create an OVH API Application
|
||||
|
||||
In order to create a new OVH API application, run:
|
||||
```
|
||||
./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
|
||||
-----
|
||||
|
||||
### Just some examples:
|
||||
|
||||
To make a basic call on GET /me just run:
|
||||
```
|
||||
./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}'
|
||||
```
|
||||
|
||||
|
||||
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
|
||||
```
|
||||
|
|
Loading…
Reference in New Issue