python-ovh - Man Page

Name

python-ovh ā€” Python-OVH Documentation

Thin wrapper around OVH's APIs. Handles all the hard work including credential creation and requests signing.

# -*- encoding: utf-8 -*-

import ovh

# Instantiate. Visit https://api.ovh.com/createToken/index.cgi?GET=/me
# to get your credentials
client = ovh.Client(
    endpoint='ovh-eu',
    application_key='<application key>',
    application_secret='<application secret>',
    consumer_key='<consumer key>',
)

# Print nice welcome message
print("Welcome", client.get('/me')['firstname'])

The easiest way to get the latest stable release is to grab it from pypi using pip.

pip install ovh

Alternatively, you may get latest development version directly from Git.

pip install -e git+https://github.com/ovh/python-ovh.git#egg=ovh

Client Module

Constructor

__init__

High level helpers

request_consumerkey

Helpers to generate a consumer key. See new_consumer_key_request below for a full working example or ConsumerKeyRequest for detailed implementation.

The basic idea of ConsumerKeyRequest is to generate appropriate authorization requests from human readable function calls. In short: use it!

get/post/put/delete

Shortcuts around Client.call(). This is the recommended way to use the wrapper.

For example, requesting the list of all bills would look like:

bills = client.get('/me/bills')

In a similar fashion, enabling network burst on a specific server would look like:

client.put('/dedicated/server/%s/burst' % server_name, status='active')
param str target

Rest Method as shown in API's console.

param boolean need_auth

When False, bypass the signature process. This is interesting when calling authentication related method. Defaults to True

param dict kwargs

(Client.post() and Client.put() only) all extra keyword arguments are passed as data dict to call. This is a syntaxic sugar to call API entrypoints using a regular method syntax.

Low level API

call

time_delta

Config Module

Methods

__init__

get

Globals

Client Module

Constructor

__init__

Helpers

Generate rules

Trigger request

Exceptions Module

Use the API on Behalf of a User

1. Create an application

To interact with the APIs, the SDK needs to identify itself using an application_key and an application_secret. To get them, you need to register your application. Depending the API you plan yo use, visit:

  • OVH Europe
  • OVH North-America

Once created, you will obtain an application key (AK) and an application secret (AS).

2. Configure your application

The easiest and safest way to use your application's credentials is create an ovh.conf configuration file in application's working directory. Here is how it looks like:

[default]
; general configuration: default endpoint
endpoint=ovh-eu

[ovh-eu]
; configuration specific to 'ovh-eu' endpoint
application_key=my_app_key
application_secret=my_application_secret
; uncomment following line when writing a script application
; with a single consumer key.
;consumer_key=my_consumer_key

Depending on the API you want to use, you may set the endpoint to:

  • ovh-eu for OVH Europe API
  • ovh-ca for OVH North-America API

See Configuration for more informations on available configuration mechanisms.

NOTE:

When using a versioning system, make sure to add ovh.conf to ignored files. It contains confidential/security-sensitive information!

3. Authorize your application to access a customer account

To allow your application to access a customer account using the API on your behalf, you need a consumer key (CK).

# -*- encoding: utf-8 -*-

try:
    input = raw_input
except NameError:
    pass

import ovh

# create a client using configuration
client = ovh.Client()

# Request RO, /me API access
access_rules = [
    {'method': 'GET', 'path': '/me'},
]

# Request token
validation = client.request_consumerkey(access_rules)

print("Please visit %s to authenticate" % validation['validationUrl'])
input("and press Enter to continue...")

# Print nice welcome message
print("Welcome", client.get('/me')['firstname'])
print("Btw, your 'consumerKey' is '%s'" % validation['consumerKey'])

Returned consumerKey should then be kept to avoid re-authenticating your end-user on each use.

NOTE:

To request full and unlimited access to the API, you may use wildcards:

access_rules = [
    {'method': 'GET', 'path': '/*'},
    {'method': 'POST', 'path': '/*'},
    {'method': 'PUT', 'path': '/*'},
    {'method': 'DELETE', 'path': '/*'}
]

Install a New Mail Redirection

e-mail redirections may be freely configured on domains and DNS zones hosted by OVH to an arbitrary destination e-mail using API call POST /email/domain/{domain}/redirection.

For this call, the api specifies that the source address shall be given under the from keyword. Which is a problem as this is also a reserved Python keyword. In this case, simply prefix it with a '_', the wrapper will automatically detect it as being a prefixed reserved keyword and will substitute it. Such aliasing is only supported with reserved keywords.

# -*- encoding: utf-8 -*-

import ovh

DOMAIN = "example.com"
SOURCE = "sales@example.com"
DESTINATION = "contact@example.com"

# create a client
client = ovh.Client()

# Create a new alias
client.post('/email/domain/%s/redirection' % DOMAIN,
        _from=SOURCE,
        to=DESTINATION
        localCopy=False
    )
print("Installed new mail redirection from %s to %s" % (SOURCE, DESTINATION))

Grab Bill List

Let's say you want to integrate OVH bills into your own billing system, you could just script around the /me/bills endpoints and even get the details of each bill lines using /me/bill/{billId}/details/{billDetailId}.

This example assumes an existing Configuration with valid application_key, application_secret and consumer_key.

# -*- encoding: utf-8 -*-

import ovh

# create a client without a consumerKey
client = ovh.Client()

# Grab bill list
bills = client.get('/me/bill')
for bill in bills:
    details = client.get('/me/bill/%s' % bill)
    print("%12s (%s): %10s --> %s" % (
        bill,
        details['date'],
        details['priceWithTax']['text'],
        details['pdfUrl'],
    ))

Enable Network Burst in SBG1

'Network burst' is a free service but is opt-in. What if you have, say, 10 servers in SBG-1 datacenter? You certainly don't want to activate it manually for each servers. You could take advantage of a code like this.

This example assumes an existing Configuration with valid application_key, application_secret and consumer_key.

# -*- encoding: utf-8 -*-

import ovh

# create a client
client = ovh.Client()

# get list of all server names
servers = client.get('/dedicated/server/')

# find all servers in SBG-1 datacenter
for server in servers:
    details = client.get('/dedicated/server/%s' % server)
    if details['datacenter'] == 'sbg1':
        # enable burst on server
        client.put('/dedicated/server/%s/burst' % server, status='active')
        print("Enabled burst for %s server located in SBG-1" % server)

List Application Authorized to Access Your Account

Thanks to the application key / consumer key mechanism, it is possible to finely track applications having access to your data and revoke this access. This examples lists validated applications. It could easily be adapted to manage revocation too.

This example assumes an existing Configuration with valid application_key, application_secret and consumer_key.

# -*- encoding: utf-8 -*-

import ovh
from tabulate import tabulate

# create a client
client = ovh.Client()

credentials = client.get('/me/api/credential', status='validated')

# pretty print credentials status
table = []
for credential_id in credentials:
    credential_method = '/me/api/credential/'+str(credential_id)
    credential = client.get(credential_method)
    application = client.get(credential_method+'/application')

    table.append([
        credential_id,
        '[%s] %s' % (application['status'], application['name']),
        application['description'],
        credential['creation'],
        credential['expiration'],
        credential['lastUse'],
    ])
print(tabulate(table, headers=['ID', 'App Name', 'Description',
                               'Token Creation', 'Token Expiration', 'Token Last Use']))

Before running this example, make sure you have the tabulate library installed. It's a pretty cool library to pretty print tabular data in a clean and easy way.

>>> pip install tabulate

The straightforward way to use OVH's API keys is to embed them directly in the application code. While this is very convenient, it lacks of elegance and flexibility.

Alternatively it is suggested to use configuration files or environment variables so that the same code may run seamlessly in multiple environments. Production and development for instance.

This wrapper will first look for direct instantiation parameters then OVH_ENDPOINT, OVH_APPLICATION_KEY, OVH_APPLICATION_SECRET and OVH_CONSUMER_KEY environment variables. If either of these parameter is not provided, it will look for a configuration file of the form:

[default]
; general configuration: default endpoint
endpoint=ovh-eu

[ovh-eu]
; configuration specific to 'ovh-eu' endpoint
application_key=my_app_key
application_secret=my_application_secret
consumer_key=my_consumer_key

The client will successively attempt to locate this configuration file in

  1. Current working directory: ./ovh.conf
  2. Current user's home directory ~/.ovh.conf
  3. System wide configuration /etc/ovh.conf

This lookup mechanism makes it easy to overload credentials for a specific project or user.

You can call all the methods of the API with the necessary arguments.

If an API needs an argument colliding with a Python reserved keyword, it can be prefixed with an underscore. For example, from argument of POST /email/domain/{domain}/redirection may be replaced by _from.

With characters invalid in python argument name like a dot, you can:

# -*- encoding: utf-8 -*-

import ovh

params = {}
params['date.from'] = '2014-01-01'
params['date.to'] = '2015-01-01'

# create a client
client = ovh.Client()

# pass parameters using **
client.post('/me/bills', **params)

Un-Authenticated Calls

If the user has not authenticated yet (ie, there is no valid Consumer Key), you may force python-ovh to issue the call by passing _need_auth=True to the high level get(), post(), put() and delete() helpers or need_auth=True to the low level method Client.call() and Client.raw_call().

This is needed when calling POST /auth/credential and GET /auth/time which are used internally for authentication and can optionally be done for most of the /order calls.

Access the Raw Requests Response Objects

The high level get(), post(), put() and delete() helpers as well as the lower level call() will returned a parsed json response or raise in case of error.

In some rare scenario, advanced setups, you may need to perform customer processing on the raw request response. It may be accessed via raw_call(). This is the lowest level call in python-ovh. See the source for more information.

This wrapper uses standard Python tools, so you should feel at home with it. Here is a quick outline of what it may look like. A good practice is to run this from a virtualenv.

Get the Sources

git clone https://github.com/ovh/python-ovh.git
cd python-ovh
python setup.py develop

You've developed a new cool feature ? Fixed an annoying bug ? We'd be happy to hear from you !

Run the Tests

Simply run nosetests. It will automatically load its configuration from setup.cfg and output full coverage status. Since we all love quality, please note that we do not accept contributions with test coverage under 100%.

pip install -e .[dev]
nosetests # 100% coverage is a hard minimum

Build the Documentation

Documentation is managed using the excellent Sphinx system. For example, to build HTML documentation:

cd python-ovh/docs
make html

Ovh Europe

Ovh North America

Author

Jean-Tiare Le Bigot

Info

Aug 12, 2022 0.3 Python-OVH