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

Cockroach Labs APIKeys API

Manage API keys for programmatic access, including creation, retrieval, listing, updating, and deletion.

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

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

This API exposes 5 operations across 2 paths, and defines 7 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.

5 operations 2 paths 7 schemas 1 DELETE2 GET1 PATCH1 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

Cockroach Labs APIKeys 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 5

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

APIKeys 5

Manage API keys for programmatic access, including creation, retrieval, listing, updating, and deletion.

GET
/api/v1/api-keys
List API keys
ListApiKeys 5 params → 200401
POST
/api/v1/api-keys
Create an API key
CreateApiKey body → 200400401
GET
/api/v1/api-keys/{id}
Get an API key
GetApiKey 1 param → 200401404
PATCH
/api/v1/api-keys/{id}
Update an API key
UpdateApiKey 1 param body → 200400401404
DELETE
/api/v1/api-keys/{id}
Delete an API key
DeleteApiKey 1 param → 200401404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ApiKey (4 properties), PaginationResponse (3 properties), Error (3 properties), CreateApiKeyResponse (2 properties). Each schema is shown below with its type and property counts.

CreateApiKeyRequest
object
Request body for creating a new API key.
2 properties 2 required
Error
object
Standard error response returned by the API.
3 properties
ListApiKeysResponse
object
Paginated list of API keys.
2 properties
UpdateApiKeySpecification
object
Specification for updating an API key's metadata.
1 property
ApiKey
object
Represents an API key used for authenticating requests to the CockroachDB Cloud API.
4 properties
PaginationResponse
object
Pagination metadata included in list responses.
3 properties
CreateApiKeyResponse
object
Response from creating an API key. Contains the key secret which is only returned once and cannot be retrieved again.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cockroach-labs-apikeys-api-openapi.yml Raw ↑

Other APIs Cockroach Labs publishes across the network.

Cockroach Labs AuditLogs API
Cockroach Labs Auth API
Cockroach Labs BackupRestore API
Cockroach Labs Billing API
Cockroach Labs Clusters API
Cockroach Labs CMEK API
Cockroach Labs Databases API
Cockroach Labs EgressRules API
Cockroach Labs Folders API
Cockroach Labs Health API
Cockroach Labs IPAllowlists API
Cockroach Labs JWTIssuers API
Where this information came from

This is an independent, third-party profile of Cockroach Labs APIKeys 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.