Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

YugabyteDB Custom CA Certificates API

The Custom CA Certificates API from YugabyteDB — 4 operation(s) for custom ca certificates.

YugabyteDB Custom CA Certificates API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Custom CA Certificates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 5 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://cloud.yugabyte.com/api/public/v1.

5 operations 4 paths 6 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

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

  • bearerAuth — API key obtained from the YugabyteDB Aeon UI under User Profile API Keys. Pass the key as a Bearer token in the Authorization header.

Paths & Operations 5

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

Custom CA Certificates 5
POST
/api/v1/customers/{cUUID}/customCAStore
YugabyteDB Anywhere Add a Named Custom CA Certificate
addCA 2 params body → 200
POST
/api/v1/customers/{cUUID}/customCAStore/{certUUID}
YugabyteDB Anywhere Update a Named Custom CA Certificate
updateCA 3 params body → 200
GET
/api/v1/customers/{cUUID}/customCAStoreCertificates
YugabyteDB Anywhere List All Custom CA Certificates of a Customer
listAllCustomCaCertificates 1 param → 200
DELETE
/api/v1/customers/{cUUID}/customCAStoreCertificates/{certUUID}
YugabyteDB Anywhere Delete a Named Custom CA Certificate
Delete custom CA certificate 3 params → 200
GET
/api/v1/customers/{cUUID}/customCAStoreCertificates/{certUUID}
YugabyteDB Anywhere Download a Custom CA Certificates of a Customer
getAllCustomCaCertificates 3 params → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are CustomCaCertificateInfo_2 (8 properties), CustomCaCertificateInfo (8 properties), YBPSuccess_2 (2 properties), CustomCACertParams_2 (2 properties). Each schema is shown below with its type and property counts.

CustomCACertParams
object
2 properties 2 required
CustomCaCertificateInfo
object
Custom CA certificate
8 properties 4 required
YBPSuccess
object
2 properties
CustomCACertParams_2
object
2 properties 2 required
CustomCaCertificateInfo_2
object
Custom CA certificate
8 properties 4 required
YBPSuccess_2
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-custom-ca-certificates-api-openapi.yml Raw ↑

Other APIs YugabyteDB publishes across the network.

YugabyteDB Access Keys API
YugabyteDB Accounts API
YugabyteDB Alerts API
YugabyteDB AllowLists API
YugabyteDB Asynchronous Replication API
YugabyteDB Audit API
YugabyteDB Authentication API
YugabyteDB Availability Zones API
YugabyteDB Backup and Restore API
YugabyteDB Backups API
YugabyteDB Certificate Info API
YugabyteDB Cloud providers API