How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

CockroachDB CMEK API

Manage customer-managed encryption keys (CMEK) for encrypting cluster data at rest using customer-controlled keys.

CockroachDB CMEK API is one of 26 APIs that CockroachDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include CMEK. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 1 path, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 2024-09-16.

Requests are made against a single base URL, https://cockroachlabs.cloud.

4 operations 1 paths 4 schemas 1 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2024-09-16
Base URL
https://cockroachlabs.cloud
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

CockroachDB CMEK API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token authentication. Generate a token in the CockroachDB Cloud Console under Organization Settings API Access.

Paths & Operations 4

Across 1 path, the API surfaces 4 operations — 1 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

CMEK 4

Manage customer-managed encryption keys (CMEK) for encrypting cluster data at rest using customer-controlled keys.

GET
/api/v1/clusters/{cluster_id}/cmek
Get CMEK configuration
GetCMEKClusterInfo 1 param → 200401404
POST
/api/v1/clusters/{cluster_id}/cmek
Enable CMEK
EnableCMEKSpec 1 param body → 200400401
PUT
/api/v1/clusters/{cluster_id}/cmek
Update CMEK specification
UpdateCMEKSpec 1 param body → 200400401
PATCH
/api/v1/clusters/{cluster_id}/cmek
Update CMEK status
UpdateCMEKStatus 1 param body → 200400401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are CMEKClusterInfo (3 properties), Error (3 properties), UpdateCMEKStatusRequest (1 property), CMEKClusterSpecification (1 property). Each schema is shown below with its type and property counts.

CMEKClusterSpecification
object
Specification defining the customer-managed encryption key configuration for a CockroachDB cluster.
1 property 1 required
Error
object
Standard error response returned by the API.
3 properties
CMEKClusterInfo
object
Customer-managed encryption key configuration for a cluster.
3 properties
UpdateCMEKStatusRequest
object
Request body for updating CMEK operational status.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cockroachdb-cmek-api-openapi.yml Raw ↑

Other APIs CockroachDB publishes across the network.

CockroachDB APIKeys API
CockroachDB AuditLogs API
CockroachDB Auth API
CockroachDB BackupRestore API
CockroachDB Billing API
CockroachDB Clusters API
CockroachDB Databases API
CockroachDB EgressRules API
CockroachDB Folders API
CockroachDB Health API
CockroachDB IPAllowlists API
CockroachDB JWTIssuers API
Where this information came from

This is an independent, third-party profile of CockroachDB CMEK API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.