# cloud_public_api_sample

**Repository Path**: mirrors_couchbaselabs/cloud_public_api_sample

## Basic Information

- **Project Name**: cloud_public_api_sample
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-03-20
- **Last Updated**: 2026-05-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CloudPublicAPISample
Here you will find a number of a sample Python applications that demonstrate using various features of the Couchbase Cloud Public API to automate operations. 

To use any of these samples, follow the instructions below


## Prerequisites
The following pieces need to be in place

* Admission into the Restricted Beta
* Access and Secret Keys for authentication to the API
* Python 3.0 or greater


## Running 
You will need to download the samples. To do this, either download [the archive](https://github.com/couchbaselabs/cloud_public_api_sample) or clone the repository:

```
$ git clone https://github.com/couchbaselabs/cloud_public_api_sample
```

change directory
```
$ cloud_public_api_sample
```


There are several Python libraries that will need to be installed and these are listed in _requirements.txt_.  They can be automatically loaded using the _pip_ command:
```
$ pip install -r requirements.txt
```

Next, set the environment variables for the base URL for Cloud API , access and secret keys.
replace <> by your values for secret and access keys.

```
$ export cbc_base_url='https://cloudapi.cloud.couchbase.com'
$ export cbc_secret_key='<>'
$ export cbc_access_key='<>'
```

Launch the application by running the relevant file from a terminal e.g
 
```
$ python listClouds.py
```
## Documentation

Documentation for each of the samples can be found in the docs folder. 

Documentation for the beta APIs can be found at https://docs.couchbase.com/cloud/public-api-guide/introducing-public-api.html