Client User Guide

Introduction

The Client class is a binding to Blackduck's REST API that provides a robust connection backed by a Session object. The user specifies a base URL, timeout, retries, proxies, and TLS verification upon initialization and these attributes are persisted across all requests.

At the REST API level, the Client class provides a consistent way to discover and traverse public resources, uses a generator to fetch all items using pagination, and automatically renews the bearer token.

Note that unlike HubRestApi's HubInstance, Client does not provide a multitude of methods to simplify specific end-point use.

It is designed to provide a solid foundation especially suited for long-running scripts.

Table of Contents

• Installation
• Quickstart
  • Authenticate
  • List Resources
  • Get Resource
  • Direct Request
• Advanced Usage
  • Media Types
  • Password Authentication
• API Reference