# watcherclient Python API

The watcherclient python API lets you access watcher, the OpenStack TODEFINE Service.

For example, to manipulate audits, you interact with an watcherclient.v1.audit object. You obtain access to audits via attributes of the watcherclient.v1.client.Client object.

## Usage

### Get a Client object

First, create an watcherclient.v1.client.Client instance by passing your credentials to watcherclient.client.get_client(). By default, the Watcher system is configured so that only administrators (users with ‘admin’ role) have access.

There are two different sets of credentials that can be used:

    * watcher endpoint and auth token
    * Identity Service (keystone) credentials

#### Using watcher endpoint and auth token

An auth token and the watcher endpoint can be used to authenticate:

    * os_auth_token: authentication token (from Identity Service)
    * watcher_url: watcher API endpoint, eg http://watcher.example.org:9322/v1

To create the client, you can use the API like so:

    >>> from watcherclient import client
    >>>
    >>> kwargs = {'os_auth_token': '3bcc3d3a03f44e3d8377f9247b0ad155'
    >>>           'watcher_url': 'http://watcher.example.org:9322/'}
    >>> watcher = client.get_client(1, **kwargs)

#### Using Identity Service (keystone) credentials

These Identity Service credentials can be used to authenticate:

    * os_username: name of user
    * os_password: user's password
    * os_auth_url: Identity Service endpoint for authorization
    * os_tenant_{name|id}: name or ID of tenant

To create a client, you can use the API like so:

    >>> from watcherclient import client
    >>>
    >>> kwargs = {'os_username': 'name',
    >>>           'os_password': 'password',
    >>>           'os_auth_url': 'http://keystone.example.org:5000/',
    >>>           'os_tenant_name': 'tenant'}
    >>> watcher = client.get_client(1, **kwargs)

### Perform watcher operations

Once you have an watcher Client, you can perform various tasks:

    >>> watcher.action.list()  # list of actions
    >>> watcher.action_plan.list()  # list of action_plan
    >>> watcher.audit.get(audit_uuid_or_name)  # information about a particular audit

When the Client needs to propagate an exception, it will usually raise an instance listed in watcherclient.exceptions.

Refer to the modules themselves, for more details.

# watcherclient Modules

this page last updated: 2025-03-03 09:38:11

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug