Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

Couchbase Public API

    +
    API reference guide for the Couchbase Capella Public API.

    You can find this reference as an openapi.yaml file to import into tools such as Postman, Insomnia or similar, here.

    The API is regularly updated along with the documentation. In the process, documentation may be built first — so it is possible that a new endpoint listed here may be some hours from reaching the API.

    The /v2 APIs are for Capella hosted in your own cloud provider’s VPC. Capella hosted in Couchbase’s own cloud uses only v3 APIs.

    Access

    • Bearer Authentication

    Endpoints

    Clouds

    GET /v2/clouds

    List Clouds

    Description

    Returns a paginated list of clouds created by the tenant

    Parameters
    Query Parameters
    Name Description Required Default Pattern

    page

    Sets how many results you would like to have on each page

    -

    null

    perPage

    Sets what page you would like to view

    -

    null

    sortBy

    Sets order of how you would like to sort results and also the key you would like to order by

    -

    null
    Return Type

    ListCloudsResponse

    Responses
    Code Message Datatype

    200

    Success

    ListCloudsResponse

    403

    Access forbidden

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    GET /v2/clouds/{id}

    Get Cloud

    Description

    Returns a single cloud by the ID

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cloud IDA

    X

    null
    Return Type

    Cloud

    Responses
    Code Message Datatype

    200

    On success returns a Cloud details.

    Cloud

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    500

    Internal server error

    Goof
    Samples

    Clusters

    POST /v2/clusters

    Create cluster

    Description

    Creates cluster in cloud, returns id of the cluster on success

    Parameters
    Body Parameter
    Name Description Required Default Pattern

    CreateClusterRequest

    CreateClusterRequest

    -
    Return Type

    -

    Responses
    Code Message Datatype

    202

    Success

    <<>>

    403

    Access forbidden

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    POST /v2/clusters/{id}/allowlist

    Adds entry to allowlist

    Description

    Appends entry sent to the allowlist

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null
    Body Parameter
    Name Description Required Default Pattern

    AppendAllowListRequest

    AppendAllowListRequest

    -
    Return Type

    -

    Responses
    Code Message Datatype

    202

    Successfully appended entry to allowlist

    <<>>

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    POST /v2/clusters/{id}/buckets

    Create bucket in cluster

    Description

    Creates bucket in cluster specified with cluster id parameter

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null
    Body Parameter
    Name Description Required Default Pattern

    CouchbaseBucketSpec

    CouchbaseBucketSpec

    -
    Return Type

    CouchbaseBucketSpec

    Responses
    Code Message Datatype

    201

    Successfully created bucket

    CouchbaseBucketSpec

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    POST /v2/clusters/{id}/users

    Create Database User

    Description

    Creates Database user. A database user entity is required for applications to remotely authenticate on a cluster and access bucket data

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null
    Body Parameter
    Name Description Required Default Pattern

    CreateDatabaseUserRequest

    CreateDatabaseUserRequest

    -
    Return Type

    -

    Responses
    Code Message Datatype

    201

    Successfully created database user.

    <<>>

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    DELETE /v2/clusters/{id}

    Delete cluster

    Description

    Start a delete cluster job

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null
    Return Type

    -

    Responses
    Code Message Datatype

    202

    Successfully started delete cluster job

    <<>>

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    DELETE /v2/clusters/{id}/allowlist

    Delete entry from allowlist

    Description

    Deletes entry from allowlist, will use CIDR block as key

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null
    Body Parameter
    Name Description Required Default Pattern

    DeleteAllowListEntryRequest

    DeleteAllowListEntryRequest

    -
    Return Type

    -

    Responses
    Code Message Datatype

    204

    Successfully deleted allowlist entry

    <<>>

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    DELETE /v2/clusters/{id}/buckets

    Delete bucket in cluster

    Description

    Deletes bucket in cluster specified with cluster id parameter

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null
    Body Parameter
    Name Description Required Default Pattern

    DeleteBucketRequest

    DeleteBucketRequest

    -
    Return Type

    -

    Responses
    Code Message Datatype

    202

    Successfully deleted bucket

    <<>>

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    DELETE /v2/clusters/{id}/buckets/{bucketId}

    Delete an existing bucket

    Description

    Deletes a single bucket from the cluster

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null

    bucketId

    Bucket ID

    X

    null
    Return Type

    -

    Responses
    Code Message Datatype

    202

    Success

    <<>>

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    DELETE /v2/clusters/{id}/users/{username}

    Delete Database User

    Description

    Delete Cluster’s Database User and revoke its access to the bucket(s)

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null

    username

    Database User username

    X

    null
    Return Type

    -

    Responses
    Code Message Datatype

    204

    Successfully deleted Database User

    <<>>

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    500

    Internal server error

    Goof
    Samples

    GET /v2/clusters/{id}/allowlist

    Get current allowlist

    Description

    Returns a list with all the allowed IP ranges/addresses

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null
    Return Type

    ListAllowListResponse

    Responses
    Code Message Datatype

    200

    Returns allowlist

    ListAllowListResponse

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    GET /v2/clusters/{id}/certificate

    Get Cluster Certificate

    Description

    Retrieve a self-signed certificate to securely connect to the cluster. Required for both public and private connections.

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null
    Return Type

    GetCertificateResponse

    Responses
    Code Message Datatype

    200

    Returns a self-signed certificate

    GetCertificateResponse

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    500

    Internal server error

    Goof
    Samples

    GET /v2/clusters/{id}/health

    Get Cluster Health

    Description

    Retrieve Cluster health and status. Health stats of the cluster are returned only for clusters with ready status.

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null
    Return Type

    ClusterHealthResponse

    Responses
    Code Message Datatype

    200

    Current Cluster Health and Status

    ClusterHealthResponse
    Samples

    GET /v2/clusters

    List Clusters

    Description

    Return a paginated list of organization Clusters.

    Parameters
    Query Parameters
    Name Description Required Default Pattern

    page

    Sets how many results you would like to have on each page

    -

    null

    perPage

    Sets what page you would like to view

    -

    null

    sortBy

    Sets order of how you would like to sort results and also the key you would like to order by

    -

    null

    cloudId

    Cloud ID for filtering cloud clusters.

    -

    null

    projectId

    Project ID for filtering project clusters.

    -

    null
    Return Type

    ListClustersResponse

    Responses
    Code Message Datatype

    200

    Success

    ListClustersResponse

    403

    Access forbidden

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    GET /v2/clusters/{id}/buckets

    List cluster buckets

    Description

    Returns a list of existing cluster buckets

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null
    Return Type

    ListBucketsResponse

    Responses
    Code Message Datatype

    200

    Cluster's bucket list

    ListBucketsResponse

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    GET /v2/clusters/{id}/users

    List Database Users

    Description

    Returns a list of Cluster’s Database Users.

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null
    Return Type

    ListDatabaseUsersResponse

    Responses
    Code Message Datatype

    200

    On success returns a list of Database users.

    ListDatabaseUsersResponse

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    GET /v2/clusters/{id}

    Get Cluster

    Description

    Retrieve a cluster by ID

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null
    Return Type

    Cluster

    Responses
    Code Message Datatype

    200

    if found, returns a cluster.

    Cluster

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    500

    Internal server error

    Goof
    Samples

    GET /v2/clusters/{id}/status

    Get Cluster Status

    Description

    Returns Cluster Status

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null
    Return Type

    ClusterStatusResponse

    Responses
    Code Message Datatype

    200

    Cluster Status

    ClusterStatusResponse

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    500

    Internal server error

    Goof
    Samples

    PUT /v2/clusters/{id}/allowlist

    Update the allowlist for a cluster

    Description

    Updates allow list to received payload

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null
    Body Parameter
    Name Description Required Default Pattern

    UpdateAllowListRequest

    UpdateAllowListRequest

    -
    Return Type

    -

    Responses
    Code Message Datatype

    202

    Successfully update allowlist

    <<>>

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    PUT /v2/clusters/{id}/buckets

    Update bucket in cluster

    Description

    Updates bucket in cluster specified with cluster id parameter

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null
    Body Parameter
    Name Description Required Default Pattern

    UpdateBucketSpec

    UpdateBucketSpec

    -
    Return Type

    CouchbaseBucketSpec

    Responses
    Code Message Datatype

    201

    Successfully updated bucket

    CouchbaseBucketSpec

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    PUT /v2/clusters/{id}/buckets/{bucketId}

    Update an existing bucket

    Description

    Updates the configuration of an existing bucket in a cluster

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null

    bucketId

    Bucket ID

    X

    null
    Body Parameter
    Name Description Required Default Pattern

    UpdateBucketRequest

    UpdateBucketRequest

    -
    Return Type

    -

    Responses
    Code Message Datatype

    202

    Success

    <<>>

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    PUT /v2/clusters/{id}/users/{username}

    Update Database User

    Description

    Update a Cluster’s Database User

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null

    username

    Database User username

    X

    null
    Body Parameter
    Name Description Required Default Pattern

    UpdateDatabaseUserRequest

    UpdateDatabaseUserRequest

    -
    Return Type

    -

    Responses
    Code Message Datatype

    204

    Successfully updated Database User

    <<>>

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    ClustersV3

    POST /v3/clusters

    Create Cluster V3

    Description

    Creates a cluster with the given specifications and returns the id of the cluster on success

    Parameters
    Body Parameter
    Name Description Required Default Pattern

    V3CreateClusterRequest

    V3CreateClusterRequest

    -
    Return Type

    -

    Responses
    Code Message Datatype

    202

    Success

    <<>>

    403

    Access forbidden

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    POST /v3/clusters/{id}/users

    Create cluster user

    Description

    Creates a new user for a cluster with access to buckets/scopes

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null
    Body Parameter
    Name Description Required Default Pattern

    V3CreateClusterUserRequest

    V3CreateClusterUserRequest

    -
    Return Type

    -

    Responses
    Code Message Datatype

    201

    Successfully created cluster user

    <<>>

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    DELETE /v3/clusters/{id}

    Delete Cluster V3

    Description

    Starts the deletion process for the cluster

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null
    Return Type

    -

    Responses
    Code Message Datatype

    202

    Successfully started the cluster deletion process

    <<>>

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    GET /v3/clusters

    List all clusters v3

    Description

    Returns a paginated list of all clusters

    Parameters
    Query Parameters
    Name Description Required Default Pattern

    page

    Sets how many results you would like to have on each page

    -

    null

    perPage

    Sets what page you would like to view

    -

    null

    cloudId

    Cloud ID for filtering cloud clusters.

    -

    null

    projectId

    Project ID for filtering project clusters.

    -

    null
    Return Type

    V3ClusterList

    Responses
    Code Message Datatype

    200

    Success

    V3ClusterList

    403

    Access forbidden

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    GET /v3/clusters/{id}

    Get Cluster Info V3

    Description

    Retrieves cluster information using the provided cluster ID

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null
    Return Type

    V3Cluster

    Responses
    Code Message Datatype

    200

    If found, returns the cluster information

    V3Cluster

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    500

    Internal server error

    Goof
    Samples

    GET /v3/clusters/{id}/status

    Get Cluster Status V3

    Description

    Gets cluster status

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null
    Return Type

    V3ClusterStatusResponse

    Responses
    Code Message Datatype

    200

    Cluster status

    V3ClusterStatusResponse
    Samples

    PUT /v3/clusters/{id}/meta

    Update Cluster Metadata V3

    Description

    Updates the cluster metadata

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null
    Body Parameter
    Name Description Required Default Pattern

    V3UpdateClusterMetaRequest

    V3UpdateClusterMetaRequest

    -
    Return Type

    -

    Responses
    Code Message Datatype

    204

    Successfully updated the cluster metadata

    <<>>

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    PUT /v3/clusters/{id}/servers

    Update Cluster Servers V3

    Description

    Updates the cluster server group to scale in / out, up / down

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null
    Body Parameter
    Name Description Required Default Pattern

    V3UpdateClusterServersRequest

    V3UpdateClusterServersRequest

    -
    Return Type

    -

    Responses
    Code Message Datatype

    202

    Success

    <<>>

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    PUT /v3/clusters/{id}/support

    Update Cluster Support Package V3

    Description

    Updates the cluster support package details

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Cluster ID

    X

    null
    Body Parameter
    Name Description Required Default Pattern

    V3UpdateClusterSupportRequest

    V3UpdateClusterSupportRequest

    -
    Return Type

    -

    Responses
    Code Message Datatype

    204

    Successfully updated the support package details

    <<>>

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    Projects

    POST /v2/projects

    Create project

    Description

    Creates project in tenant, returns id of project on success

    Parameters
    Body Parameter
    Name Description Required Default Pattern

    CreateProjectRequest

    CreateProjectRequest

    -
    Return Type

    Project

    Responses
    Code Message Datatype

    201

    Success

    Project

    403

    Access forbidden

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    DELETE /v2/projects/{id}

    Delete project

    Description

    Deletes endpoint with specified ID if exists, returns true on success and error if not

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Project ID

    X

    null
    Return Type

    -

    Responses
    Code Message Datatype

    204

    The project was deleted successfully

    <<>>

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    GET /v2/projects

    List Projects

    Description

    Returns a paginated list of projects created by the tenant

    Parameters
    Query Parameters
    Name Description Required Default Pattern

    page

    Sets how many results you would like to have on each page

    -

    null

    perPage

    Sets what page you would like to view

    -

    null

    sortBy

    Sets order of how you would like to sort results and also the key you would like to order by

    -

    null
    Return Type

    ListProjectsResponse

    Responses
    Code Message Datatype

    200

    Success

    ListProjectsResponse

    403

    Access forbidden

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    GET /v2/projects/{id}

    Get project by ID

    Description

    Returns the project with the ID

    Parameters
    Path Parameters
    Name Description Required Default Pattern

    id

    Project ID

    X

    null
    Return Type

    Project

    Responses
    Code Message Datatype

    200

    Success

    Project

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    Status

    GET /v2/status

    API status

    Description

    Returns a public API status

    Parameters
    Return Type

    StatusOK

    Responses
    Code Message Datatype

    200

    Success

    StatusOK

    500

    Internal server error

    Goof
    Samples

    To fetch the status of the Public API

    Request
    curl 'https://cloudapi.cloud.couchbase.com/v2/status'
    Response
    {
  "status": "OK"
}

    Users

    GET /v2/users

    List Users

    Description

    Return a paginated list of organization Users.

    Parameters
    Query Parameters
    Name Description Required Default Pattern

    page

    Sets how many results you would like to have on each page

    -

    null

    perPage

    Sets what page you would like to view

    -

    null

    sortBy

    Sets order of how you would like to sort results and also the key you would like to order by

    -

    null
    Return Type

    ListUsersResponse

    Responses
    Code Message Datatype

    200

    Success

    ListUsersResponse

    403

    Access forbidden

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Samples

    Models

    AWSProviderSettings

    Field Name Required Type Description Format

    region

    AwsRegions

    bucket

    [String]

    supportBucket

    [String]

    accountId

    [String]

    vpcCidr

    [String]

    vpcId

    [String]

    stackId

    [String]

    privateSubnets

    List of [string]

    availabilityZone

    List of [string]

    azCount

    [Integer]

    lastRotated

    [Date]

    date-time

    AllowListEntry

    Field Name Required Type Description Format

    cidrBlock

    X

    [String]

    ruleType

    X

    AllowListRules

    duration

    [String]

    createdAt

    [Date]

    date-time

    expiresAt

    [Date]

    date-time

    updatedAt

    [Date]

    date-time

    comment

    [String]

    state

    AllowListStates

    AllowListRules

    Type

    Enum

    Allowable Values

    temporary, permanent

    AllowListStates

    Type

    Enum

    Allowable Values

    active, pending, failed, expired

    AppendAllowListRequest

    Field Name Required Type Description Format

    cidrBlock

    X

    [String]

    ruleType

    X

    AllowListRules

    comment

    [String]

    duration

    [String]

    The duration you would like the temporary cidr block to be active

    AwsInstances

    Type

    Enum

    Allowable Values

    m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.24xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.12xlarge, c5.18xlarge, x1.16xlarge, x1.32xlarge

    AwsRegions

    Type

    Enum

    Allowable Values

    us-east-1, us-east-2, us-west-2, eu-west-1, eu-central-1, eu-west-2, eu-west-3, eu-north-1, ap-southeast-1, ap-northeast-1, ap-southeast-2, ap-northeast-2, ap-south-1, ca-central-1

    AzureInstances

    Type

    Enum

    Allowable Values

    Standard_F4s_v2, Standard_F8s_v2, Standard_F16s_v2, Standard_F32s_v2, Standard_F48s_v2, Standard_F64s_v2, Standard_F72s_v2, Standard_D4s_v3, Standard_D8s_v3, Standard_D16s_v3, Standard_D32s_v3, Standard_D48s_v3, Standard_D64s_v3, Standard_E4s_v3, Standard_E8s_v3, Standard_E16s_v3, Standard_E20s_v3, Standard_E32s_v3, Standard_E48s_v3, Standard_E64s_v3, Standard_GS2, Standard_GS3, Standard_GS4, Standard_GS5

    AzureProviderSettings

    Field Name Required Type Description Format

    resourceGroupName

    [String]

    region

    AzureRegions

    aksClusterName

    [String]

    dnsPrefix

    [String]

    defaultNodePoolName

    [String]

    tags

    Map of [string]

    vNetCidr

    [String]

    vNetName

    [String]

    storageAccountName

    [String]

    configContainerName

    [String]

    importContainerName

    [String]

    availabilityZones

    List of [string]

    azCount

    [Integer]

    deploymentName

    [String]

    msiName

    [String]

    tenantId

    [String]

    subscriptionId

    [String]

    AzureRegions

    Type

    Enum

    Allowable Values

    centralus, eastus2, eastus, francecentral, japaneast, northeurope, southeastasia, uksouth, westeurope, westus2

    AzureVolumeTypes

    Type

    Enum

    Allowable Values

    P4, P6, P10, P15, P20, P30, P40, P50, P60, P70

    BucketRole

    Field Name Required Type Description Format

    bucketName

    X

    [String]

    Bucket Name

    bucketAccess

    X

    Set of BucketRoleTypes

    BucketRoleTypes

    Type

    Enum

    Allowable Values

    data_writer, data_reader

    Description

    • data_writer - Gives the user permission to read and write data for the bucket.

    • data_reader - Gives the user read-only permission for the bucket.

    BucketStats

    Field Name Required Type Description Format

    status

    X

    [String]

    totalCount

    X

    [Integer]

    unhealthyCount

    X

    [Integer]

    healthStats

    X

    Map of [string]

    Cloud

    Field Name Required Type Description Format

    id

    X

    [UUID]

    uuid

    name

    X

    [String]

    tenantId

    X

    [UUID]

    uuid

    status

    X

    CloudStatus

    provider

    X

    Provider

    createdAt

    X

    [Date]

    date-time

    updatedAt

    [Date]

    date-time

    preflightStartedAt

    [Date]

    date-time

    preflightFailedAt

    [Date]

    date-time

    preflightCompletedAt

    [Date]

    date-time

    bootstrappedAt

    [Date]

    date-time

    deployedAt

    [Date]

    date-time

    destroyedAt

    [Date]

    date-time

    providerSettings

    X

    CloudProviderSettings

    version

    X

    CloudVersion

    CloudProviderSettings

    Field Name Required Type Description Format

    resourceGroupName

    [String]

    region

    AwsRegions

    aksClusterName

    [String]

    dnsPrefix

    [String]

    defaultNodePoolName

    [String]

    tags

    Map of [string]

    vNetCidr

    [String]

    vNetName

    [String]

    storageAccountName

    [String]

    configContainerName

    [String]

    importContainerName

    [String]

    availabilityZones

    List of [string]

    azCount

    [Integer]

    deploymentName

    [String]

    msiName

    [String]

    tenantId

    [String]

    subscriptionId

    [String]

    bucket

    [String]

    supportBucket

    [String]

    accountId

    [String]

    vpcCidr

    [String]

    vpcId

    [String]

    stackId

    [String]

    privateSubnets

    List of [string]

    availabilityZone

    List of [string]

    lastRotated

    [Date]

    date-time

    CloudStatus

    Type

    Enum

    Allowable Values

    needs_bootstrap, preflight_started, preflight_failed, preflight_succeeded, bootstrap_succeeded, deploying, deploy_failed, deploy_succeeded, ready, destroying, destroy_failed, destroy_succeeded, needs_cleanup, management_blocked, upgrading

    CloudSummary

    Field Name Required Type Description Format

    id

    X

    [UUID]

    uuid

    name

    X

    [String]

    status

    X

    CloudStatus

    provider

    X

    Provider

    region

    X

    Regions

    virtualNetworkID

    X

    [String]

    virtualNetworkCIDR

    X

    [String]

    CloudVersion

    Field Name Required Type Description Format

    name

    X

    [String]

    components

    X

    Map of [string]

    Cluster

    Field Name Required Type Description Format

    id

    X

    [String]

    name

    X

    [String]

    tenantId

    X

    [String]

    cloudId

    X

    [String]

    projectId

    X

    [String]

    status

    X

    ClusterStatus

    resourceIdentifier

    X

    [String]

    Resource identifier name linked with the Cloud Provider

    createdAt

    [Date]

    date-time

    updatedAt

    [Date]

    date-time

    deployedAt

    [Date]

    date-time

    version

    ClusterVersion

    endpointsURL

    List of [string]

    privateEndpointURL

    List of [string]

    endpointsSrv

    [String]

    privateEndpointsSrv

    [String]

    ClusterHealth

    Type

    Enum

    Allowable Values

    healthy, unhealthy, degraded, failedOver, inactiveFailed, N/A

    Description

    • healthy - denotes that the resource is in a healthy state.

    • unhealthy - denotes that the resource is in an uhealthy state.

    • degraded - is reported for the overall health of a cluster or overall health for all nodes if all unhealthy nodes in the cluster are failed over.

    • failedOver - enotes that a couchbase server node failed over to a new pod. This status is attached only to a node.

    • inactiveFailed - is the value of the cluster membership as reported for a couchbase server node when it is in failed over state.

    • N/A - is the value of the cluster membership if we are unable to determine the health of the cluster

    ClusterHealthResponse

    Field Name Required Type Description Format

    status

    X

    ClusterStatus

    health

    X

    ClusterHealth

    bucketStats

    BucketStats

    nodeStats

    NodeStats

    ClusterStatus

    Type

    Enum

    Allowable Values

    draft, needs_deploy, job_scheduled, deploying, deploy_failed, deploy_succeeded, ready, destroying, destroy_failed, destroy_succeeded, metrics_failed, preflight_started, preflight_failed, preflight_succeeded, management_blocked, upgrading

    Description

    • draft - indicates that all fields under database model are mutable.

    • needs_deploy - indicates that the new configuration changes have not been applied to the cluster

    • job_scheduled - indicates that the new configuration changes have been scheduled to be applied.

    • deploying - indicates that database is currently being deployed/new configurations being applied.

    • deploy_failed - indicates that the last deployment failed.

    • deploy_succeeded - indicates that the last deployment succeeded.

    • ready - indicates that the database is ready.

    • destroying - indicates that the database is being destroyed.

    • destroy_failed - indicates that the database destroy job failed.

    • destroy_succeeded - indicates that the database destroy job succeeded.

    • metrics_failed - indicates that the database is not serving metrics.

    • preflight_started - indicates a preflight check has started on the database

    • preflight_failed - indicates a preflight check has failed on the database

    • preflight_succeeded - indicates a preflight check has succeeded on the database

    • management_blocked - indicates the IAM credentiald for the cloud hosting the databse have been deleted.

    • upgrading - indicates the database is being upgrading.

    ClusterStatusResponse

    Field Name Required Type Description Format

    status

    X

    ClusterStatus

    ClusterSummary

    Field Name Required Type Description Format

    id

    X

    [UUID]

    uuid

    name

    X

    [String]

    tenantId

    X

    [UUID]

    uuid

    cloudId

    X

    [UUID]

    uuid

    projectId

    X

    [UUID]

    uuid

    services

    X

    List of CouchbaseServices

    nodes

    X

    [Integer]

    ClusterVersion

    Field Name Required Type Description Format

    name

    X

    [String]

    components

    X

    Map of [string]

    ClusterVersions

    Type

    Enum

    Allowable Values

    latest, enterprise-6.5.0, enterprise-6.5.1, enterprise-6.6.0

    Description

    If not defined the latest version of Couchbase Server is deployed. * latest - the a static version representing a deployment of the most recent dataplane components

    ConflictResolution

    Type

    Enum

    Allowable Values

    lww, seqno

    CouchbaseBucketSpec

    Field Name Required Type Description Format

    name

    X

    [String]

    memoryQuota

    X

    [Integer]

    replicas

    [Integer]

    conflictResolution

    ConflictResolution

    CouchbaseServices

    Type

    Enum

    Allowable Values

    data, index, query, search, eventing, analytics

    CreateClusterRequest

    Field Name Required Type Description Format

    name

    X

    [String]

    cloudId

    X

    [UUID]

    uuid

    projectId

    X

    [UUID]

    uuid

    servers

    List of Server

    supportPackage

    CreateClusterRequestSupportPackage

    version

    ClusterVersions

    CreateClusterRequestSupportPackage

    Field Name Required Type Description Format

    type

    X

    SupportPackageType

    timezone

    X

    SupportTimezones

    CreateDatabaseUserRequest

    Field Name Required Type Description Format

    userId

    [UUID]

    Organization user which is assigned to the database user.

    uuid

    username

    X

    [String]

    password

    X

    [String]

    buckets

    List of BucketRole

    allBucketsAccess

    BucketRoleTypes

    CreateProjectRequest

    Field Name Required Type Description Format

    name

    X

    [String]

    Cursor

    Field Name Required Type Description Format

    pages

    X

    CursorPages

    hrefs

    X

    CursorHrefs

    CursorHrefs

    Field Name Required Type Description Format

    first

    X

    [URI]

    uri

    last

    [URI]

    uri

    previous

    [URI]

    uri

    next

    [URI]

    uri

    CursorPages

    Field Name Required Type Description Format

    page

    [Integer]

    Current page starting from 1.

    next

    [Integer]

    Next page number, it is not set on the last page.

    previous

    [Integer]

    Previous page number, it is not set on the first page.

    last

    [Integer]

    Last page number.

    perPage

    [Integer]

    How many items are displayed in the page.

    totalItems

    X

    [Integer]

    Total items found by the given query.

    DeleteAllowListEntryRequest

    Field Name Required Type Description Format

    cidrBlock

    X

    [String]

    DeleteBucketRequest

    Field Name Required Type Description Format

    name

    X

    [String]

    The name of the bucket to be deleted

    GetCertificateResponse

    Field Name Required Type Description Format

    certificate

    X

    [String]

    Goof

    Field Name Required Type Description Format

    message

    X

    [String]

    errorType

    X

    [String]

    ListAllowListResponse

    Field Name Required Type Description Format

    ListBucketItem

    Field Name Required Type Description Format

    id

    X

    [String]

    name

    X

    [String]

    memoryQuota

    X

    [Integer]

    replicas

    X

    [Integer]

    conflictResolution

    X

    ConflictResolution

    status

    X

    [String]

    ListBucketsResponse

    Field Name Required Type Description Format

    ListCloudsResponse

    Field Name Required Type Description Format

    cursor

    X

    Cursor

    data

    X

    List of CloudSummary

    ListClustersResponse

    Field Name Required Type Description Format

    cursor

    X

    Cursor

    data

    X

    List of ClusterSummary

    ListDatabaseUsersResponse

    Field Name Required Type Description Format

    ListDatabaseUsersResponseItem

    Field Name Required Type Description Format

    userId

    [UUID]

    Organization user ID Database user is attached to

    uuid

    username

    X

    [String]

    access

    X

    List of BucketRole

    ListProjectsResponse

    Field Name Required Type Description Format

    cursor

    X

    Cursor

    data

    X

    List of Project

    ListUsersResponse

    Field Name Required Type Description Format

    cursor

    X

    Cursor

    data

    X

    List of ListUsersResponseItem

    ListUsersResponseItem

    Field Name Required Type Description Format

    id

    X

    [UUID]

    uuid

    name

    X

    [String]

    email

    X

    [String]

    NodeStats

    Field Name Required Type Description Format

    status

    X

    [String]

    totalCount

    X

    [Integer]

    failedOverCount

    X

    [Integer]

    unhealthyCount

    X

    [Integer]

    serviceStats

    X

    List of ServiceStats

    Project

    Field Name Required Type Description Format

    id

    X

    [UUID]

    uuid

    name

    X

    [String]

    tenantId

    X

    [UUID]

    uuid

    createdAt

    X

    [Date]

    Creation date and time

    date-time

    Provider

    Type

    Enum

    Allowable Values

    aws, gcp, azure

    Regions

    Field Name Required Type Description Format

    Server

    Field Name Required Type Description Format

    size

    X

    [Integer]

    services

    X

    List of CouchbaseServices

    aws

    ServerAws

    azure

    ServerAzure

    ServerAws

    Field Name Required Type Description Format

    instanceSize

    X

    AwsInstances

    ebsSizeGib

    X

    [Integer]

    ServerAzure

    Field Name Required Type Description Format

    instanceSize

    X

    AzureInstances

    volumeType

    X

    AzureVolumeTypes

    ServiceStats

    Field Name Required Type Description Format

    services

    X

    List of [string]

    nodeName

    X

    [String]

    status

    X

    [String]

    StatusOK

    Field Name Required Type Description Format

    status

    X

    [String]

    SupportPackageType

    Type

    Enum

    Allowable Values

    enterprise, developerPro, forumSupport

    SupportTimezones

    Type

    Enum

    Allowable Values

    ET, GMT, IST, PT

    Description

    • ET - Eastern Time

    • GMT - Greenwich Mean Time

    • IST - India Standard Time

    • PT - Pacific Time

    UpdateAllowListRequest

    Field Name Required Type Description Format

    UpdateBucketRequest

    Field Name Required Type Description Format

    memoryQuota

    X

    [Integer]

    UpdateBucketSpec

    Field Name Required Type Description Format

    UpdateDatabaseUserRequest

    Field Name Required Type Description Format

    userId

    [UUID]

    Organization user to update which is assigned to the database user.

    uuid

    username

    [String]

    password

    [String]

    buckets

    List of BucketRole

    allBucketsAccess

    BucketRoleTypes

    V3BucketRoles

    Type

    Enum

    Allowable Values

    data_writer, data_reader

    Description

    • data_writer - Gives the user permission to read and write data for the bucket.

    • data_reader - Gives the user read-only permission for the bucket.

    V3Cluster

    Field Name Required Type Description Format

    id

    X

    [String]

    name

    X

    [String]

    tenantId

    X

    [String]

    projectId

    X

    [String]

    createdAt

    X

    [Date]

    date-time

    updatedAt

    X

    [Date]

    date-time

    status

    X

    [String]

    version

    X

    V3ClusterVersion

    endpointsSrv

    [String]

    environment

    X

    [String]

    place

    X

    V3ClusterPlace

    servers

    X

    List of V3ClusterServers

    availabilityZones

    X

    List of [string]

    support

    X

    [String]

    V3ClusterList

    Field Name Required Type Description Format

    cursor

    X

    Cursor

    data

    X

    V3ClusterListData

    V3ClusterListData

    Field Name Required Type Description Format

    tenantId

    [String]

    items

    List of V3ClusterListDataItems

    V3ClusterListDataItems

    Field Name Required Type Description Format

    environment

    X

    [String]

    cloudId

    [String]

    id

    X

    [String]

    name

    X

    [String]

    projectId

    X

    [String]

    V3ClusterPlace

    Field Name Required Type Description Format

    provider

    X

    [String]

    region

    X

    [String]

    CIDR

    X

    [String]

    V3ClusterServers

    Field Name Required Type Description Format

    size

    X

    [Integer]

    compute

    X

    [String]

    Compute instance type

    services

    X

    List of [string]

    storage

    X

    V3ClusterStorage

    V3ClusterStatus

    Type

    Enum

    Allowable Values

    draft, deploying, scaling, upgrading, rebalancing, peering, destroying, healthy, degraded, deploymentFailed, scaleFailed, upgradeFailed, rebalanceFailed, peeringFailed, destroyFailed

    V3ClusterStatusResponse

    Field Name Required Type Description Format

    status

    X

    V3ClusterStatus

    V3ClusterStorage

    Field Name Required Type Description Format

    type

    X

    [String]

    IOPS

    X

    [Integer]

    size

    X

    [Integer]

    V3ClusterVersion

    Field Name Required Type Description Format

    name

    X

    [String]

    components

    X

    V3ClusterVersionComponents

    V3ClusterVersionComponents

    Field Name Required Type Description Format

    cbServerVersion

    X

    [String]

    V3CouchbaseServices

    Type

    Enum

    Allowable Values

    data, index, query, search, eventing, analytics

    V3CreateClusterRequest

    Field Name Required Type Description Format

    environment

    X

    V3Environment

    clusterName

    X

    [String]

    Name of the cluster

    projectId

    X

    [UUID]

    Uniquely identifiable projectId

    uuid

    description

    [String]

    A short description that describes the cluster

    place

    X

    V3Place

    servers

    X

    List of V3Servers

    Server specifications for creating the cluster

    supportPackage

    X

    V3SupportPackage

    V3CreateClusterUserRequest

    Field Name Required Type Description Format

    username

    X

    [String]

    password

    X

    [String]

    allBucketsAccess

    V3BucketRoles

    buckets

    List of V3CreateClusterUserRequestBuckets

    V3CreateClusterUserRequestBuckets

    Field Name Required Type Description Format

    name

    X

    [String]

    scope

    X

    [String]

    enter '*' for getting access to all scopes within a bucket or the scope name for getting access to a single scope

    access

    X

    V3BucketRoles

    V3Environment

    Type

    Enum

    Allowable Values

    hosted, vpc

    V3Place

    Field Name Required Type Description Format

    singleAZ

    X

    [Boolean]

    Has to be true if the supportPackage.type is equal to "Basic"

    hosted

    V3PlaceHosted

    V3PlaceHosted

    Field Name Required Type Description Format

    provider

    X

    V3Provider

    region

    X

    [String]

    A valid region for the cloudProvider

    CIDR

    X

    [String]

    CIDR block.

    V3Provider

    Type

    Enum

    Allowable Values

    aws, azure, gcp

    V3Servers

    Field Name Required Type Description Format

    size

    X

    [Integer]

    How many nodes, value >= 3, ⇐ 27. Total nodes in the cluster ⇐ 27

    compute

    X

    [String]

    Compute instance type

    services

    X

    List of V3CouchbaseServices

    Array of couchbase services to be installed on the nodes

    storage

    X

    V3ServersStorage

    V3ServersStorage

    Field Name Required Type Description Format

    type

    X

    V3StorageType

    IOPS

    [Integer]

    Required for GP3 and IO2. Min 3000 for GP3, 1000 if IO2. If storageType="GP3", max = 16000. If storageType= "IO2", max= 64000

    size

    X

    [Integer]

    Min 50GB, max 16TB

    V3StorageType

    Type

    Enum

    Allowable Values

    GP3, IO2, PD-SSD

    V3SupportPackage

    Field Name Required Type Description Format

    timezone

    X

    V3SupportPackageTimezones

    type

    X

    V3SupportPackageType

    V3SupportPackageTimezones

    Type

    Enum

    Allowable Values

    ET, GMT, IST, PT

    Description

    • ET - Eastern Time

    • GMT - Greenwich Mean Time

    • IST - India Standard Time

    • PT - Pacific Time

    V3SupportPackageType

    Type

    Enum

    Allowable Values

    Basic, DeveloperPro, Enterprise

    V3UpdateClusterMetaRequest

    Field Name Required Type Description Format

    name

    [String]

    description

    [String]

    V3UpdateClusterServersRequest

    Field Name Required Type Description Format

    servers

    X

    List of V3Servers

    V3UpdateClusterSupportRequest

    Field Name Required Type Description Format

    supportPackage

    X

    V3UpdateClusterSupportRequestSupportPackage

    V3UpdateClusterSupportRequestSupportPackage

    Field Name Required Type Description Format

    timezone

    V3SupportPackageTimezones

    type

    X

    V3SupportPackageType