CockroachDB Cloud API Python SDK

Overview

An API for managing CockroachDB Cloud resources

Synchronous Client

from cockroach_cloud_py import Client
from os import getenv

client = Client(token=getenv("API_TOKEN"))

Asynchronous Client

from cockroach_cloud_py import AsyncClient
from os import getenv

client = AsyncClient(token=getenv("API_TOKEN"))

Module Documentation and Snippets

api_keys

• create - Create a new API Key
• delete - Delete an API Key
• get - Get an API Key by ID
• list - List API Keys
• patch - Update an API Key

auditlogevents

• list - List audit logs

cluster_versions

• list - List available major cluster versions

clusters

• create - Create and initialize a new cluster
• delete - Delete a cluster and all of its data
• get - Get extended information about a cluster
• list - List clusters owned by an organization
• patch - Scale, edit or upgrade a cluster

clusters.available_regions

• list - List the regions available for new clusters and nodes

clusters.backups_config

• list - Get the backup configuration for a cluster
• patch - Update the backup configuration for a cluster

clusters.client_ca_cert

• create - Set Client CA Cert for a cluster
• delete - Delete Client CA Cert for a cluster
• list - Get Client CA Cert information for a cluster
• patch - Update Client CA Cert for a cluster

clusters.cmek

• create - Enable CMEK for a cluster
• list - Get CMEK-related information for a cluster
• patch - Update the CMEK-related status for a cluster
• update - Enable or update the CMEK spec for a cluster

clusters.databases

• create - Create a new database
• delete - Delete a database
• get_connection_string - Get a formatted generic connection string for a cluster
• list - List databases for a cluster
• patch - Update a database
• patch_1 - Update a database

clusters.disrupt

• list - Get disruption specifications for a cluster
• update - Update disruption specifications for a cluster

clusters.logexport

• create - Create or update the Log Export configuration for a cluster
• delete - Delete the Log Export configuration for a cluster
• list - Get the Log Export configuration for a cluster

clusters.maintenance_window

• delete - Delete the maintenance window for a cluster
• list - Get the maintenance window for a cluster
• update - Set the maintenance window for a cluster

clusters.metricexport.cloudwatch

• create - Create or update the CloudWatch Metric Export configuration for a cluster
• delete - Delete the CloudWatch Metric Export configuration for a cluster
• list - Get the CloudWatch Metric Export configuration for a cluster

clusters.metricexport.datadog

• create - Create or update the Datadog Metric Export configuration for a cluster
• delete - Delete the Datadog Metric Export configuration for a cluster
• list - Get the Datadog Metric Export configuration for a cluster

clusters.metricexport.prometheus

• create - Enable Prometheus Metric Export for a cluster
• delete - Disable Prometheus Metric Export for a cluster
• list - Get the Prometheus Metric Export configuration for a cluster

clusters.networking.allowlist

• create - Add a new CIDR address to the IP allowlist
• delete - Delete an IP allowlist entry
• list - Get the IP allowlist and propagation status for a cluster
• patch - Update an IP allowlist entry
• update - Add a new CIDR address to the IP allowlist

clusters.networking.aws_endpoint_connections

• list - List all AwsEndpointConnections for a cluster
• patch - Set the AWS Endpoint Connection state

clusters.networking.egress_rules

• create - Add an egress rule
• delete - Delete an existing egress rule
• get - Get an existing egress rule
• list - List all egress rules associated with a cluster
• patch - Edit an existing egress rule

clusters.networking.egress_rules.egress_traffic_policy

• create - Outbound traffic management

clusters.networking.private_endpoint_connections

• create - Add a connection to a cluster's private endpoint service.
• delete - Delete a connection from a cluster's private endpoint service.
• list - List all connections to a cluster's private endpoint service.

clusters.networking.private_endpoint_services

• create - Create all PrivateEndpointServices for a cluster
• list - List all PrivateEndpointServices for a cluster

clusters.networking.private_endpoint_trusted_owners

• create - Add a private endpoint trusted owner to a cluster
• delete - Remove a private endpoint trusted owner from a cluster
• get - Get a private endpoint trusted owner entry for a cluster
• list - List all private endpoint trusted owners for a cluster

clusters.nodes

• list - List nodes for a cluster

clusters.sql_users

• create - Create a new SQL user
• delete - Delete a SQL user
• list - List SQL users for a cluster

clusters.sql_users.password

• update - Update a SQL user's password

clusters.version_deferral

• list - Get the version upgrade deferral policy for a cluster.
• update - Set the version upgrade deferral policy for a cluster

folders

• create - Create a folder
• delete - Delete a folder
• get - Get folder info for a folder
• list - List folders owned by an organization
• patch - Update a folder

folders.contents

• list - List contents of a folder

invoices

• get - Get a specific invoice for an organization
• list - List invoices for a given organization

jwt_issuers

• create - Add a JWT Issuer
• delete - Delete a JWT Issuer
• get - Get a JWT Issuer
• list - List all JWT Issuers
• patch - Update a JWT Issuer

organization

• get_info - Get information about the caller's organization

replication_streams

• create - Create a replication stream
• get - Get a replication stream
• list - List replication streams
• patch - Update a replication stream

roles

• create - Add a role to a user or service account
• delete - Remove a role from a user or service account
• get - Get all Role Grants for a user
• list - List all RoleGrants
• update - Replace the roles for a user or service account with exactly those provided

scim.groups

• create - Create a group
• delete - Delete a group based on ID
• find - Search groups (Deprecated)
• find_all - Search a group by ID
• get - Get a group by ID
• get_by_id - Search a group by ID (Deprecated)
• list - List groups
• search - Search groups
• update - Update a group by supplying all values of the user object

scim.resource_types

• get - Get a SCIM resource type by ID
• list - List the SCIM resource types

scim.schemas

• get - Get a SCIM schema by ID
• list - List the SCIM schemas

scim.service_provider_config

• list - Return the SCIM Service Provider configuration

scim.users

• create - Create a user
• delete - Delete a user based on ID
• find - Search for a user by ID
• get - Get a user by ID
• get_user - Search for a user by ID (Deprecated)
• get_users - Search User (Deprecated)
• list - List Users
• search - Search Users
• update - Update a user by supplying all values of the user object

service_accounts

• create - Create a service account
• delete - Delete a service account
• get - Get a service account by ID
• list - List service accounts for an organization
• patch - Update a service account

users

• list_by_email - Search person users by email address