Download OpenAPI specification:Download
The Couchbase Capella Columnar Management API provides a set of endpoints for creating and managing Columnar analytics clusters. Users are able to perform operations such as creating Columnar analytics clusters and managing their configurations. This API documentation specifies the endpoints, request and response formats, and authentication requirements for seamless integration with Couchbase Capella.
To access the Management API, you need an API key. To create an initial bootstrap API key you must use the Capella UI. Once you have created an initial bootstrap API key, you can use the Management API to create further API keys. To learn more, see Get Started with the Columnar Management API.
For a history of updates to the Management API, see Capella Columnar Management API Change Log.
API Base URL:
https://cloudapi.cloud.couchbase.com
Couchbase Capella Management API uses a Bearer token mechanism for authentication; each call to the Management API has to be authenticated by API key.
Creates a new API key under an organization.
Organization Owners can create Organization and Project scoped API keys.
Project Owner and Project Creator can create project scoped keys.
To learn more, see Organization, Project, and Database Access Overview.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
name required | string (APIKeyName) Name of the API key. |
description | string (APIKeyDescription) Default: "" Description for the API key. |
expiry | number <float> (APIKeyExpiry) Default: 180 Expiry of the API key in number of days. If set to -1, the token will not expire. |
allowedCIDRs | Array of strings (APIKeyAllowedCIDRs) Default: ["0.0.0.0/0"] List of inbound CIDRs for the API key. The system making a request must come from one of the allowed CIDRs. |
organizationRoles required | Array of strings (APIKeyOrganizationRoles) Items Enum: "organizationOwner" "organizationMember" "projectCreator" |
Array of objects (APIKeyResources) Default: [] Resources are the resource level permissions associated with the API key. To learn more about Organization Roles, see Organization Roles. |
{- "name": "Organization Owner API Key",
- "description": "Creates an API key with a Organization Owner role.",
- "expiry": 720,
- "allowedCIDRs": [
- "8.8.8.8/32"
], - "organizationRoles": [
- "organizationOwner"
], - "resources": [ ]
}
{- "id": "IS9DrRsw4KWFS72Zhbj4xmhllHvPcdCL",
- "token": "QktxVUtFU1dKV1FlMmxwbzJBYXdnTVlRemFZdlRDZTg6eFh4dzU4JUYjekJVYWZPY3lqdUwwYkJoTjZSTmlzRWFIRHF0b1h4a08yazBpQjJ1bms1OW4yTUhAenRib3IhVQ=="
}
Lists all the API keys under an organization.
Organization Owners can list all the API keys inside the Organization.
Organization Members and Project Creators can list all the Project scoped API key for which they are Project Owner.
To learn more, see Organization, Project, and Database Access Overview.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
page | integer Sets the page you would like to view. |
perPage | integer Sets the number of results you would like to have on each page. |
sortBy | Array of strings Example: sortBy=name Sets the order of how you would like to sort the results and the key you would like to order by. Valid fields to sort the results are: name, expiry, description. |
sortDirection | string Enum: "asc" "desc" Example: sortDirection=asc The order in which the items will be sorted. |
{- "data": [
- {
- "id": "IS9DrRsw4KWFS72Zhbj4xmhllHvPcdCL",
- "name": "Production",
- "description": "API key to manage production Capella Cluster.",
- "expiry": 180,
- "allowedCIDRs": [
- "0.0.0.0/0"
], - "organizationRoles": [
- "organizationMember"
], - "resources": [ ],
- "audit": {
- "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
- "createdAt": "2021-09-01T12:34:56Z",
- "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
- "modifiedAt": "2021-09-01T12:34:56Z",
- "version": 1
}
}
], - "cursor": {
- "pages": {
- "page": 2,
- "next": 3,
- "previous": 1,
- "last": 10,
- "perPage": 10,
- "totalItems": 10
}, - "hrefs": {
}
}
}
Fetches the details of the given API key under an organization.
Organization Owners can get any API key inside the Organization.
Organization Members and Project Creator can get any Project scoped API key for which they are Project Owner.
To learn more, see Organization, Project, and Database Access Overview.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
ApiKeyId required | string Example: ffffffffaaaa1414eeee000000000000 The ID (Access key) of the API key. |
{- "id": "IS9DrRsw4KWFS72Zhbj4xmhllHvPcdCL",
- "name": "Organization Owner API Key",
- "description": "Creates an API key with an Organization Owner role.",
- "expiry": 720,
- "allowedCIDRs": [
- "8.8.8.8/32"
], - "organizationRoles": [
- "organizationOwner"
], - "resources": [ ],
- "audit": {
- "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
- "createdAt": "2021-09-01T12:34:56Z",
- "modifiedBy": "",
- "modifiedAt": "2021-09-01T12:34:56Z",
- "version": 1
}
}
Deletes the given API key under an organization.
Organization Owners can delete any API key inside the Organization.
Organization Members and Project Creator can delete any Project scoped API key for which they are Project Owner.
To learn more, see Organization, Project, and Database Access Overview.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
ApiKeyId required | string Example: ffffffffaaaa1414eeee000000000000 The ID (Access key) of the API key. |
{- "httpStatusCode": 403,
- "code": 1002,
- "message": "Access Denied.",
- "hint": "Your access to the requested resource is denied. Please make sure you have the necessary permissions to access the resource."
}
Rotate the secret of a given API key under an organization.
Organization Owners can rotate any API key inside the Organization.
To learn more, see Organization, Project, and Database Access Overview.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
ApiKeyId required | string Example: ffffffffaaaa1414eeee000000000000 The ID (Access key) of the API key. |
secret | string A secret associated with API key. One has to follow the secret key policy, such as allowed characters and a length of 64 characters. If this field is left empty, a secret will be auto-generated. |
{- "secret": "GaC4FQLCoUqoKUMBvl6BgRK1Ivqu5yF8OkDBhnP%#CH%S4T@bTVUdP#rY#VSicbx"
}
{- "secretKey": "GaC4FQLCoUqoKUMBvl6BgRK1Ivqu5yF8OkDBhnP%#CH%S4T@bTVUdP#rY#VSicbx"
}
Projects contain and allow access to Couchbase databases. Projects are used to organize and manage groups of Couchbase databases within organizations. An organization can contain any number of projects, and a project can contain any number of databases.
Creates a new project under the organization.
In order to access this endpoint, the provided API key must have at least one of the following roles:
To learn more, see Organization, Project, and Database Access Overview.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
name required | string <= 128 characters The name of the project (up to 128 characters). |
description | string <= 256 characters A short description of the project (up to 256 characters). |
{- "name": "My Project",
- "description": "My awesome project"
}
{- "id": "ffffffff-aaaa-1414-eeee-000000000000"
}
Lists all the projects under the organization.
In order to access this endpoint, the provided API key must have at least one of the following roles:
To learn more, see Organization, Project, and Database Access Overview.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
page | integer Sets the page you would like to view. |
perPage | integer Sets the number of results you would like to have on each page. |
sortBy | Array of strings Example: sortBy=name Sets the order of how you would like to sort the results and the key you would like to order by. Valid fields to sort the results are: id, name. |
sortDirection | string Enum: "asc" "desc" Example: sortDirection=asc The order in which the items will be sorted. |
{- "data": [
- {
- "id": "ffffffff-aaaa-1414-eeee-000000000000",
- "description": "The description of my awesome project",
- "name": "My-Awesome-Project",
- "audit": {
- "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
- "createdAt": "2021-09-01T12:34:56Z",
- "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
- "modifiedAt": "2021-09-01T12:34:56Z",
- "version": 1
}
}
], - "cursor": {
- "pages": {
- "page": 2,
- "next": 3,
- "previous": 1,
- "last": 10,
- "perPage": 10,
- "totalItems": 10
}, - "hrefs": {
}
}
}
Fetches the details of the given project.
In order to access this endpoint, the provided API key must have at least one of the following roles:
To learn more, see Organization, Project, and Database Access Overview.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
projectId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the project. |
{- "id": "ffffffff-aaaa-1414-eeee-000000000000",
- "description": "The description of my awesome project",
- "name": "My-Awesome-Project",
- "audit": {
- "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
- "createdAt": "2021-09-01T12:34:56Z",
- "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
- "modifiedAt": "2021-09-01T12:34:56Z",
- "version": 1
}
}
Update project name and or project description.
In order to access this endpoint, the provided API key must have at least one of the following roles:
To learn more, see Organization, Project, and Database Access Overview.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
projectId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the project. |
If-Match | string Example: 12 A precondition header that specifies the entity tag of a resource. |
name required | string <= 128 characters The new project name (up to 128 characters). |
description | string <= 256 characters The new project description (up to 256 characters). |
{- "name": "My-New-Project",
- "description": "The extended description of my awesome project."
}
{- "httpStatusCode": 400,
- "code": 6007,
- "message": "The request was malformed or invalid.",
- "hint": "The request was malformed or invalid."
}
Deletes an existing project.
In order to access this endpoint, the provided API key must have at least one of the following roles:
To learn more, see Organization, Project, and Database Access Overview.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
projectId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the project. |
{- "httpStatusCode": 403,
- "code": 1002,
- "message": "Access Denied.",
- "hint": "Your access to the requested resource is denied. Please make sure you have the necessary permissions to access the resource."
}
To access an organization, your Couchbase Capella user account must be added to it. Accounts are added to an organization using email invitations sent from Capella by a user with the Organization Owner organization role. All organization users are given one or more organization roles that define what they can view and manage in their organization.
Invites a new user under the organization.
After making a REST API request, an invitation email is triggered and sent to the user. Upon receiving the invitation email, the user is required to click on a provided URL, which will redirect them to a page with a user interface (UI) where they can set their username and password.
The modification of any personal information related to a user can only be performed by the user through the UI. Similarly, the user can solely conduct password updates through the UI.
The "caller" possessing Organization Owner access rights retains the exclusive user creation capability. They hold the authority to assign roles at the organization and project levels.
At present, our support is limited to the resourceType of "project" exclusively.
In order to access this endpoint, the provided API key must have the following role:
To learn more, see Organization Roles.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
name | string <= 128 characters The name of the user. |
email required | string (Email) Email of the user. |
organizationRoles required | Array of strings (OrganizationRoles) Items Enum: "organizationOwner" "organizationMember" "projectCreator" |
Array of objects (Resource) Default: [] |
At present, our support is limited to the resourceType of "project" exclusively. Furthermore, the role designation is solely related to roles at the project level.
{- "name": "John",
- "email": "john.doe@example.com",
- "organizationRoles": [
- "organizationMember"
], - "resources": [
- {
- "id": "550e8400-e29b-41d4-a716-446655440000",
- "type": "project",
- "roles": [
- "projectViewer"
]
}, - {
- "id": "550e8400-e29b-41d4-a716-446655440000",
- "type": "project",
- "roles": [
- "projectDataReaderWriter"
]
}
]
}
{- "id": "ffffffff-aaaa-1414-eeee-000000000000"
}
Lists all the users in the organization and filter on the basis of projectId.
In order to access this endpoint, the provided API key must have at least one of the following roles:
The results are always limited by the role and scope of the caller's privileges.
When retrieving a list of users through a GET request, if a user holds the organization owner role, the response will exclude project-level permissions for those users. This is because organization owners have full access to all resources within the organization, making project-level permissions irrelevant for them.
To learn more about the roles, see Organization Roles and Project Roles.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
page | integer Sets the page you would like to view. |
perPage | integer Sets the number of results you would like to have on each page. |
sortBy | Array of strings Example: sortBy=name Sets the order of how you would like to sort the results and the key you would like to order by. Valid fields to sort the results are: id, name, email, status, inactive. |
sortDirection | string Enum: "asc" "desc" Example: sortDirection=asc The order in which the items will be sorted. |
projectId | string <uuid> Example: projectId=ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the project. |
In the event that the API key holds "organizationOwner" access, information related to all projects within the organization will be returned.
{- "data": [
- {
- "id": "ffffffff-aaaa-1414-eeee-000000000000",
- "name": "John",
- "email": "john.doe@example.com",
- "status": "verified",
- "inactive": false,
- "organizationId": "ffffffff-aaaa-1414-eeee-000000000000",
- "organizationRoles": [
- "organizationMember"
], - "lastLogin": "2023-07-17T07:05:39.116Z",
- "region": "North America",
- "timeZone": "(UTC +5:30) India Standard Time",
- "enableNotifications": false,
- "expiresAt": "2023-07-17T07:05:39.116Z",
- "resources": [
- {
- "id": "f98e6c87-41e3-4faa-9df4-906e8d4f1aaf",
- "type": "project",
- "roles": [
- "projectViewer"
]
}, - {
- "id": "b7c745ac-9fb8-4b63-a0e4-51230097a169",
- "type": "project",
- "roles": [
- "projectDataReaderWriter"
]
}, - {
- "id": "28b67422-63d5-46b1-9234-8ad4a1d2f7be",
- "type": "project",
- "roles": [
- "projectDataReaderWriter"
]
}, - {
- "id": "e3942eaa-0f52-43da-963d-87a5b6cb3805",
- "type": "project",
- "roles": [
- "projectDataReaderWriter"
]
}
], - "audit": {
- "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
- "createdAt": "2021-09-01T12:34:56.000Z",
- "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
- "modifiedAt": "2021-09-01T12:34:56.000Z",
- "version": 1
}
}
], - "cursor": {
- "pages": {
- "page": 2,
- "next": 3,
- "previous": 1,
- "last": 10,
- "perPage": 10,
- "totalItems": 10
}, - "hrefs": {
}
}
}
Fetches the details of the given user.
In order to access this endpoint, the provided API key must have at least one of the following roles:
The results are always limited by the role and scope of the caller's privileges.
When performing a GET request for a user with an organization owner role, the response will exclude project-level permissions for that user. This is because organization owners have access to all resources at the organization level, rendering project-level permissions unnecessary for them.
To learn more about the roles, see Organization Roles and Project Roles.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
userId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the control plane user. |
{- "id": "ffffffff-aaaa-1414-eeee-000000000000",
- "name": "alex",
- "email": "john.doe@example.com",
- "status": "not-verified",
- "inactive": false,
- "organizationId": "ffffffff-aaaa-1414-eeee-000000000000",
- "organizationRoles": [
- "projectCreator"
], - "lastLogin": "2023-07-17T07:05:39.116124897Z",
- "region": "North America",
- "timeZone": "(UTC -9:00) Alaska Standard Time",
- "enableNotifications": true,
- "expiresAt": "2023-07-17T07:05:39.116124897Z",
- "resources": [
- {
- "type": "project",
- "id": "ffffffff-aaaa-1414-eeee-000000000000",
- "roles": [
- "projectManager"
]
}
], - "audit": {
- "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
- "createdAt": "2021-09-01T12:34:56Z",
- "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
- "modifiedAt": "2021-09-01T12:34:56Z",
- "version": 1
}
}
Updates organizationRole and resources of the user.
In order to access this endpoint, the provided API key must have at least one of the following roles:
An Organization Owner API key can be utilized to update organizational-level roles and project-level roles for all projects within the organization.
The Project Owner API key allows for updating project-level roles, solely within the projects where the API key holds the Project Owner role.
The modification of any personal information related to a user, such as password updates, can only be performed by the respective user through the user interface (UI).
The results are always limited by the role and scope of the caller's privileges. To learn more about the roles, see Organization Roles and Project Roles.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
userId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the control plane user. |
op required | string Enum: "add" "remove" Type of operation. |
path required | string Path of resource that needs to be updated. Organization Roles: Resources: Resource Roles: |
Array of OrganizationRoles (strings) or Array of ProjectRoles (strings) or Resource (object) |
[- {
- "op": "add",
- "path": "/organizationRoles",
- "value": [
- "projectCreator"
]
}
]
{- "id": "ffffffff-aaaa-1414-eeee-000000000000",
- "name": "Jane",
- "email": "jane.doe@example.com",
- "status": "verified",
- "inactive": false,
- "organizationId": "ffffffff-aaaa-1414-eeee-000000000000",
- "organizationRoles": [
- "organizationMember",
- "projectCreator"
], - "lastLogin": "2023-07-17T07:05:39.116Z",
- "region": "North America",
- "timeZone": "(UTC +5:30) India Standard Time",
- "enableNotifications": false,
- "expiresAt": "2023-07-17T07:05:39.116Z",
- "resources": [
- {
- "id": "b7c745ac-9fb8-4b63-a0e4-51230097a169",
- "type": "project",
- "roles": [
- "projectViewer"
]
}, - {
- "id": "28b67422-63d5-46b1-9234-8ad4a1d2f7be",
- "type": "project",
- "roles": [
- "projectDataReaderWriter"
]
}
], - "audit": {
- "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
- "createdAt": "2021-09-01T12:34:56.000Z",
- "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
- "modifiedAt": "2021-09-01T12:34:56.000Z",
- "version": 2
}
}
Removes user from the organization.
In order to access this endpoint, the provided API key must have the following role:
To learn more about the roles, see Organization Roles.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
userId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the control plane user. |
{- "httpStatusCode": 403,
- "code": 1002,
- "message": "Access Denied.",
- "hint": "Your access to the requested resource is denied. Please make sure you have the necessary permissions to access the resource."
}
Columnar analytics clusters only allow connections from trusted IP addresses. Each analytics cluster has a configurable Allowed IP list that can include up to 75 entries. Each entry can be a single IP address or an IP address space. Any IP address you add to this list can have a user-specified expiration time for temporary access, or be permanent. Capella automatically denies any connection attempts to and from an IP not in the allowed IP list.
Adds a trusted CIDR to an clusters's list of allowed CIDRs.
In order to access this endpoint, the provided API key must have at least one of the following roles:
To learn more, see Organization, Project, and Database Access Overview.
Note that updating this resource is not supported; you must delete and recreate allowed CIDRs instead. As a result, ETags are also not supported for this resource.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
projectId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the project. |
analyticsClusterId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the analytics cluster. |
cidr required | string The trusted CIDR to allow the database connections from. The example represents a single IP address (i.e. a subnet mask of 32). |
comment | string A short description of the allowed CIDR. |
expiresAt | string <date-time> An RFC3339 timestamp determining when the allowed CIDR should expire. If this field is empty/omitted then the allowed CIDR is permanent and will never automatically expire. |
{- "cidr": "6.60.28.100/32",
- "comment": "Allows access from my local developer machine",
- "expiresAt": "2023-05-14T21:49:58.465Z"
}
{- "id": "ffffffff-aaaa-1414-eeee-000000000000"
}
Lists all of the allowed CIDRs for a given cluster.
In order to access this endpoint, the provided API key must have at least one of the following roles:
To learn more, see Organization, Project, and Database Access Overview.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
projectId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the project. |
analyticsClusterId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the analytics cluster. |
page | integer Sets the page you would like to view. |
perPage | integer Sets the number of results you would like to have on each page. |
sortBy | Array of strings Example: sortBy=id Sets the order of how you would like to sort the results and the key you would like to order by. Valid fields to sort the results are: id, type, status. |
sortDirection | string Enum: "asc" "desc" Example: sortDirection=asc The order in which the items will be sorted. |
{- "data": [
- {
- "id": "ffffffff-aaaa-1414-eeee-000000000000",
- "cidr": "1.23.45.67/32",
- "comment": "Allows access from my local developer machine",
- "expiresAt": "2023-05-14T21:49:58.465Z",
- "status": "active",
- "type": "temporary",
- "audit": {
- "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
- "createdAt": "2021-09-01T12:34:56Z",
- "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
- "modifiedAt": "2021-09-01T12:34:56Z",
- "version": 1
}
}
], - "cursor": {
- "pages": {
- "page": 2,
- "next": 3,
- "previous": 1,
- "last": 10,
- "perPage": 10,
- "totalItems": 10
}, - "hrefs": {
}
}
}
Fetches the details for the specified allowed CIDR.
In order to access this endpoint, the provided API key must have at least one of the following roles:
To learn more, see Organization, Project, and Database Access Overview.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
projectId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the project. |
analyticsClusterId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the analytics cluster. |
allowedCidrId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the allowed CIDR. |
{- "id": "ffffffff-aaaa-1414-eeee-000000000000",
- "cidr": "1.23.45.67/32",
- "comment": "Allows access from my local developer machine",
- "expiresAt": "2023-05-14T21:49:58.465Z",
- "status": "active",
- "type": "temporary",
- "audit": {
- "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
- "createdAt": "2021-09-01T12:34:56Z",
- "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
- "modifiedAt": "2021-09-01T12:34:56Z",
- "version": 1
}
}
Deletes the existing allowed CIDR.
In order to access this endpoint, the provided API key must have at least one of the following roles:
To learn more, see Organization, Project, and Database Access Overview.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
projectId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the project. |
analyticsClusterId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the analytics cluster. |
allowedCidrId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the allowed CIDR. |
{- "httpStatusCode": 400,
- "code": 6007,
- "message": "The request was malformed or invalid.",
- "hint": "The request was malformed or invalid."
}
Couchbase Capella uses an ordered hierarchy to help you keep all of your data organized and securely accessible. The entity at the top of the hierarchy is called an organization. Everything you do in Capella, whether it's creating a cluster or managing billing, happens within the scope of an organization.
Fetches the details of an organization by ID.
In order to access this endpoint, the provided API key must have at least one of the following roles:
To learn more, see Organization Roles.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
{- "id": "ffffffff-aaaa-1414-eeee-000000000000",
- "name": "My-Organization",
- "subdomain": "abc",
- "description": "The description of the organization.",
- "preferences": {
- "sessionDuration": 3600
}, - "audit": {
- "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
- "createdAt": "2021-09-01T12:34:56Z",
- "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
- "modifiedAt": "2021-09-01T12:34:56Z",
- "version": 1
}
}
Updates an existing organization configuration. Use this endpoint to add, update, and delete network subdomains.
Subdomains:
In order to access this endpoint, the provided API key must have the following role:
Subdomains are not automatically available. You must contact Couchbase support to enable this feature.
To learn more, see Organization, Project, and Database Access Overview.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
If-Match | string Example: 12 A precondition header that specifies the entity tag of a resource. |
subdomain required | string <= 30 characters The new name of the subdomain for the organization. |
{- "subdomain": "abc"
}
{- "httpStatusCode": 403,
- "code": 1002,
- "message": "Access Denied.",
- "hint": "Your access to the requested resource is denied. Please make sure you have the necessary permissions to access the resource."
}
Returns a list of all organizations the user has access to.
In order to access this endpoint, the provided API key must have at least one of the following roles:
To learn more, see Organization Roles.
{- "data": [
- {
- "id": "ffffffff-aaaa-1414-eeee-000000000000",
- "name": "My-Organization",
- "subdomain": "abc",
- "description": "The description of the organization.",
- "preferences": {
- "sessionDuration": 3600
}, - "audit": {
- "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
- "createdAt": "2021-09-01T12:34:56Z",
- "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
- "modifiedAt": "2021-09-01T12:34:56Z",
- "version": 1
}
}
]
}
The Columnar Analytics Clusters endpoint allows users to manage their Capella Columnar analytics clusters. Capella Columnar is an analytical database (RT-OLAP) for bringing data together for real time apps and operational intelligence. Using this endpoint, users can create new clusters, get details of a specific cluster or a listing of clusters, scale up or down existing clusters, and delete clusters.
Creates a new analytics cluster
In order to access this endpoint, the provided API key must have at least one of the following roles:
Organization Owner
Project Owner
Project Manager
To learn more, see Organization, Project, and Database Access Overview.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
projectId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the project. |
name required | string <= 256 characters Name of the analytics cluster |
description | string <= 1024 characters The description of the analytics cluster. |
cloudProvider required | string Cloud provider selection is currently limited to Amazon Web Services (AWS). |
region required | string Which region should the analytics cluster be deployed in. |
nodes required | integer [ 1 .. 32 ] The number of nodes. |
required | object (ColumnarSupport) |
required | object (Compute) Following are the supported compute combinations for CPU and RAM for different cloud providers. To learn more, see Amazon Web Services. |
required | object (Availability) |
{- "name": "My-first-analytics-cluster",
- "description": "I won him in a game of hook a duck at a carnival",
- "cloudProvider": "aws",
- "region": "us-east-2",
- "nodes": 3,
- "support": {
- "plan": "enterprise",
- "timezone": "ET"
}, - "compute": {
- "cpu": 4,
- "ram": 16
}, - "availability": {
- "type": "single"
}
}
{- "id": "ffffffff-aaaa-1414-eeee-000000000000"
}
Lists all the analytics clusters for a project
To learn more, see Organization, Project, and Database Access Overview.
In order to access this endpoint, the provided API key must have at least one of the following roles:
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
projectId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the project. |
page | integer Sets the page you would like to view. |
perPage | integer Sets the number of results you would like to have on each page. |
sortBy | Array of strings Example: sortBy=name Sets the order of how you would like to sort the results and the key you would like to order by. Valid fields to sort the results are: id, cloudProvider, name. |
sortDirection | string Enum: "asc" "desc" Example: sortDirection=asc The order in which the items will be sorted. |
{- "data": [
- {
- "id": "ffffffff-aaaa-1414-eeee-000000000000",
- "name": "My-first-analytics-cluster",
- "description": "I won him in a game of hook a duck at a carnival",
- "cloudProvider": "aws",
- "region": "us-east-2",
- "nodes": 3,
- "currentState": "deploying",
- "support": {
- "plan": "enterprise",
- "timezone": "ET"
}, - "compute": {
- "cpu": 4,
- "ram": 16
}, - "availability": {
- "type": "single"
}
}
], - "cursor": {
- "pages": {
- "page": 2,
- "next": 3,
- "previous": 1,
- "last": 10,
- "perPage": 10,
- "totalItems": 10
}, - "hrefs": {
}
}
}
Lists all the analytics clusters for an organization
To learn more, see Organization, Project, and Database Access Overview.
In order to access this endpoint, the provided API key must have at least one of the following roles:
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
page | integer Sets the page you would like to view. |
perPage | integer Sets the number of results you would like to have on each page. |
sortBy | Array of strings Example: sortBy=name Sets the order of how you would like to sort the results and the key you would like to order by. Valid fields to sort the results are: id, cloudProvider, name. |
sortDirection | string Enum: "asc" "desc" Example: sortDirection=asc The order in which the items will be sorted. |
{- "data": [
- {
- "id": "ffffffff-aaaa-1414-eeee-000000000000",
- "name": "My-first-analytics-cluster",
- "description": "I won him in a game of hook a duck at a carnival",
- "cloudProvider": "aws",
- "region": "us-east-2",
- "nodes": 3,
- "currentState": "deploying",
- "support": {
- "plan": "enterprise",
- "timezone": "ET"
}, - "compute": {
- "cpu": 4,
- "ram": 16
}, - "availability": {
- "type": "single"
}
}
], - "cursor": {
- "pages": {
- "page": 2,
- "next": 3,
- "previous": 1,
- "last": 10,
- "perPage": 10,
- "totalItems": 10
}, - "hrefs": {
}
}
}
Gets the details of a single analytics cluster
To learn more, see Organization, Project, and Database Access Overview.
In order to access this endpoint, the provided API key must have at least one of the following roles:
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
projectId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the project. |
analyticsClusterId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the analytics cluster. |
{- "id": "ffffffff-aaaa-1414-eeee-000000000000",
- "name": "My-first-analytics-cluster",
- "description": "I won him in a game of hook a duck at a carnival",
- "cloudProvider": "aws",
- "region": "us-east-2",
- "nodes": 3,
- "currentState": "deploying",
- "support": {
- "plan": "enterprise",
- "timezone": "ET"
}, - "compute": {
- "cpu": 4,
- "ram": 16
}, - "availability": {
- "type": "single"
}
}
Updates an analytics cluster. This could be the name, description or nodes(scaling up/down).
In order to access this endpoint, the provided API key must have at least one of the following roles:
Organization Owner
Project Owner
Project Manager
To learn more, see Organization, Project, and Database Access Overview.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
projectId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the project. |
analyticsClusterId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the analytics cluster. |
If-Match | string Example: 12 A precondition header that specifies the entity tag of a resource. |
name required | string <= 256 characters Name of the analytics cluster. |
description required | string <= 1024 characters The new cluster description (up to 1024 characters). |
nodes required | integer [ 1 .. 32 ] The number of nodes you want for the cluster |
required | object (ColumnarSupport) |
{- "name": "My first analytics cluster",
- "description": "The extended description of my new cluster.",
- "nodes": 3,
- "support": {
- "plan": "enterprise",
- "timezone": "ET"
}
}
{- "httpStatusCode": 400,
- "code": 6007,
- "message": "The request was malformed or invalid.",
- "hint": "The request was malformed or invalid."
}
Deletes the analytics cluster
In order to access this endpoint, the provided API key must have at least one of the following roles:
To learn more, see Organization, Project, and Database Access Overview.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
projectId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the project. |
analyticsClusterId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the analytics cluster. |
{- "httpStatusCode": 400,
- "code": 6007,
- "message": "The request was malformed or invalid.",
- "hint": "The request was malformed or invalid."
}
Turn analytics cluster on.
In order to access this endpoint, the provided API key must have at least one of the roles referenced below:
To learn more, see Organization, Project, and Database Access Overview.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
projectId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the project. |
analyticsClusterId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the analytics cluster. |
{- "httpStatusCode": 403,
- "code": 1002,
- "message": "Access Denied.",
- "hint": "Your access to the requested resource is denied. Please make sure you have the necessary permissions to access the resource."
}
Turn analytics cluster off.
Turning off your analytics cluster turns off the compute for your analytics cluster but the storage remains. All of the data, indexes and analytics cluster configuration remain, including users and allow lists.
In order to access this endpoint, the provided API key must have at least one of the roles referenced below:
To learn more, see Organization, Project, and Database Access Overview.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
projectId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the project. |
analyticsClusterId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the analytics cluster. |
{- "httpStatusCode": 403,
- "code": 1002,
- "message": "Access Denied.",
- "hint": "Your access to the requested resource is denied. Please make sure you have the necessary permissions to access the resource."
}
The Columnar Analytics On/Off Schedule endpoint enables you to schedule when your Columnar analytics cluster should turn on or off to save costs. Turning off the cluster only turns off the compute; all of your data, indexes, and cluster configuration remain, including users and allow lists. When you turn your Columnar analytics cluster off, you will be charged the OFF amount for the cluster.
This provides the means to add an on/off schedule for an analytics cluster
In order to access this endpoint, the provided API key must have at least one of the roles referenced below:
To learn more, see Organization, Project, and Database Access Overview.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
projectId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the project. |
analyticsClusterId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the analytics cluster. |
timezone required | string Enum: "Pacific/Midway" "US/Hawaii" "US/Alaska" "US/Pacific" "US/Mountain" "US/Central" "US/Eastern" "America/Puerto_Rico" "Canada/Newfoundland" "America/Argentina/Buenos_Aires" "Atlantic/Cape_Verde" "Europe/London" "Europe/Amsterdam" "Europe/Athens" "Africa/Nairobi" "Asia/Tehran" "Indian/Mauritius" "Asia/Karachi" "Asia/Calcutta" "Asia/Dhaka" "Asia/Bangkok" "Asia/Hong_Kong" "Asia/Tokyo" "Australia/North" "Australia/Sydney" "Pacific/Ponape" "Antarctica/South_Pole" Timezone for the schedule |
required | Array of objects (Days) |
{- "timezone": "US/Pacific",
- "days": [
- {
- "day": "monday",
- "state": "custom",
- "from": {
- "hour": 12,
- "minute": 30
}, - "to": {
- "hour": 14,
- "minute": 30
}
}, - {
- "day": "tuesday",
- "state": "custom",
- "from": {
- "hour": 12,
- "minute": 30
}, - "to": {
- "hour": 14,
- "minute": 30
}
}, - {
- "day": "wednesday",
- "state": "on"
}, - {
- "day": "thursday",
- "state": "on"
}, - {
- "day": "friday",
- "state": "custom",
- "from": {
- "hour": 12,
- "minute": 30
}, - "to": {
- "hour": 14,
- "minute": 30
}
}, - {
- "day": "saturday",
- "state": "off"
}, - {
- "day": "sunday",
- "state": "off"
}
]
}
{- "httpStatusCode": 403,
- "code": 1002,
- "message": "Access Denied.",
- "hint": "Your access to the requested resource is denied. Please make sure you have the necessary permissions to access the resource."
}
Fetches the details of the on/off schedule for the given analytics cluster.
In order to access this endpoint, the provided API key must have at least one of the following roles:
To learn more, see Organization, Project, and Database Access Overview.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
projectId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the project. |
analyticsClusterId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the analytics cluster. |
{- "timezone": "US/Pacific",
- "days": [
- {
- "day": "monday",
- "state": "custom",
- "from": {
- "hour": 12,
- "minute": 30
}, - "to": {
- "hour": 14,
- "minute": 30
}
}, - {
- "day": "tuesday",
- "state": "custom",
- "from": {
- "hour": 12,
- "minute": 30
}, - "to": {
- "hour": 14,
- "minute": 30
}
}, - {
- "day": "wednesday",
- "state": "on"
}, - {
- "day": "thursday",
- "state": "on"
}, - {
- "day": "friday",
- "state": "custom",
- "from": {
- "hour": 12,
- "minute": 30
}, - "to": {
- "hour": 14,
- "minute": 30
}
}, - {
- "day": "saturday",
- "state": "off"
}, - {
- "day": "sunday",
- "state": "off"
}
]
}
This provides the means to update an existing analytics cluster on/off schedule.
In order to access this endpoint, the provided API key must have at least one of the roles referenced below:
To learn more, see Organization, Project, and Database Access Overview.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
projectId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the project. |
analyticsClusterId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the analytics cluster. |
timezone required | string Enum: "Pacific/Midway" "US/Hawaii" "US/Alaska" "US/Pacific" "US/Mountain" "US/Central" "US/Eastern" "America/Puerto_Rico" "Canada/Newfoundland" "America/Argentina/Buenos_Aires" "Atlantic/Cape_Verde" "Europe/London" "Europe/Amsterdam" "Europe/Athens" "Africa/Nairobi" "Asia/Tehran" "Indian/Mauritius" "Asia/Karachi" "Asia/Calcutta" "Asia/Dhaka" "Asia/Bangkok" "Asia/Hong_Kong" "Asia/Tokyo" "Australia/North" "Australia/Sydney" "Pacific/Ponape" "Antarctica/South_Pole" Timezone for the schedule |
required | Array of objects (Days) |
{- "timezone": "US/Pacific",
- "days": [
- {
- "day": "monday",
- "state": "custom",
- "from": {
- "hour": 12,
- "minute": 30
}, - "to": {
- "hour": 14,
- "minute": 30
}
}, - {
- "day": "tuesday",
- "state": "custom",
- "from": {
- "hour": 12,
- "minute": 30
}, - "to": {
- "hour": 14,
- "minute": 30
}
}, - {
- "day": "wednesday",
- "state": "on"
}, - {
- "day": "thursday",
- "state": "on"
}, - {
- "day": "friday",
- "state": "custom",
- "from": {
- "hour": 12,
- "minute": 30
}, - "to": {
- "hour": 14,
- "minute": 30
}
}, - {
- "day": "saturday",
- "state": "off"
}, - {
- "day": "sunday",
- "state": "off"
}
]
}
{- "httpStatusCode": 403,
- "code": 1002,
- "message": "Access Denied.",
- "hint": "Your access to the requested resource is denied. Please make sure you have the necessary permissions to access the resource."
}
Deletes the on/off schedule for the given analytics cluster.
In order to access this endpoint, the provided API key must have at least one of the following roles:
To learn more, see Organization, Project, and Database Access Overview.
organizationId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the organization. |
projectId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the project. |
analyticsClusterId required | string <uuid> Example: ffffffff-aaaa-1414-eeee-000000000000 The GUID4 ID of the analytics cluster. |
{- "httpStatusCode": 403,
- "code": 1002,
- "message": "Access Denied.",
- "hint": "Your access to the requested resource is denied. Please make sure you have the necessary permissions to access the resource."
}