Welcome to transip-api’s documentation!

This library aims to implement the TransIP API in Python.

Here is an example of a simple Python program:

from transip.service.vps import VpsService


PRIVATE_KEY = '''
-----BEGIN PRIVATE KEY-----
...
-----END PRIVATE KEY-----
'''

# You can specify the private key directly or supply the path to the private
# key file. The private_key_file will default to `decrypted_key`.
client = VpsService('accountname', private_key_file='/path/to/decrypted_key')
client = VpsService('accountname', private_key=PRIVATE_KEY)

# Order a Vps without addons:
client.order_vps('vps-bladevps-x1', None, 'ubuntu-18.04', 'vps-name')

You can get the library directly from PyPi:

pip install transip

Documentation

This part of the documentation guides you through all of the library’s usage patterns.

Indices and tables