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.

Management API v3.0 Reference

  • Capella Operational
  • reference
    +
    Deprecation Notice

    The Management API v3.0 is deprecated and will be removed in future. Users of the Management API v3.0 must plan to migrate to the Management API v4.0. See Manage Deployments with the Management API v4.0.

    Overview

    Reference guide for the Couchbase Capella Management API v3.0, formerly known as the Public API.

    You can download the specification for this REST API as an OpenAPI file to import into tools such as Postman, Insomnia, or similar: openapi.yaml.

    Version information

    Version : 2.0.0

    Host information

    https://cloudapi.cloud.couchbase.com

    Resources

    This section describes the operations available with this REST API. The operations are grouped in the following categories.

    ClustersV3
    Default
    EventsV3
    Projects
    Status
    Users

    ClustersV3

    Table of Contents

    Create Cluster Audit Log Export
    List Cluster Audit Log Exports
    Get Cluster Audit Log Request
    Configure Cluster Audit Settings
    Create Cluster V3
    Create cluster user
    Delete Cluster V3
    Deletes the database's on/off schedule
    Get Cluster Audit Settings
    List Filterable Audit Events
    Gets the database's on/off schedule
    List all clusters v3
    Modifies the database's on/off schedule
    Turn off selected database
    Turn on the selected database
    Get Cluster Info V3
    Get Cluster Status V3
    Update Cluster Metadata V3
    Update Cluster Servers V3
    Update Cluster Support Package V3

    Create Cluster Audit Log Export

    POST /v3/clusters/{id}/auditlogs
    Description

    Creates a new request for the export of audit log files that cover a user-specified time-period. The returned value includes a download ID, which can be referenced in a subsequent Get Audit Log Request call. Time stamps must be in RFC3339 format.

    Body Parameter
    Name Description Schema

    Body
    optional

    V3ClusterAuditLogExportCreate
    Produces

    • application/json

    Consumes

    • application/json

    Responses
    HTTP Code Description Schema

    202

    Success

    V3ClusterAuditLogExportDownloadID

    403

    Access forbidden

    Goof

    405

    Method not allowed

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Security
    Type Name

    http (bearer)

    Token

    List Cluster Audit Log Exports

    GET /v3/clusters/{id}/auditlogs
    Description

    Returns a list of all audit log export requests. The list starts with the most recent request. The information returned for each request includes the time of the request’s creation, the start and end times of the period for which records are required, a download URL for retrieval of a compressed file that contains the log files, and the progress-status of the request. When progress-status is 'ready', the compressed file can be manually downloaded, using the download URL.

    Produces

    • application/json

    Responses
    HTTP Code Description Schema

    200

    Success

    V3ClusterAuditLogExportList

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Security
    Type Name

    http (bearer)

    Token

    Get Cluster Audit Log Request

    GET /v3/clusters/{id}/auditlogs/{downloadId}
    Description

    Returns a specific audit log export request. The request is specified with a download ID, previously returned by Create Audit Log Request: the download ID must be appended to the URI of Get Audit Log Request. The information returned for the specified request includes the time of the request’s creation, the start and end times of the period for which records are required, a download URL for retrieval of a compressed file that contains the log files, and the progress-status of the request. When progress-status is 'ready', the compressed file can be manually downloaded, using the download URL.

    Produces

    • application/json

    Responses
    HTTP Code Description Schema

    200

    Success, job being processed

    V3ClusterAuditLogExport

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Security
    Type Name

    http (bearer)

    Token

    Configure Cluster Audit Settings

    POST /v3/clusters/{id}/audit
    Description

    Configures the audit settings for the cluster. This allows auditing to be enabled or disabled for the cluster. It also allows specific audit events to be enabled, and specific users to be disabled.

    Path Parameters
    Name Description Schema

    id
    required

    Cluster ID

    UUID (uuid)
    Body Parameter
    Name Description Schema

    Body
    optional

    V3ClusterAuditSettings
    Consumes

    • application/json

    Security
    Type Name

    http (bearer)

    Token

    Create Cluster V3

    POST /v3/clusters
    Description

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

    Body Parameter
    Name Description Schema

    Body
    optional

    V3CreateClusterRequest
    Produces

    • application/json

    Consumes

    • application/json

    Responses
    HTTP Code Description Schema

    202

    Success

    403

    Access forbidden

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Security
    Type Name

    http (bearer)

    Token

    Create cluster user

    POST /v3/clusters/{id}/users
    Description

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

    Path Parameters
    Name Description Schema

    id
    required

    Cluster ID

    UUID (uuid)
    Body Parameter
    Name Description Schema

    Body
    optional

    V3CreateClusterUserRequest
    Produces

    • application/json

    Consumes

    • application/json

    Responses
    HTTP Code Description Schema

    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
    Security
    Type Name

    http (bearer)

    Token

    Delete Cluster V3

    DELETE /v3/clusters/{id}
    Description

    Starts the deletion process for the cluster

    Path Parameters
    Name Description Schema

    id
    required

    Cluster ID

    UUID (uuid)
    Produces

    • application/json

    Responses
    HTTP Code Description Schema

    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
    Security
    Type Name

    http (bearer)

    Token

    Deletes the database's on/off schedule

    DELETE /v3/clusters/{id}/schedulesonoff
    Description

    Sends a request to delete the cluster On/Off schedule.

    Path Parameters
    Name Description Schema

    id
    required

    Cluster ID

    UUID (uuid)
    Produces

    • application/json

    Responses
    HTTP Code Description Schema

    202

    Deletes the on/off schedule for the database

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    500

    An internal server error occurred while attempting to delete the on/off schedule

    Goof
    Security
    Type Name

    http (bearer)

    Token

    Get Cluster Audit Settings

    GET /v3/clusters/{id}/audit
    Description

    Retrieves the current audit settings for the cluster; including a list of all enabled audit events, a list of disabled users, and the overall enablement status of the cluster.

    Path Parameters
    Name Description Schema

    id
    required

    Cluster ID

    UUID (uuid)
    Produces

    • application/json

    Responses
    HTTP Code Description Schema

    200

    Returns the current Audit settings for the cluster

    V3ClusterAuditSettings

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    500

    Internal server error

    Goof
    Security
    Type Name

    http (bearer)

    Token

    List Filterable Audit Events

    GET /v3/clusters/{id}/auditdescriptors
    Description

    Returns the list of all filterable audit events for the cluster. Filterable audit events are those that can be either disabled or enabled. If a filterable audit event is currently disabled, it can be enabled through its inclusion in the enabledEventIDs field of Configure Cluster Audit Settings.

    Path Parameters
    Name Description Schema

    id
    required

    Cluster ID

    UUID (uuid)
    Produces

    • application/json

    Responses
    HTTP Code Description Schema

    200

    Returns the list of filterable Audit Events for the cluster.

    V3ClusterAuditFilterableEventList

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    500

    Internal server error

    Goof
    Security
    Type Name

    http (bearer)

    Token

    Gets the database's on/off schedule

    GET /v3/clusters/{id}/schedulesonoff
    Description

    Sends a request to get the cluster On/Off schedule.

    Path Parameters
    Name Description Schema

    id
    required

    Cluster ID

    UUID (uuid)
    Produces

    • application/json

    Responses
    HTTP Code Description Schema

    202

    Returns the on/off schedule for the database

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    500

    An internal server error occurred while attempting to get the on/off schedule

    Goof
    Security
    Type Name

    http (bearer)

    Token

    List all clusters v3

    GET /v3/clusters
    Description

    Returns a paginated list of all clusters

    Query Parameters
    Name Description Schema

    page
    optional

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

    Integer

    perPage
    optional

    Sets what page you would like to view

    Integer

    cloudId
    optional

    Cloud ID for filtering cloud clusters.

    UUID (uuid)

    projectId
    optional

    Project ID for filtering project clusters.

    UUID (uuid)
    Produces

    • application/json

    Responses
    HTTP Code Description Schema

    200

    Success

    V3ClusterList

    403

    Access forbidden

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Security
    Type Name

    http (bearer)

    Token

    Modifies the database's on/off schedule

    POST /v3/clusters/{id}/schedulesonoff
    Description

    Sends a request to modify the cluster On/Off schedule.

    Path Parameters
    Name Description Schema

    id
    required

    Cluster ID

    UUID (uuid)
    Body Parameter
    Name Description Schema

    Body
    optional

    V3ModifyOnOffSchedule
    Produces

    • application/json

    Consumes

    • application/json

    Responses
    HTTP Code Description Schema

    202

    Modifies the on/off schedule for the database

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    500

    An internal server error occurred while attempting to modify the on/off schedule

    Goof
    Security
    Type Name

    http (bearer)

    Token

    Turn off selected database

    POST /v3/clusters/{id}/off
    Description

    Sends a request to turn off a database from a healthy state.

    Path Parameters
    Name Description Schema

    id
    required

    Cluster ID

    UUID (uuid)
    Produces

    • application/json

    Responses
    HTTP Code Description Schema

    202

    Successfully turning the cluster off

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    409

    Cluster in an invalid state to turn off

    Goof

    500

    Internal server error whilst attempting to turn off a cluster

    Goof
    Security
    Type Name

    http (bearer)

    Token

    Turn on the selected database

    POST /v3/clusters/{id}/on
    Description

    Sends a request to turn a database back on from an off state.

    Path Parameters
    Name Description Schema

    id
    required

    Cluster ID

    UUID (uuid)
    Body Parameter
    Name Description Schema

    Body
    optional

    V3TurnOn
    Produces

    • application/json

    Consumes

    • application/json

    Responses
    HTTP Code Description Schema

    202

    Successfully turning the cluster on

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    409

    Cluster in an invalid state to turn on

    Goof

    500

    Internal server error whilst attempting to turn on a cluster

    Goof
    Security
    Type Name

    http (bearer)

    Token

    Get Cluster Info V3

    GET /v3/clusters/{id}
    Description

    Retrieves cluster information using the provided cluster ID

    Path Parameters
    Name Description Schema

    id
    required

    Cluster ID

    UUID (uuid)
    Produces

    • application/json

    Responses
    HTTP Code Description Schema

    200

    If found, returns the cluster information

    V3Cluster

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    500

    Internal server error

    Goof
    Security
    Type Name

    http (bearer)

    Token

    Get Cluster Status V3

    GET /v3/clusters/{id}/status
    Description

    Gets cluster status

    Path Parameters
    Name Description Schema

    id
    required

    Cluster ID

    UUID (uuid)
    Produces

    • application/json

    Responses
    HTTP Code Description Schema

    200

    Cluster status

    V3ClusterStatusResponse
    Security
    Type Name

    http (bearer)

    Token

    Update Cluster Metadata V3

    PUT /v3/clusters/{id}/meta
    Description

    Updates the cluster metadata

    Path Parameters
    Name Description Schema

    id
    required

    Cluster ID

    UUID (uuid)
    Body Parameter
    Name Description Schema

    Body
    optional

    V3UpdateClusterMetaRequest
    Produces

    • application/json

    Consumes

    • application/json

    Responses
    HTTP Code Description Schema

    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
    Security
    Type Name

    http (bearer)

    Token

    Update Cluster Servers V3

    PUT /v3/clusters/{id}/servers
    Description

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

    Path Parameters
    Name Description Schema

    id
    required

    Cluster ID

    UUID (uuid)
    Body Parameter
    Name Description Schema

    Body
    optional

    V3UpdateClusterServersRequest
    Produces

    • application/json

    Consumes

    • application/json

    Responses
    HTTP Code Description Schema

    202

    Success

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Security
    Type Name

    http (bearer)

    Token

    Update Cluster Support Package V3

    PUT /v3/clusters/{id}/support
    Description

    Updates the cluster support package details

    Path Parameters
    Name Description Schema

    id
    required

    Cluster ID

    UUID (uuid)
    Body Parameter
    Name Description Schema

    Body
    optional

    V3UpdateClusterSupportRequest
    Produces

    • application/json

    Consumes

    • application/json

    Responses
    HTTP Code Description Schema

    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
    Security
    Type Name

    http (bearer)

    Token

    Default

    Table of Contents

    Get User

    Get User

    GET /v2/users/{id}
    Description
    Path Parameters
    Name Description Schema

    id
    required

    User ID

    UUID (uuid)
    Produces

    • application/json

    Responses
    HTTP Code Description Schema

    200

    Success

    User

    403

    Access forbidden

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Security
    Type Name

    http (bearer)

    Token

    EventsV3

    Table of Contents

    List Events
    List Event

    List Events

    GET /v3/events
    Description

    Return a paginated list of organization Events.

    Query Parameters
    Name Description Schema

    page
    optional

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

    Integer

    perPage
    optional

    Sets what page you would like to view

    Integer

    sortBy
    optional

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

    String

    from
    optional

    Start point in the last 24 hours, RFC3339 format. Defaults to 24 hours before request.

    Date (date-time)

    to
    optional

    End datetime in the last 24 hours, RFC3339 format. Defaults to Now.

    Date (date-time)

    actor
    optional

    Filter by user UUID. Default returns all.

    UUID (uuid)

    cluster
    optional

    filter by cluster. Default is to return all.

    String

    project
    optional

    Filter by project. Default is to return all.

    String

    severity
    optional

    Filter by severity. Default is to return all.

    String

    tag
    optional

    Filter by tag(s). Default is to return all. Tags are availability, billing, maintenance, performance, security, alert.

    String
    Produces

    • application/json

    Responses
    HTTP Code Description Schema

    200

    Successfully exported events

    ListEventsResponse

    403

    Access forbidden

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Security
    Type Name

    http (bearer)

    Token

    List Event

    GET /v3/events/{id}
    Description

    Return an event

    Path Parameters
    Name Description Schema

    id
    required

    Event ID

    UUID (uuid)
    Produces

    • application/json

    Responses
    HTTP Code Description Schema

    200

    Success

    ListEventsResponse

    403

    Access forbidden

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Security
    Type Name

    http (bearer)

    Token

    Projects

    Table of Contents

    Create project
    Delete project
    List Projects
    Get project by ID

    Create project

    POST /v2/projects
    Description

    Creates project in tenant, returns id of project on success

    Body Parameter
    Name Description Schema

    Body
    optional

    CreateProjectRequest
    Produces

    • application/json

    Consumes

    • application/json

    Responses
    HTTP Code Description Schema

    201

    Success

    Project

    403

    Access forbidden

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Security
    Type Name

    http (bearer)

    Token

    Delete project

    DELETE /v2/projects/{id}
    Description

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

    Path Parameters
    Name Description Schema

    id
    required

    Project ID

    UUID (uuid)
    Produces

    • application/json

    Responses
    HTTP Code Description Schema

    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
    Security
    Type Name

    http (bearer)

    Token

    List Projects

    GET /v2/projects
    Description

    Returns a paginated list of projects created by the tenant

    Query Parameters
    Name Description Schema

    page
    optional

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

    Integer

    perPage
    optional

    Sets what page you would like to view

    Integer

    sortBy
    optional

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

    String
    Produces

    • application/json

    Responses
    HTTP Code Description Schema

    200

    Success

    ListProjectsResponse

    403

    Access forbidden

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Security
    Type Name

    http (bearer)

    Token

    Get project by ID

    GET /v2/projects/{id}
    Description

    Returns the project with the ID

    Path Parameters
    Name Description Schema

    id
    required

    Project ID

    UUID (uuid)
    Produces

    • application/json

    Responses
    HTTP Code Description Schema

    200

    Success

    Project

    403

    Access forbidden

    Goof

    404

    Resource was not found

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Security
    Type Name

    http (bearer)

    Token

    Status

    Table of Contents

    API status

    API status

    GET /v2/status
    Description

    Returns a public API status

    Produces

    • application/json

    Responses
    HTTP Code Description Schema

    200

    Success

    StatusOK

    500

    Internal server error

    Goof
    Example HTTP Request

    Fetch the status of the Management API v3.0.

    Curl request
    curl "$BASEURL/v2/status"

    $BASEURL is the Management API v3.0 base URL.

    Example HTTP Response
    Response 200
    {
  "status": "OK"
}

    Users

    Table of Contents

    List Users

    List Users

    GET /v2/users
    Description

    Return a paginated list of organization Users.

    Query Parameters
    Name Description Schema

    page
    optional

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

    Integer

    perPage
    optional

    Sets what page you would like to view

    Integer

    sortBy
    optional

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

    String
    Produces

    • application/json

    Responses
    HTTP Code Description Schema

    200

    Success

    ListUsersResponse

    403

    Access forbidden

    Goof

    422

    Request validation error

    Goof

    500

    Internal server error

    Goof
    Security
    Type Name

    http (bearer)

    Token

    Definitions

    This section describes the properties consumed and returned by this REST API.

    CreateProjectRequest
    Cursor
    CursorHrefs
    CursorPages
    EventResponse
    Goof
    ListEventsResponse
    ListProjectsResponse
    ListUsersResponse
    ListUsersResponseItem
    Project
    StatusOK
    User
    V3BucketRoles
    V3Cluster
    V3ClusterAuditFilterableEvent
    V3ClusterAuditFilterableEventList
    V3ClusterAuditLogExport
    V3ClusterAuditLogExportCreate
    V3ClusterAuditLogExportDownloadID
    V3ClusterAuditLogExportList
    V3ClusterAuditSettings
    V3ClusterAuditSettingsDisabledUsers
    V3ClusterList
    V3ClusterListData
    V3ClusterListDataItems
    V3ClusterPlace
    V3ClusterServers
    V3ClusterStatus
    V3ClusterStatusResponse
    V3ClusterStorage
    V3ClusterVersion
    V3ClusterVersionComponents
    V3CouchbaseServices
    V3CreateClusterRequest
    V3CreateClusterUserRequest
    V3CreateClusterUserRequestBuckets
    V3Day
    V3DayAll
    v3DayCustom
    V3DayCustomTimeFrom
    V3DayCustomTimeTo
    V3Environment
    V3ModifyOnOffSchedule
    V3Place
    V3PlaceHosted
    V3Provider
    V3Servers
    V3ServersStorage
    V3StorageType
    V3SupportPackage
    V3SupportPackageTimezones
    V3SupportPackageType
    V3TurnOn
    V3UpdateClusterMetaRequest
    V3UpdateClusterServersRequest
    V3UpdateClusterSupportRequest
    V3UpdateClusterSupportRequestSupportPackage

    CreateProjectRequest

    Object

    Property Schema

    name
    required

    String

    Cursor

    Object

    Property Schema

    pages
    required

    CursorPages

    hrefs
    required

    CursorHrefs

    CursorHrefs

    Object

    Property Schema

    first
    required

    URI (uri)

    last
    optional

    URI (uri)

    previous
    optional

    URI (uri)

    next
    optional

    URI (uri)

    CursorPages

    Object

    Property Schema

    page
    optional

    Current page starting from 1.

    Integer

    next
    optional

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

    Integer

    previous
    optional

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

    Integer

    last
    optional

    Last page number.

    Integer

    perPage
    optional

    How many items are displayed in the page.

    Integer

    totalItems
    required

    Total items found by the given query.

    Integer

    EventResponse

    Object

    Property Schema

    id
    required

    Unique ID of the event

    String

    key
    required

    Key defines the specific kind of Event. One from availability, billing, maintenance, performance or security

    String

    severity
    optional

    The severity of the event. One from info, warning or critical

    String

    time
    required

    When the event happened, in RFC3339 format

    Date (date-time)

    tenantId
    required

    The TenantID this Event belongs to

    String

    tenantName
    optional

    The name of the tenant at the time of event

    String

    cloudId
    optional

    The CloudID this Event refers to, only populated for In-VPC cluster

    String

    cloudName
    optional

    CloudName is the name of the cloud at the time of event emission.

    String

    projectId
    optional

    The ProjectID this Event refers to

    String

    projectName
    optional

    ProjectName is the name of the project at the time of event emission

    String

    clusterId
    optional

    The ClusterID this Event refers to

    String

    clusterName
    optional

    ClusterName is the name of the cluster at the time of event emission

    String

    syncGatewayId
    optional

    The SyncGatewayID this Event refers to

    String

    syncGatewayName
    optional

    SyncGatewayName is the name of the sync gateway at the time of event emission

    String

    actorId
    optional

    ActorID is the user id that initiated the request for this Event

    String

    actorName
    optional

    ActorName is the name of the associated user at the time of event emission

    String

    sessionId
    optional

    SessionID is the user that initiated the request for this Event

    String

    requestId
    optional

    RequestID string

    String

    summary
    optional

    Summary of the event

    String

    Goof

    Object

    Property Schema

    message
    required

    String

    errorType
    required

    String

    ListEventsResponse

    Object

    Property Schema

    cursor
    required

    Cursor

    data
    required

    EventResponse array

    ListProjectsResponse

    Object

    Property Schema

    cursor
    required

    Cursor

    data
    required

    Project array

    ListUsersResponse

    Object

    Property Schema

    cursor
    required

    Cursor

    data
    required

    ListUsersResponseItem array

    ListUsersResponseItem

    Object

    Property Schema

    id
    required

    UUID (uuid)

    name
    required

    String

    email
    required

    String

    Project

    Object

    Property Schema

    id
    required

    UUID (uuid)

    name
    required

    String

    tenantId
    required

    UUID (uuid)

    createdAt
    required

    Creation date and time

    Example: 2021-01-30T08:30Z

    Date (date-time)

    StatusOK

    Object

    Property Schema

    status
    required

    String

    User

    Object

    Property Schema

    id
    required

    UUID (uuid)

    name
    required

    String

    email
    required

    String

    mfaEnabled
    required

    Boolean

    region
    required

    String

    timezone
    required

    String

    emailNotifications
    required

    Boolean

    createdAt
    required

    Creation date and time

    Example: 2021-01-30T08:30Z

    Date (date-time)

    roles
    required

    String array

    V3BucketRoles

    String

    • 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.

    Values: data_writer, data_reader

    V3Cluster

    Object

    Property Schema

    id
    required

    String

    name
    required

    String

    tenantId
    required

    String

    projectId
    required

    String

    createdAt
    required

    Date (date-time)

    updatedAt
    required

    Date (date-time)

    status
    required

    String

    version
    required

    V3ClusterVersion

    endpointsSrv
    optional

    String

    environment
    required

    String

    place
    required

    V3ClusterPlace

    servers
    required

    V3ClusterServers array

    availabilityZones
    required

    String array

    support
    required

    String

    V3ClusterAuditFilterableEvent

    Object

    Property Schema

    id
    optional

    The event ID.

    Integer

    name
    optional

    The event name.

    String

    module
    optional

    The event module.

    String

    description
    optional

    A description of the event.

    String

    V3ClusterAuditFilterableEventList

    Object

    Property Schema

    events
    optional

    V3ClusterAuditFilterableEvent array

    V3ClusterAuditLogExport

    Object

    Property Schema

    status
    optional

    String

    downloadID
    optional

    String

    downloadURL
    optional

    String

    expiration
    optional

    Date (date-time)

    createdAt
    optional

    Date (date-time)

    start
    optional

    Date (date-time)

    end
    optional

    Date (date-time)

    V3ClusterAuditLogExportCreate

    Object

    Property Schema

    start
    required

    Start time of requested audit logs. Must be at least 15 minutes in the past, and not exceed 30 days in the past.

    Date (date-time)

    end
    optional

    End time of requested audit logs. Must be at least 15 minutes after the given start time. Defaults to now.

    Date (date-time)

    V3ClusterAuditLogExportDownloadID

    Object

    Property Schema

    downloadID
    optional

    String

    V3ClusterAuditLogExportList

    Object

    Property Schema

    cursor
    required

    Cursor

    data
    required

    V3ClusterAuditLogExport array

    V3ClusterAuditSettings

    Object

    Property Schema

    auditdEnabled
    required

    Controls whether Audit logging is enabled or disabled.

    Example: true

    Boolean

    enabledEventIDs
    optional

    The disabled parameter indicates which individual filterable events are disabled. Its value must be one or more filterable-event IDs. Filterable-event IDs can be retrieved by means of the GET /clusters/{id}/audit/descriptors method and URI.

    Integer array

    disabledUsers
    optional

    The disabledUsers parameter disables filterable-event auditing on a per user basis. Its value must be an array of users, specified as objects with both name and domain fields. Each user may be: - A local user, specified in the form {name:"localusername", domain:"local"}. - An external user, specified in the form {name:"externalusername", domain:"external"}. - An internal user, specified in the form {name:"@internalusername", domain:"local"}. Available internal users are @eventing, @cbq-engine, @ns_server, @index, @projector, @goxdcr, @fts, and @cbas. If auditdEnabled is true, and one or more users are specified as the value of disabledUsers, only filterable events are ignored for those users: non-filterable events continue to be audited.

    V3ClusterAuditSettingsDisabledUsers array

    V3ClusterAuditSettingsDisabledUsers

    Object

    Property Schema

    name
    required

    The name of the user.

    String

    domain
    optional

    The domain of the user.

    Values: local, external

    String

    V3ClusterList

    Object

    Property Schema

    cursor
    required

    Cursor

    data
    required

    V3ClusterListData

    V3ClusterListData

    Object

    Property Schema

    tenantId
    optional

    String

    items
    optional

    V3ClusterListDataItems array

    V3ClusterListDataItems

    Object

    Property Schema

    environment
    required

    String

    cloudId
    optional

    String

    id
    required

    String

    name
    required

    String

    projectId
    required

    String

    V3ClusterPlace

    Object

    Property Schema

    provider
    required

    String

    region
    required

    String

    CIDR
    required

    String

    V3ClusterServers

    Object

    Property Schema

    size
    required

    Integer

    compute
    required

    Compute instance type

    String

    services
    required

    String array

    storage
    required

    V3ClusterStorage

    V3ClusterStatus

    String

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

    V3ClusterStatusResponse

    Object

    Property Schema

    status
    required

    V3ClusterStatus

    V3ClusterStorage

    Object

    Property Schema

    type
    required

    String

    IOPS
    required

    Integer

    size
    required

    Integer

    V3ClusterVersion

    Object

    Property Schema

    name
    required

    String

    components
    required

    V3ClusterVersionComponents

    V3ClusterVersionComponents

    Object

    Property Schema

    cbServerVersion
    required

    String

    V3CouchbaseServices

    String

    Values: data, index, query, search, eventing, analytics

    V3CreateClusterRequest

    Object

    Property Schema

    environment
    required

    V3Environment

    clusterName
    required

    Name of the cluster

    Minimum length: 2
    Maximum length: 128
    Example: Demo G2 Cluster

    String

    projectId
    required

    Uniquely identifiable projectId

    Example: 99d9487a-235b-4b5f-b610-577a60edb911

    UUID (uuid)

    description
    optional

    A short description that describes the cluster

    Example: Example description of a G2 cluster

    String

    place
    required

    Cluster deployment location based on the value provided in environment

    V3Place

    servers
    required

    Server specifications for creating the cluster

    V3Servers array

    supportPackage
    required

    One from "Basic", "DeveloperPro" or "Enterprise"

    V3SupportPackage

    V3CreateClusterUserRequest

    Object

    Property Schema

    username
    required

    Example: user1

    String

    password
    required

    Example: Password123!

    String

    allBucketsAccess
    optional

    V3BucketRoles

    buckets
    optional

    V3CreateClusterUserRequestBuckets array

    V3CreateClusterUserRequestBuckets

    Object

    Property Schema

    name
    required

    Example: bucket1

    String

    scope
    required

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

    Example: _default

    String

    access
    required

    V3BucketRoles

    V3Day

    One of the following:

    V3DayAll

    Object

    Property Schema

    state
    required

    Specifies whether the database is on all day or off all day.

    Values: on, off

    String

    v3DayCustom

    Object

    Property Schema

    state
    required

    Specifies that the database is on between the given times.

    Values: custom

    String

    from
    required

    Specifies the time when the database turns on.

    V3DayCustomTimeFrom

    to
    optional

    Specifies the time when the database turns off. If omitted, the database stays on for the rest of the day.

    V3DayCustomTimeTo

    V3DayCustomTimeFrom

    Object

    Property Schema

    hour
    required

    Default: 21
    Minimum: 0
    Maximum: 23

    Integer

    minute
    required

    Values: 0, 30
    Default: 30

    Integer

    V3DayCustomTimeTo

    Object

    Property Schema

    hour
    required

    Default: 23
    Minimum: 0
    Maximum: 23

    Integer

    minute
    required

    Values: 0, 30
    Default: 30

    Integer

    V3Environment

    String

    Values: hosted, vpc

    V3ModifyOnOffSchedule

    Object

    Property Schema

    timezone
    required

    The timezone for scheduled on/off, in IANA format.

    Default: Europe/London

    String

    days
    required

    An array of seven objects, one for each day of the week, starting with Monday. Each item specifies whether the database is on all day, off all day, or on between the given times.

    Minimum items: 7
    Maximum items: 7

    V3Day array

    V3Place

    Object

    Property Schema

    singleAZ
    required

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

    Example: true

    Boolean

    hosted
    optional

    cluster will be deployed in the managed couchbase capella

    V3PlaceHosted

    V3PlaceHosted

    Object

    Property Schema

    provider
    required

    V3Provider

    region
    required

    A valid region for the cloudProvider

    Example: us-west-2

    String

    CIDR
    required

    CIDR block.

    Example: 10.21.0.0/16

    String

    V3Provider

    String

    Values: aws, azure, gcp

    V3Servers

    Object

    Property Schema

    size
    required

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

    Minimum: 3
    Maximum: 27
    Example: 4

    Integer

    compute
    required

    Compute instance type

    Example: m5.xlarge

    String

    services
    required

    Array of couchbase services to be installed on the nodes

    Example: ["data","index"]

    V3CouchbaseServices array

    storage
    required

    V3ServersStorage

    V3ServersStorage

    Object

    Property Schema

    type
    required

    V3StorageType

    IOPS
    optional

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

    Example: 3000

    Integer

    size
    required

    Min 50GB, max 16TB

    Minimum: 50
    Maximum: 16384
    Example: 50

    Integer

    V3StorageType

    String

    Values: GP3, IO2, PD-SSD

    V3SupportPackage

    Object

    Property Schema

    timezone
    required

    V3SupportPackageTimezones

    type
    required

    V3SupportPackageType

    V3SupportPackageTimezones

    String

    • ET - Eastern Time

    • GMT - Greenwich Mean Time

    • IST - India Standard Time

    • PT - Pacific Time

    Values: ET, GMT, IST, PT

    V3SupportPackageType

    String

    Values: Basic, DeveloperPro, Enterprise

    V3TurnOn

    Object

    Property Schema

    turnOnAppService
    optional

    Default: true

    Boolean

    V3UpdateClusterMetaRequest

    Object

    Property Schema

    name
    optional

    String

    description
    optional

    String

    V3UpdateClusterServersRequest

    Object

    Property Schema

    servers
    required

    V3Servers array

    V3UpdateClusterSupportRequest

    Object

    Property Schema

    supportPackage
    required

    One from "Basic", "DeveloperPro" or "Enterprise"

    V3UpdateClusterSupportRequestSupportPackage

    V3UpdateClusterSupportRequestSupportPackage

    Object

    Property Schema

    timezone
    optional

    V3SupportPackageTimezones

    type
    required

    V3SupportPackageType

    Security

    Token

    Type : http
    Scheme : bearer

    The Management API v3.0 supports bearer HTTP authentication. You must generate the bearer token using your API access key and your API secret key.

    You can get the API access key and the API secret key using the Couchbase Capella user interface.