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 MetricExport API

Configure metric export integrations including AWS CloudWatch, Datadog, and Prometheus.

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

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

This API exposes 9 operations across 3 paths, and defines 6 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.

9 operations 3 paths 6 schemas 3 DELETE3 GET3 POST

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 MetricExport 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 9

Across 3 paths, the API surfaces 9 operations — 3 DELETE, 3 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

MetricExport 9

Configure metric export integrations including AWS CloudWatch, Datadog, and Prometheus.

GET
/api/v1/clusters/{cluster_id}/metricexport/cloudwatch
Get CloudWatch metric export configuration
GetCloudWatchMetricExportInfo 1 param → 200401404
POST
/api/v1/clusters/{cluster_id}/metricexport/cloudwatch
Enable CloudWatch metric export
EnableCloudWatchMetricExport 1 param body → 200400401
DELETE
/api/v1/clusters/{cluster_id}/metricexport/cloudwatch
Disable CloudWatch metric export
DeleteCloudWatchMetricExport 1 param → 200401404
GET
/api/v1/clusters/{cluster_id}/metricexport/datadog
Get Datadog metric export configuration
GetDatadogMetricExportInfo 1 param → 200401404
POST
/api/v1/clusters/{cluster_id}/metricexport/datadog
Enable Datadog metric export
EnableDatadogMetricExport 1 param body → 200400401
DELETE
/api/v1/clusters/{cluster_id}/metricexport/datadog
Disable Datadog metric export
DeleteDatadogMetricExport 1 param → 200401404
GET
/api/v1/clusters/{cluster_id}/metricexport/prometheus
Get Prometheus metric export configuration
GetPrometheusMetricExportInfo 1 param → 200401404
POST
/api/v1/clusters/{cluster_id}/metricexport/prometheus
Enable Prometheus metric export
EnablePrometheusMetricExport 1 param → 200401
DELETE
/api/v1/clusters/{cluster_id}/metricexport/prometheus
Disable Prometheus metric export
DeletePrometheusMetricExport 1 param → 200401404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are CloudWatchMetricExportInfo (3 properties), DatadogMetricExportInfo (3 properties), Error (3 properties), EnableCloudWatchMetricExportRequest (2 properties). Each schema is shown below with its type and property counts.

Error
object
Standard error response returned by the API.
3 properties
EnableDatadogMetricExportRequest
object
Request body for enabling Datadog metric export.
2 properties 1 required
DatadogMetricExportInfo
object
Datadog metric export configuration for a cluster.
3 properties
PrometheusMetricExportInfo
object
Prometheus metric export configuration for a cluster.
2 properties
CloudWatchMetricExportInfo
object
AWS CloudWatch metric export configuration for a cluster.
3 properties
EnableCloudWatchMetricExportRequest
object
Request body for enabling AWS CloudWatch metric export.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cockroachdb-metricexport-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 CMEK API
CockroachDB Databases API
CockroachDB EgressRules API
CockroachDB Folders API
CockroachDB Health API
CockroachDB IPAllowlists API
Where this information came from

This is an independent, third-party profile of CockroachDB MetricExport 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.