Dome9 SDK python

Author - Dome9 SRE Team mail_us

Dome9 Python SDK is a library the access Dome9 API V2. It enables you to manage Dome9 resources such as Cloud Account Onboarding, Security Groups management, Access Lease, IAM Safety and more.

Dome9 API documentation: https://api-v2-docs.dome9.com/

Quick Start

Installation

$ pip install git+https://github.com/dome9/dome9-sdk-python

Import

Client can be imported from dome9_type_annotations layer to support IDE methods completion

from dome9_type_annotations.client import Client

Client can also be imported directly

from dome9 import Client

Client Initialisation

Required parameters for client initiation (access_id, secret_key) can be passed directly:

dome9_client = Client(access_id='ACCESS_ID', secret_key='SECRET_KEY')

Alternatively, If parameters are not provided, Client will seek and use DOME9_ACCESS_ID and DOME9_SECRET_KEY environment variables

export DOME9_ACCESS_ID = YOUR_ACCESS_ID
export DOME9_SECRET_KEY = YOUR_SECRET_KEY

dome9_client = Client()

By default, client will use Dome9 production URL https://api.dome9.com/v2/. For development purposes, different URL can be provided:

dome9_client = Client(base_url='DOME9_ENVIRONMENT_URL')

Example - Create Role

from dome9_type_annotations.client import Client
from resources.role import CreateRole

dome9_client = Client(access_id='ACCESS_ID', secret_key='SECRET_KEY')
payload = CreateRole(name='my-role', description='my-description')
response = dome9_client.role.create(body=payload)

print(response)

Unimplemented Resources

You can view the yet implemented resources under not_implemented_resources folder. You are welcome to contact us and to request a specific resource to be prioritized.