Installing OSC CLI
|Before you begin: You need to install Python 3.5 or later on your machine. For more information, see the official Python website.|
To install from the official PyPI package, launch the following command in your terminal:
To install from source, see official OSC CLI repository.
Configuring OSC CLI
Create the file
~/.osc_sdk/config.jsonwith the following content:
secret_keyvalues empty at this stage.
To get your access key ID and corresponding secret key, use the ListAccessKeys command following this syntax:
This command contains the following attributes that you need to specify:
authentication-method: For this first call, this attribute must be
login: The email address of your 3DS OUTSCALE account.
password: The password of your 3DS OUTSCALE account.
The ListAccessKeys command returns several elements, including the following:
accessKeyId: The ID of the access key.
secretAccessKey: The secret key corresponding to the access key.
- Insert the values of your access key ID and corresponding secret key in the
You can now execute any API call using OSC CLI.
Using OSC CLI
To send a request using OSC CLI, specify in your command:
- One of the supported APIs (
apifor the 3DS OUTSCALE API, or
- The call you request.
- Any other attribute required by the command.
If you need to pass a numeral string instead of an integer (for example:
"12345678" with the quotes as part of the string), you must wrap your string in additional quotes (