Client class - BlueCat Python Library

Click a link to jump to the indicated section.

Client class
- auth
- bam_url
- bam_version
- http_delete()
- http_get()
- http_patch()
- http_post()
- http_put()
- http_request()
- is_authenticated
- login()
- logout()

class `bluecat_libraries.address_manager.apiv2.Client`(url, , verify=True*)

Bases: bluecat_libraries.http_client.client.Client

A client for making HTTP calls to BAM REST v2 API.

There is a method for each HTTP verb - GET, POST, PUT, PATCH, and DELETE - as well as a generic method for a HTTP request: http_get, http_post, http_put, http_patch, http_delete, and http_request. The functionality of the client relies on the use of these methods.

The benefits of this client over a direct use of the requests Python library are:

Available methods for performing login and logout, as well as determining the version of the BlueCat Address Manager.
The client keeps track of the authentication token and automatically sends it with each request.
The client keeps track of the base API URL, needing only the relative path to be specified when making a request.
The client automatically parses the responses and returns Python data structures - dictionaries or strings - based on the response content type.
The client detects error responses and raises a Python exception, which holds the fields that the BAM API replied with, e.g, code.

Overall, users of the client can write less code and keep track of less data when making requests to the BAM REST v2 API.

Nonetheless, the client allows for taking advantage of the full functionality of the BAM REST v2 API by exposing all available requests parameters in its methods. That way a user can, for example, specify filters and fields selection through URL query parameters.

You need to authenticate to the BAM REST v2 API when making calls. The client will use HTTP header Authorization as per the BAM documentation. You have to either perform a login via the client method (with a username and a password) or set the auth property to the full value for the header, including the authorization scheme.

Note:

The client does not specify a value for the Accept header by default. This results in the Content-Type of the response to be determined by the defaults of BAM.

Example:

from bluecat_libraries.address_manager.apiv2 import Client, MediaType
import csv

# Retrieve the configurations. Request the data as per BAM's default content type.
with Client(<bam_host_url>) as client:
    client.login(<username>, <password>)
    response = client.http_get("/configurations")
    configurations = response["data"]
    for configuration in configurations:
        print(f'{configuration["id"]}: {configuration["name"]}')
    client.logout()

# Retrieve the configurations. Request that the response is in 'JSON' format.
# The result should contain only fields 'id' and 'name'.
with Client(<bam_host_url>) as client:
    client.login(<username>, <password>)
    response = client.http_get(
        "/configurations",
        params={"fields": "id,name"},
        headers={"Accept": MediaType.JSON},
    )
    configurations = response["data"]
    for configuration in configurations:
        print(f'{configuration["id"]}: {configuration["name"]}')
    client.logout()

# Retrieve configurations. Request that the response is in 'CSV' format.
# The result should contain only the first 10, ordered alphabetically by name.
with Client(<bam_host_url>) as client:
    client.login(<username>, <password>)
    configurations_csv = client.http_get(
        "/configurations",
        params={"orderBy": "asc(name)", "limit": "10"},
        headers={"Accept": MediaType.CSV},
    )
    configurations = list(csv.reader(configurations_csv.splitlines()))
    for configuration in configurations:
        # NOTE: The 'id' is the first value in a row, the 'name' is the third one.
        print(f"{configuration[0]}: {configuration[2]}")
    client.logout()

New in version 23.1.0.

property `auth`

The value that the client is configured to use for header Authorization when making requests to BAM REST v2 API.

Return type: str | None

property `bam_url`

A URL to the Address Manager the client is created for.

This is not the verbatim value given during initialization. It contains only the scheme, host, and (if specified) port, which will be used by the client.

Return type: str

property `bam_version`

The version of the BlueCat Address Manager the client is connected to.

Note:

The client has to be authenticated before the version can be determined.

Return type: Version

Returns: Version of BlueCat Address Manager.

`http_delete(url, params=None, data=None, json=None, expected_status_codes=None, **kwargs)`

Perform an HTTP DELETE request based on the provided parameters. See method http_request for details.