Cohesity Cluster SDK

Python client library for the Cohesity v2 REST API (/v2).

Table of Contents

• Overview
• Requirements
• Installation
• Compatibility
• Quick Start
• Authentication and SSL
• Package Layout
• License

Overview

cohesity-cluster-sdk exposes typed models, controllers, and a single entry-point client for calling Cohesity cluster APIs from Python.

• Client: CohesityClientV2 — lazy-loaded controllers for each API area (protection groups, sources, recovery, and more).
• Models: request/response objects under cohesity_cluster_sdk.models.v2 with from_dictionary() deserialization.
• Enums: typed constants for enum fields (for example AgentHostSummaryObjectTypeEnum.K_DATABASE).
• Configuration: ConfigurationV2 on client.configuration — cluster VIP, credentials, SSL, and auth mode.

Requirements

• Python 3.9 or higher
• Dependencies (installed automatically): requests, cachecontrol, python-dateutil

Installation

Install from PyPI:

pip install cohesity-cluster-sdk

Import in your application:

from cohesity_cluster_sdk.cohesity_client_v2 import CohesityClientV2

Compatibility

This package targets the v2 REST API only (base_path: /v2).

Quick Start

from cohesity_cluster_sdk.cohesity_client_v2 import CohesityClientV2

client = CohesityClientV2(
    cluster_vip="your-cluster-vip",
    username="admin",
    password="password",
    domain="LOCAL",
)

# List protection groups
response = client.protection_group.get_protection_groups()
for group in response.protection_groups or []:
    print(group.name, group.environment)

# Fetch a source registration
registration = client.source.get_protection_source_registration(id=1)
print(registration.name)

Controllers are available as properties on the client (for example client.protection_group, client.source, client.recovery, client.config). See cohesity_cluster_sdk.cohesity_client_v2 for the full list.

Using enum constants

Enum fields accept the same string values sent on the wire. Use the generated enum classes to avoid typos:

from cohesity_cluster_sdk.models.v2.create_or_update_protection_group_request_environment_enum import (
    CreateOrUpdateProtectionGroupRequestEnvironmentEnum,
)

body.environment = CreateOrUpdateProtectionGroupRequestEnvironmentEnum.K_SQL

Authentication and SSL

Cluster settings live on ConfigurationV2 via client.configuration.

Auth modes (in priority order):

1. API key — sends apiKey header when api_key is set.
2. Session — creates a session when use_session=True; sends session-id.
3. Bearer token (default) — POSTs credentials to https://{cluster_vip}/v2/access-tokens, then sends Authorization: {tokenType} {accessToken}.

SSL: When skip_ssl_verification is True, the HTTP client passes verify=False on every request. To enable verification, set it before making calls:

from cohesity_cluster_sdk.configuration_v2 import ConfigurationV2

ConfigurationV2.skip_ssl_verification = False

For self-signed lab clusters, the default (True) is usually appropriate.

Tips:

• List endpoints return wrapper objects — iterate with response.protection_groups or [].
• Nullable model fields may be None; guard before access.
• client.configuration holds runtime settings; client.config is the cluster configuration API controller.

Package Layout

cohesity_cluster_sdk/
├── cohesity_client_v2.py        # Entry point — CohesityClientV2
├── configuration_v2.py          # Cluster VIP, auth, SSL — ConfigurationV2
├── api_helper.py                  # Serialization and URL building
├── decorators.py                  # lazy_property
├── models/v2/                     # Request/response models and enum classes
├── api/v2/                        # API controllers (one per API area)
├── http/                          # HTTP client, auth, retry logic
└── exceptions/                    # APIException, ExpiredTokenException

License

Apache 2.0 — see LICENSE.