Overview of the Public API

    +
    RESTful APIs for Couchbase Cloud.

    We are creating a series of RESTful APIs that are intended to enable our customers to integrate with Couchbase Cloud to perform operations such as:

    • Onboarding and offboarding users.

    • Managing the lifecycle of a cluster.

    • Getting monitoring information for a cluster.

    The capabilities of the Public API will extend as we iterate and release new endpoints. This first iteration of the Public API focuses on the lifecycle of a cluster and associated functionality. You will be able to:

    • Clouds — List clouds and obtain detailed information about them.

    • Projects — List, Create and Delete projects.

    • Clusters — List, Create, and Delete clusters — and its buckets and users — and manage access with the Allow List.

    Couchbase Cloud Public APIs

    The REST API guide can be found here, along with links to the fully documented openapi.yaml file. By importing the yaml file into tools such as Postman, Insomnia or similar, you will be able to see the exact details for each API. Postman showing information for Public API after importing yaml file.

    API summary

    A summary of the Public APIs is shown below

    API Methods Description

    {baseURL}/v2/status [1]

    GET

    Returns the status of Public APIs

    {baseURL}/v2/clouds

    GET

    Returns a paginated list of summary information about each cloud

    {baseURL}/v2/clouds/{id}

    GET

    Returns detailed information about a cloud

    {baseURL}/v2/projects

    GET, POST

    Returns a paginated list of summary information about each project ( GET ) or to create a project ( POST )

    {baseURL}/v2/projects/{id}

    GET, DELETE

    Returns detailed information about a project ( GET ) or deletes it ( DELETE )

    {baseURL}/v2/clusters

    GET, POST

    Returns a paginated list of summary information about each cluster ( GET ) or to create a cluster ( POST )

    {baseURL}/v2/clusters/{id}

    GET, DELETE

    Returns detailed information about a project ( GET ) or deletes it ( DELETE )

    {baseURL}/v2/clusters/{id}/buckets

    GET, POST, DELETE

    Returns detailed information about a bucket ( GET ), creates a bucket ( POST ) or deletes it ( DELETE )

    {baseURL}/v2/clusters/{id}/allowlist

    GET, POST, DELETE

    Returns detailed information about an allow list ( GET ), creates an allow list ( POST ) or deletes it ( DELETE )


    1. {baseURL} refers to the URL used with the API, https://cloudapi.cloud.couchbase.com