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
ovh-api-bash-client/README.md

90 lines
1.9 KiB
Markdown
Raw Normal View History

doc: fix readme title
2017-06-21 14:47:55 +02:00
OVH API Bash client
Create README.md
2014-04-17 20:13:09 +02:00
================
A bash client for OVH API (https://api.ovh.com/)
Initialize
----------
Update README.md
2014-04-17 22:17:09 +02:00
### Retrieve dependency
Update README.md
2014-04-17 22:17:44 +02:00
First in order to retrieve needed dependency, run:
Bash coding style review - functions: use lower case local variables - set some configuration variables as constant - review some variables naming - test command: use built-in [[ instead of [ - always keep if+then in the same line - change shebang for portability Enhancements - API headers: use OVH API's timestamp instead of user's one to bypass misconfigured host. - simplify valid target check - use API_URL when target is set - help output rework - refresh README
2018-08-26 13:08:27 +02:00
Update README.md
2014-04-17 22:17:09 +02:00
```
Bash coding style review - functions: use lower case local variables - set some configuration variables as constant - review some variables naming - test command: use built-in [[ instead of [ - always keep if+then in the same line - change shebang for portability Enhancements - API headers: use OVH API's timestamp instead of user's one to bypass misconfigured host. - simplify valid target check - use API_URL when target is set - help output rework - refresh README
2018-08-26 13:08:27 +02:00
make
Update README.md
2014-04-17 22:17:09 +02:00
```
Update README.md
2014-04-17 21:31:01 +02:00
### Create an OVH API Application
Update README.md
2014-04-17 21:28:03 +02:00
In order to create a new OVH API application, run:
Bash coding style review - functions: use lower case local variables - set some configuration variables as constant - review some variables naming - test command: use built-in [[ instead of [ - always keep if+then in the same line - change shebang for portability Enhancements - API headers: use OVH API's timestamp instead of user's one to bypass misconfigured host. - simplify valid target check - use API_URL when target is set - help output rework - refresh README
2018-08-26 13:08:27 +02:00
Update README.md
2014-04-17 20:16:30 +02:00
```
Bash coding style review - functions: use lower case local variables - set some configuration variables as constant - review some variables naming - test command: use built-in [[ instead of [ - always keep if+then in the same line - change shebang for portability Enhancements - API headers: use OVH API's timestamp instead of user's one to bypass misconfigured host. - simplify valid target check - use API_URL when target is set - help output rework - refresh README
2018-08-26 13:08:27 +02:00
./ovh-api-bash-client.sh --initApp
Update README.md
2014-04-17 20:16:30 +02:00
```
Create README.md
2014-04-17 20:13:09 +02:00
Update README.md
2014-04-17 21:31:01 +02:00
### Create a Consumer Key
In order to create a new consumer key, run:
```
Bash coding style review - functions: use lower case local variables - set some configuration variables as constant - review some variables naming - test command: use built-in [[ instead of [ - always keep if+then in the same line - change shebang for portability Enhancements - API headers: use OVH API's timestamp instead of user's one to bypass misconfigured host. - simplify valid target check - use API_URL when target is set - help output rework - refresh README
2018-08-26 13:08:27 +02:00
./ovh-api-bash-client.sh --init
Update README.md
2014-04-17 21:31:01 +02:00
```
Options
-------
Allow multiple API keys management with profiles - add --profile to override default configuration location - add --list-profile to display available profiles - rework messages to display command with the current profile if set Bugfix - ensure OVH App Key an App Secret are defined when creating consumer key Enhancements - when using --init, allow override default "all permissions grants" if --data is set - add -h/--help
2017-06-13 18:06:41 +02:00
### Show help
Bash coding style review - functions: use lower case local variables - set some configuration variables as constant - review some variables naming - test command: use built-in [[ instead of [ - always keep if+then in the same line - change shebang for portability Enhancements - API headers: use OVH API's timestamp instead of user's one to bypass misconfigured host. - simplify valid target check - use API_URL when target is set - help output rework - refresh README
2018-08-26 13:08:27 +02:00
Allow multiple API keys management with profiles - add --profile to override default configuration location - add --list-profile to display available profiles - rework messages to display command with the current profile if set Bugfix - ensure OVH App Key an App Secret are defined when creating consumer key Enhancements - when using --init, allow override default "all permissions grants" if --data is set - add -h/--help
2017-06-13 18:06:41 +02:00
```
Bash coding style review - functions: use lower case local variables - set some configuration variables as constant - review some variables naming - test command: use built-in [[ instead of [ - always keep if+then in the same line - change shebang for portability Enhancements - API headers: use OVH API's timestamp instead of user's one to bypass misconfigured host. - simplify valid target check - use API_URL when target is set - help output rework - refresh README
2018-08-26 13:08:27 +02:00
./ovh-api-bash-client.sh --help
Allow multiple API keys management with profiles - add --profile to override default configuration location - add --list-profile to display available profiles - rework messages to display command with the current profile if set Bugfix - ensure OVH App Key an App Secret are defined when creating consumer key Enhancements - when using --init, allow override default "all permissions grants" if --data is set - add -h/--help
2017-06-13 18:06:41 +02:00
```
Update README.md
2014-04-17 21:31:01 +02:00
Possible arguments are:
Bash coding style review - functions: use lower case local variables - set some configuration variables as constant - review some variables naming - test command: use built-in [[ instead of [ - always keep if+then in the same line - change shebang for portability Enhancements - API headers: use OVH API's timestamp instead of user's one to bypass misconfigured host. - simplify valid target check - use API_URL when target is set - help output rework - refresh README
2018-08-26 13:08:27 +02:00
Update README.md
2014-04-17 21:31:01 +02:00
```
if --profile is set to 'default', load configuration from script directory
2017-06-19 18:36:33 +02:00
--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
Bash coding style review - functions: use lower case local variables - set some configuration variables as constant - review some variables naming - test command: use built-in [[ instead of [ - always keep if+then in the same line - change shebang for portability Enhancements - API headers: use OVH API's timestamp instead of user's one to bypass misconfigured host. - simplify valid target check - use API_URL when target is set - help output rework - refresh README
2018-08-26 13:08:27 +02:00
--target <target> : the target API [CA|EU|US] (default is EU)
move profiles to user home
2018-02-20 17:12:34 +01:00
--init : to initialize the consumer key, and manage custom access rules file
if --profile is set to 'default', load configuration from script directory
2017-06-19 18:36:33 +02:00
--initApp : to initialize the API application
move profiles to user home
2018-02-20 17:12:34 +01:00
--list-profile : list available profiles in ~/.ovh-api-bash-client/profile directory
Bash coding style review - functions: use lower case local variables - set some configuration variables as constant - review some variables naming - test command: use built-in [[ instead of [ - always keep if+then in the same line - change shebang for portability Enhancements - API headers: use OVH API's timestamp instead of user's one to bypass misconfigured host. - simplify valid target check - use API_URL when target is set - help output rework - refresh README
2018-08-26 13:08:27 +02:00
--profile <profile>
move profiles to user home
2018-02-20 17:12:34 +01:00
* default : from ~/.ovh-api-bash-client/profile directory
* <dir> : from ~/.ovh-api-bash-client/profile/<dir> directory
Update README.md
2014-04-17 21:31:01 +02:00
```
Create README.md
2014-04-17 20:13:09 +02:00
Usage
-----
Update README.md
2014-04-17 21:31:01 +02:00
### Just some examples:
Bash coding style review - functions: use lower case local variables - set some configuration variables as constant - review some variables naming - test command: use built-in [[ instead of [ - always keep if+then in the same line - change shebang for portability Enhancements - API headers: use OVH API's timestamp instead of user's one to bypass misconfigured host. - simplify valid target check - use API_URL when target is set - help output rework - refresh README
2018-08-26 13:08:27 +02:00
To make a basic call on GET `/me` just run:
Update README.md
2014-04-17 20:16:30 +02:00
```
Bash coding style review - functions: use lower case local variables - set some configuration variables as constant - review some variables naming - test command: use built-in [[ instead of [ - always keep if+then in the same line - change shebang for portability Enhancements - API headers: use OVH API's timestamp instead of user's one to bypass misconfigured host. - simplify valid target check - use API_URL when target is set - help output rework - refresh README
2018-08-26 13:08:27 +02:00
./ovh-api-bash-client.sh
Update README.md
2014-04-17 20:16:30 +02:00
```
Create README.md
2014-04-17 20:13:09 +02:00
Update README.md
2014-04-17 21:28:03 +02:00
To retrieve your domain list, run:
Bash coding style review - functions: use lower case local variables - set some configuration variables as constant - review some variables naming - test command: use built-in [[ instead of [ - always keep if+then in the same line - change shebang for portability Enhancements - API headers: use OVH API's timestamp instead of user's one to bypass misconfigured host. - simplify valid target check - use API_URL when target is set - help output rework - refresh README
2018-08-26 13:08:27 +02:00
Update README.md
2014-04-17 21:28:03 +02:00
```
Bash coding style review - functions: use lower case local variables - set some configuration variables as constant - review some variables naming - test command: use built-in [[ instead of [ - always keep if+then in the same line - change shebang for portability Enhancements - API headers: use OVH API's timestamp instead of user's one to bypass misconfigured host. - simplify valid target check - use API_URL when target is set - help output rework - refresh README
2018-08-26 13:08:27 +02:00
./ovh-api-bash-client.sh --url "/domain"
Update README.md
2014-04-17 21:28:03 +02:00
```
To activate the monitoring on your dedicated server, run:
Bash coding style review - functions: use lower case local variables - set some configuration variables as constant - review some variables naming - test command: use built-in [[ instead of [ - always keep if+then in the same line - change shebang for portability Enhancements - API headers: use OVH API's timestamp instead of user's one to bypass misconfigured host. - simplify valid target check - use API_URL when target is set - help output rework - refresh README
2018-08-26 13:08:27 +02:00
Update README.md
2014-04-17 21:28:03 +02:00
```
Bash coding style review - functions: use lower case local variables - set some configuration variables as constant - review some variables naming - test command: use built-in [[ instead of [ - always keep if+then in the same line - change shebang for portability Enhancements - API headers: use OVH API's timestamp instead of user's one to bypass misconfigured host. - simplify valid target check - use API_URL when target is set - help output rework - refresh README
2018-08-26 13:08:27 +02:00
./ovh-api-bash-client.sh --method PUT --url "/dedicated/server/ns00000.ovh.net" --data '{"monitoring": true}'
Update README.md
2014-04-17 21:28:03 +02:00
```
profiles management enhancements - when launching --init/--initApp, create the defined profile if missing - fix profiles listing (bad directory) - help command : always add --profile argument if profile name is defined
2017-06-21 14:31:13 +02:00
To create a Consumer key for different account or usage (profile is created if missing)
Bash coding style review - functions: use lower case local variables - set some configuration variables as constant - review some variables naming - test command: use built-in [[ instead of [ - always keep if+then in the same line - change shebang for portability Enhancements - API headers: use OVH API's timestamp instead of user's one to bypass misconfigured host. - simplify valid target check - use API_URL when target is set - help output rework - refresh README
2018-08-26 13:08:27 +02:00
Allow multiple API keys management with profiles - add --profile to override default configuration location - add --list-profile to display available profiles - rework messages to display command with the current profile if set Bugfix - ensure OVH App Key an App Secret are defined when creating consumer key Enhancements - when using --init, allow override default "all permissions grants" if --data is set - add -h/--help
2017-06-13 18:06:41 +02:00
```
Bash coding style review - functions: use lower case local variables - set some configuration variables as constant - review some variables naming - test command: use built-in [[ instead of [ - always keep if+then in the same line - change shebang for portability Enhancements - API headers: use OVH API's timestamp instead of user's one to bypass misconfigured host. - simplify valid target check - use API_URL when target is set - help output rework - refresh README
2018-08-26 13:08:27 +02:00
./ovh-api-bash-client.sh --profile demo1 --init
./ovh-api-bash-client.sh --profile demo2 --init
Allow multiple API keys management with profiles - add --profile to override default configuration location - add --list-profile to display available profiles - rework messages to display command with the current profile if set Bugfix - ensure OVH App Key an App Secret are defined when creating consumer key Enhancements - when using --init, allow override default "all permissions grants" if --data is set - add -h/--help
2017-06-13 18:06:41 +02:00
```
add wrapper for using ovh-api-bash-client with external scripts
2017-06-30 18:57:05 +02:00
Embedded lib for external scripts
JSON functions improvements - single execution of JSON.sh, now read result from a cache - JSON wrapper now use AWK for best performances, even on big JSON source - remove JSON string argument from getJSON*() functions - move JSON functions to a standalone file - add JSONSHLIB_DEBUG variable - add JSONSH_DIR to override JSON.sh path - update samples scripts - rework file tree - update README - update .gitignore
2017-07-14 01:09:28 +02:00
---------------------------------
add wrapper for using ovh-api-bash-client with external scripts
2017-06-30 18:57:05 +02:00
JSON functions improvements - single execution of JSON.sh, now read result from a cache - JSON wrapper now use AWK for best performances, even on big JSON source - remove JSON string argument from getJSON*() functions - move JSON functions to a standalone file - add JSONSHLIB_DEBUG variable - add JSONSH_DIR to override JSON.sh path - update samples scripts - rework file tree - update README - update .gitignore
2017-07-14 01:09:28 +02:00
See **contrib/** directory